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

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.143! raeburn     4: # $Id: loncommon.pm,v 1.1075.2.142 2020/02/04 21:54:58 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.112     bowersj2 4426: =pod
                   4427: 
1.648     raeburn  4428: =item * &get_student_answers() 
1.112     bowersj2 4429: 
                   4430: show a snapshot of how student was answering problem
                   4431: 
                   4432: =cut
                   4433: 
1.11      albertel 4434: sub get_student_answers {
1.100     sakharuk 4435:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      4436:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4437:   my (%moreenv);
1.11      albertel 4438:   my @elements=('symb','courseid','domain','username');
                   4439:   foreach my $element (@elements) {
1.186     albertel 4440:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4441:   }
1.186     albertel 4442:   $moreenv{'grade_target'}='answer';
                   4443:   %moreenv=(%form,%moreenv);
1.497     raeburn  4444:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   4445:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 4446:   return $userview;
1.1       albertel 4447: }
1.116     albertel 4448: 
                   4449: =pod
                   4450: 
                   4451: =item * &submlink()
                   4452: 
1.242     albertel 4453: Inputs: $text $uname $udom $symb $target
1.116     albertel 4454: 
                   4455: Returns: A link to grades.pm such as to see the SUBM view of a student
                   4456: 
                   4457: =cut
                   4458: 
                   4459: ###############################################
                   4460: sub submlink {
1.242     albertel 4461:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 4462:     if (!($uname && $udom)) {
                   4463: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4464: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 4465: 	if (!$symb) { $symb=$cursymb; }
                   4466:     }
1.254     matthew  4467:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4468:     $symb=&escape($symb);
1.960     bisitz   4469:     if ($target) { $target=" target=\"$target\""; }
                   4470:     return
                   4471:         '<a href="/adm/grades?command=submission'.
                   4472:         '&amp;symb='.$symb.
                   4473:         '&amp;student='.$uname.
                   4474:         '&amp;userdom='.$udom.'"'.
                   4475:         $target.'>'.$text.'</a>';
1.242     albertel 4476: }
                   4477: ##############################################
                   4478: 
                   4479: =pod
                   4480: 
                   4481: =item * &pgrdlink()
                   4482: 
                   4483: Inputs: $text $uname $udom $symb $target
                   4484: 
                   4485: Returns: A link to grades.pm such as to see the PGRD view of a student
                   4486: 
                   4487: =cut
                   4488: 
                   4489: ###############################################
                   4490: sub pgrdlink {
                   4491:     my $link=&submlink(@_);
                   4492:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   4493:     return $link;
                   4494: }
                   4495: ##############################################
                   4496: 
                   4497: =pod
                   4498: 
                   4499: =item * &pprmlink()
                   4500: 
                   4501: Inputs: $text $uname $udom $symb $target
                   4502: 
                   4503: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 4504: student and a specific resource
1.242     albertel 4505: 
                   4506: =cut
                   4507: 
                   4508: ###############################################
                   4509: sub pprmlink {
                   4510:     my ($text,$uname,$udom,$symb,$target)=@_;
                   4511:     if (!($uname && $udom)) {
                   4512: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4513: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 4514: 	if (!$symb) { $symb=$cursymb; }
                   4515:     }
1.254     matthew  4516:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4517:     $symb=&escape($symb);
1.242     albertel 4518:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 4519:     return '<a href="/adm/parmset?command=set&amp;'.
                   4520: 	'symb='.$symb.'&amp;uname='.$uname.
                   4521: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 4522: }
                   4523: ##############################################
1.37      matthew  4524: 
1.112     bowersj2 4525: =pod
                   4526: 
                   4527: =back
                   4528: 
                   4529: =cut
                   4530: 
1.37      matthew  4531: ###############################################
1.51      www      4532: 
                   4533: 
                   4534: sub timehash {
1.687     raeburn  4535:     my ($thistime) = @_;
                   4536:     my $timezone = &Apache::lonlocal::gettimezone();
                   4537:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   4538:                      ->set_time_zone($timezone);
                   4539:     my $wday = $dt->day_of_week();
                   4540:     if ($wday == 7) { $wday = 0; }
                   4541:     return ( 'second' => $dt->second(),
                   4542:              'minute' => $dt->minute(),
                   4543:              'hour'   => $dt->hour(),
                   4544:              'day'     => $dt->day_of_month(),
                   4545:              'month'   => $dt->month(),
                   4546:              'year'    => $dt->year(),
                   4547:              'weekday' => $wday,
                   4548:              'dayyear' => $dt->day_of_year(),
                   4549:              'dlsav'   => $dt->is_dst() );
1.51      www      4550: }
                   4551: 
1.370     www      4552: sub utc_string {
                   4553:     my ($date)=@_;
1.371     www      4554:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      4555: }
                   4556: 
1.51      www      4557: sub maketime {
                   4558:     my %th=@_;
1.687     raeburn  4559:     my ($epoch_time,$timezone,$dt);
                   4560:     $timezone = &Apache::lonlocal::gettimezone();
                   4561:     eval {
                   4562:         $dt = DateTime->new( year   => $th{'year'},
                   4563:                              month  => $th{'month'},
                   4564:                              day    => $th{'day'},
                   4565:                              hour   => $th{'hour'},
                   4566:                              minute => $th{'minute'},
                   4567:                              second => $th{'second'},
                   4568:                              time_zone => $timezone,
                   4569:                          );
                   4570:     };
                   4571:     if (!$@) {
                   4572:         $epoch_time = $dt->epoch;
                   4573:         if ($epoch_time) {
                   4574:             return $epoch_time;
                   4575:         }
                   4576:     }
1.51      www      4577:     return POSIX::mktime(
                   4578:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      4579:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      4580: }
                   4581: 
                   4582: #########################################
1.51      www      4583: 
                   4584: sub findallcourses {
1.482     raeburn  4585:     my ($roles,$uname,$udom) = @_;
1.355     albertel 4586:     my %roles;
                   4587:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 4588:     my %courses;
1.51      www      4589:     my $now=time;
1.482     raeburn  4590:     if (!defined($uname)) {
                   4591:         $uname = $env{'user.name'};
                   4592:     }
                   4593:     if (!defined($udom)) {
                   4594:         $udom = $env{'user.domain'};
                   4595:     }
                   4596:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  4597:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  4598:         if (!%roles) {
                   4599:             %roles = (
                   4600:                        cc => 1,
1.907     raeburn  4601:                        co => 1,
1.482     raeburn  4602:                        in => 1,
                   4603:                        ep => 1,
                   4604:                        ta => 1,
                   4605:                        cr => 1,
                   4606:                        st => 1,
                   4607:              );
                   4608:         }
                   4609:         foreach my $entry (keys(%roleshash)) {
                   4610:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4611:             if ($trole =~ /^cr/) { 
                   4612:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4613:             } else {
                   4614:                 next if (!exists($roles{$trole}));
                   4615:             }
                   4616:             if ($tend) {
                   4617:                 next if ($tend < $now);
                   4618:             }
                   4619:             if ($tstart) {
                   4620:                 next if ($tstart > $now);
                   4621:             }
1.1058    raeburn  4622:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4623:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4624:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4625:             if ($secpart eq '') {
                   4626:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4627:                 $sec = 'none';
1.1058    raeburn  4628:                 $value .= $cnum.'/';
1.482     raeburn  4629:             } else {
                   4630:                 $cnum = $cnumpart;
                   4631:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4632:                 $value .= $cnum.'/'.$sec;
                   4633:             }
                   4634:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4635:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4636:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4637:                 }
                   4638:             } else {
                   4639:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4640:             }
1.482     raeburn  4641:         }
                   4642:     } else {
                   4643:         foreach my $key (keys(%env)) {
1.483     albertel 4644: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4645:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4646: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4647: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4648: 	        next if (%roles && !exists($roles{$role}));
                   4649: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4650:                 my $active=1;
                   4651:                 if ($starttime) {
                   4652: 		    if ($now<$starttime) { $active=0; }
                   4653:                 }
                   4654:                 if ($endtime) {
                   4655:                     if ($now>$endtime) { $active=0; }
                   4656:                 }
                   4657:                 if ($active) {
1.1058    raeburn  4658:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4659:                     if ($sec eq '') {
                   4660:                         $sec = 'none';
1.1058    raeburn  4661:                     } else {
                   4662:                         $value .= $sec;
                   4663:                     }
                   4664:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4665:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4666:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4667:                         }
                   4668:                     } else {
                   4669:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4670:                     }
1.474     raeburn  4671:                 }
                   4672:             }
1.51      www      4673:         }
                   4674:     }
1.474     raeburn  4675:     return %courses;
1.51      www      4676: }
1.37      matthew  4677: 
1.54      www      4678: ###############################################
1.474     raeburn  4679: 
                   4680: sub blockcheck {
1.1075.2.73  raeburn  4681:     my ($setters,$activity,$uname,$udom,$url,$is_course) = @_;
1.490     raeburn  4682: 
1.1075.2.73  raeburn  4683:     if (defined($udom) && defined($uname)) {
                   4684:         # If uname and udom are for a course, check for blocks in the course.
                   4685:         if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
                   4686:             my ($startblock,$endblock,$triggerblock) =
                   4687:                 &get_blocks($setters,$activity,$udom,$uname,$url);
                   4688:             return ($startblock,$endblock,$triggerblock);
                   4689:         }
                   4690:     } else {
1.490     raeburn  4691:         $udom = $env{'user.domain'};
                   4692:         $uname = $env{'user.name'};
                   4693:     }
                   4694: 
1.502     raeburn  4695:     my $startblock = 0;
                   4696:     my $endblock = 0;
1.1062    raeburn  4697:     my $triggerblock = '';
1.482     raeburn  4698:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  4699: 
1.490     raeburn  4700:     # If uname is for a user, and activity is course-specific, i.e.,
                   4701:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4702: 
1.490     raeburn  4703:     if (($activity eq 'boards' || $activity eq 'chat' ||
1.1075.2.73  raeburn  4704:          $activity eq 'groups' || $activity eq 'printout') &&
                   4705:         ($env{'request.course.id'})) {
1.490     raeburn  4706:         foreach my $key (keys(%live_courses)) {
                   4707:             if ($key ne $env{'request.course.id'}) {
                   4708:                 delete($live_courses{$key});
                   4709:             }
                   4710:         }
                   4711:     }
                   4712: 
                   4713:     my $otheruser = 0;
                   4714:     my %own_courses;
                   4715:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4716:         # Resource belongs to user other than current user.
                   4717:         $otheruser = 1;
                   4718:         # Gather courses for current user
                   4719:         %own_courses = 
                   4720:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4721:     }
                   4722: 
                   4723:     # Gather active course roles - course coordinator, instructor, 
                   4724:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4725: 
                   4726:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4727:         my ($cdom,$cnum);
                   4728:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4729:             $cdom = $env{'course.'.$course.'.domain'};
                   4730:             $cnum = $env{'course.'.$course.'.num'};
                   4731:         } else {
1.490     raeburn  4732:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4733:         }
                   4734:         my $no_ownblock = 0;
                   4735:         my $no_userblock = 0;
1.533     raeburn  4736:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4737:             # Check if current user has 'evb' priv for this
                   4738:             if (defined($own_courses{$course})) {
                   4739:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4740:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4741:                     if ($sec ne 'none') {
                   4742:                         $checkrole .= '/'.$sec;
                   4743:                     }
                   4744:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4745:                         $no_ownblock = 1;
                   4746:                         last;
                   4747:                     }
                   4748:                 }
                   4749:             }
                   4750:             # if they have 'evb' priv and are currently not playing student
                   4751:             next if (($no_ownblock) &&
                   4752:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4753:         }
1.474     raeburn  4754:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4755:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4756:             if ($sec ne 'none') {
1.482     raeburn  4757:                 $checkrole .= '/'.$sec;
1.474     raeburn  4758:             }
1.490     raeburn  4759:             if ($otheruser) {
                   4760:                 # Resource belongs to user other than current user.
                   4761:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  4762:                 my (%allroles,%userroles);
                   4763:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   4764:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   4765:                         my ($trole,$tdom,$tnum,$tsec);
                   4766:                         if ($entry =~ /^cr/) {
                   4767:                             ($trole,$tdom,$tnum,$tsec) = 
                   4768:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4769:                         } else {
                   4770:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4771:                         }
                   4772:                         my ($spec,$area,$trest);
                   4773:                         $area = '/'.$tdom.'/'.$tnum;
                   4774:                         $trest = $tnum;
                   4775:                         if ($tsec ne '') {
                   4776:                             $area .= '/'.$tsec;
                   4777:                             $trest .= '/'.$tsec;
                   4778:                         }
                   4779:                         $spec = $trole.'.'.$area;
                   4780:                         if ($trole =~ /^cr/) {
                   4781:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4782:                                                               $tdom,$spec,$trest,$area);
                   4783:                         } else {
                   4784:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4785:                                                                 $tdom,$spec,$trest,$area);
                   4786:                         }
                   4787:                     }
1.1075.2.124  raeburn  4788:                     my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058    raeburn  4789:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4790:                         if ($1) {
                   4791:                             $no_userblock = 1;
                   4792:                             last;
                   4793:                         }
1.486     raeburn  4794:                     }
                   4795:                 }
1.490     raeburn  4796:             } else {
                   4797:                 # Resource belongs to current user
                   4798:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4799:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4800:                     $no_ownblock = 1;
                   4801:                     last;
                   4802:                 }
1.474     raeburn  4803:             }
                   4804:         }
                   4805:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4806:         next if (($no_ownblock) &&
1.491     albertel 4807:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4808:         next if ($no_userblock);
1.474     raeburn  4809: 
1.1075.2.128  raeburn  4810:         # Retrieve blocking times and identity of blocker for course
1.490     raeburn  4811:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4812:         
1.1062    raeburn  4813:         my ($start,$end,$trigger) = 
                   4814:             &get_blocks($setters,$activity,$cdom,$cnum,$url);
1.502     raeburn  4815:         if (($start != 0) && 
                   4816:             (($startblock == 0) || ($startblock > $start))) {
                   4817:             $startblock = $start;
1.1062    raeburn  4818:             if ($trigger ne '') {
                   4819:                 $triggerblock = $trigger;
                   4820:             }
1.502     raeburn  4821:         }
                   4822:         if (($end != 0)  &&
                   4823:             (($endblock == 0) || ($endblock < $end))) {
                   4824:             $endblock = $end;
1.1062    raeburn  4825:             if ($trigger ne '') {
                   4826:                 $triggerblock = $trigger;
                   4827:             }
1.502     raeburn  4828:         }
1.490     raeburn  4829:     }
1.1062    raeburn  4830:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4831: }
                   4832: 
                   4833: sub get_blocks {
1.1062    raeburn  4834:     my ($setters,$activity,$cdom,$cnum,$url) = @_;
1.490     raeburn  4835:     my $startblock = 0;
                   4836:     my $endblock = 0;
1.1062    raeburn  4837:     my $triggerblock = '';
1.490     raeburn  4838:     my $course = $cdom.'_'.$cnum;
                   4839:     $setters->{$course} = {};
                   4840:     $setters->{$course}{'staff'} = [];
                   4841:     $setters->{$course}{'times'} = [];
1.1062    raeburn  4842:     $setters->{$course}{'triggers'} = [];
                   4843:     my (@blockers,%triggered);
                   4844:     my $now = time;
                   4845:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   4846:     if ($activity eq 'docs') {
                   4847:         @blockers = &Apache::lonnet::has_comm_blocking('bre',undef,$url,\%commblocks);
                   4848:         foreach my $block (@blockers) {
                   4849:             if ($block =~ /^firstaccess____(.+)$/) {
                   4850:                 my $item = $1;
                   4851:                 my $type = 'map';
                   4852:                 my $timersymb = $item;
                   4853:                 if ($item eq 'course') {
                   4854:                     $type = 'course';
                   4855:                 } elsif ($item =~ /___\d+___/) {
                   4856:                     $type = 'resource';
                   4857:                 } else {
                   4858:                     $timersymb = &Apache::lonnet::symbread($item);
                   4859:                 }
                   4860:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4861:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   4862:                 $triggered{$block} = {
                   4863:                                        start => $start,
                   4864:                                        end   => $end,
                   4865:                                        type  => $type,
                   4866:                                      };
                   4867:             }
                   4868:         }
                   4869:     } else {
                   4870:         foreach my $block (keys(%commblocks)) {
                   4871:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   4872:                 my ($start,$end) = ($1,$2);
                   4873:                 if ($start <= time && $end >= time) {
                   4874:                     if (ref($commblocks{$block}) eq 'HASH') {
                   4875:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   4876:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   4877:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   4878:                                     push(@blockers,$block);
                   4879:                                 }
                   4880:                             }
                   4881:                         }
                   4882:                     }
                   4883:                 }
                   4884:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   4885:                 my $item = $1;
                   4886:                 my $timersymb = $item; 
                   4887:                 my $type = 'map';
                   4888:                 if ($item eq 'course') {
                   4889:                     $type = 'course';
                   4890:                 } elsif ($item =~ /___\d+___/) {
                   4891:                     $type = 'resource';
                   4892:                 } else {
                   4893:                     $timersymb = &Apache::lonnet::symbread($item);
                   4894:                 }
                   4895:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   4896:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   4897:                 if ($start && $end) {
                   4898:                     if (($start <= time) && ($end >= time)) {
                   4899:                         unless (grep(/^\Q$block\E$/,@blockers)) {
                   4900:                             push(@blockers,$block);
                   4901:                             $triggered{$block} = {
                   4902:                                                    start => $start,
                   4903:                                                    end   => $end,
                   4904:                                                    type  => $type,
                   4905:                                                  };
                   4906:                         }
                   4907:                     }
1.490     raeburn  4908:                 }
1.1062    raeburn  4909:             }
                   4910:         }
                   4911:     }
                   4912:     foreach my $blocker (@blockers) {
                   4913:         my ($staff_name,$staff_dom,$title,$blocks) =
                   4914:             &parse_block_record($commblocks{$blocker});
                   4915:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   4916:         my ($start,$end,$triggertype);
                   4917:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   4918:             ($start,$end) = ($1,$2);
                   4919:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   4920:             $start = $triggered{$blocker}{'start'};
                   4921:             $end = $triggered{$blocker}{'end'};
                   4922:             $triggertype = $triggered{$blocker}{'type'};
                   4923:         }
                   4924:         if ($start) {
                   4925:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   4926:             if ($triggertype) {
                   4927:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   4928:             } else {
                   4929:                 push(@{$$setters{$course}{'triggers'}},0);
                   4930:             }
                   4931:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   4932:                 $startblock = $start;
                   4933:                 if ($triggertype) {
                   4934:                     $triggerblock = $blocker;
1.474     raeburn  4935:                 }
                   4936:             }
1.1062    raeburn  4937:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   4938:                $endblock = $end;
                   4939:                if ($triggertype) {
                   4940:                    $triggerblock = $blocker;
                   4941:                }
                   4942:             }
1.474     raeburn  4943:         }
                   4944:     }
1.1062    raeburn  4945:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  4946: }
                   4947: 
                   4948: sub parse_block_record {
                   4949:     my ($record) = @_;
                   4950:     my ($setuname,$setudom,$title,$blocks);
                   4951:     if (ref($record) eq 'HASH') {
                   4952:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   4953:         $title = &unescape($record->{'event'});
                   4954:         $blocks = $record->{'blocks'};
                   4955:     } else {
                   4956:         my @data = split(/:/,$record,3);
                   4957:         if (scalar(@data) eq 2) {
                   4958:             $title = $data[1];
                   4959:             ($setuname,$setudom) = split(/@/,$data[0]);
                   4960:         } else {
                   4961:             ($setuname,$setudom,$title) = @data;
                   4962:         }
                   4963:         $blocks = { 'com' => 'on' };
                   4964:     }
                   4965:     return ($setuname,$setudom,$title,$blocks);
                   4966: }
                   4967: 
1.854     kalberla 4968: sub blocking_status {
1.1075.2.73  raeburn  4969:     my ($activity,$uname,$udom,$url,$is_course) = @_;
1.1061    raeburn  4970:     my %setters;
1.890     droeschl 4971: 
1.1061    raeburn  4972: # check for active blocking
1.1062    raeburn  4973:     my ($startblock,$endblock,$triggerblock) = 
1.1075.2.73  raeburn  4974:         &blockcheck(\%setters,$activity,$uname,$udom,$url,$is_course);
1.1062    raeburn  4975:     my $blocked = 0;
                   4976:     if ($startblock && $endblock) {
                   4977:         $blocked = 1;
                   4978:     }
1.890     droeschl 4979: 
1.1061    raeburn  4980: # caller just wants to know whether a block is active
                   4981:     if (!wantarray) { return $blocked; }
                   4982: 
                   4983: # build a link to a popup window containing the details
                   4984:     my $querystring  = "?activity=$activity";
                   4985: # $uname and $udom decide whose portfolio the user is trying to look at
1.1075.2.97  raeburn  4986:     if (($activity eq 'port') || ($activity eq 'passwd')) {
                   4987:         $querystring .= "&amp;udom=$udom"      if ($udom =~ /^$match_domain$/);
                   4988:         $querystring .= "&amp;uname=$uname"    if ($uname =~ /^$match_username$/);
1.1062    raeburn  4989:     } elsif ($activity eq 'docs') {
                   4990:         $querystring .= '&amp;url='.&HTML::Entities::encode($url,'&"');
                   4991:     }
1.1061    raeburn  4992: 
                   4993:     my $output .= <<'END_MYBLOCK';
                   4994: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4995:     var options = "width=" + w + ",height=" + h + ",";
                   4996:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4997:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4998:     var newWin = window.open(url, wdwName, options);
                   4999:     newWin.focus();
                   5000: }
1.890     droeschl 5001: END_MYBLOCK
1.854     kalberla 5002: 
1.1061    raeburn  5003:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 5004:   
1.1061    raeburn  5005:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  5006:     my $text = &mt('Communication Blocked');
1.1075.2.93  raeburn  5007:     my $class = 'LC_comblock';
1.1062    raeburn  5008:     if ($activity eq 'docs') {
                   5009:         $text = &mt('Content Access Blocked');
1.1075.2.93  raeburn  5010:         $class = '';
1.1063    raeburn  5011:     } elsif ($activity eq 'printout') {
                   5012:         $text = &mt('Printing Blocked');
1.1075.2.97  raeburn  5013:     } elsif ($activity eq 'passwd') {
                   5014:         $text = &mt('Password Changing Blocked');
1.1062    raeburn  5015:     }
1.1061    raeburn  5016:     $output .= <<"END_BLOCK";
1.1075.2.93  raeburn  5017: <div class='$class'>
1.869     kalberla 5018:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 5019:   title='$text'>
                   5020:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 5021:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 5022:   title='$text'>$text</a>
1.867     kalberla 5023: </div>
                   5024: 
                   5025: END_BLOCK
1.474     raeburn  5026: 
1.1061    raeburn  5027:     return ($blocked, $output);
1.854     kalberla 5028: }
1.490     raeburn  5029: 
1.60      matthew  5030: ###############################################
                   5031: 
1.682     raeburn  5032: sub check_ip_acc {
1.1075.2.105  raeburn  5033:     my ($acc,$clientip)=@_;
1.682     raeburn  5034:     &Apache::lonxml::debug("acc is $acc");
                   5035:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   5036:         return 1;
                   5037:     }
                   5038:     my $allowed=0;
1.1075.2.111  raeburn  5039:     my $ip=$ENV{'REMOTE_ADDR'} || $clientip || $env{'request.host'};
1.682     raeburn  5040: 
                   5041:     my $name;
                   5042:     foreach my $pattern (split(',',$acc)) {
                   5043:         $pattern =~ s/^\s*//;
                   5044:         $pattern =~ s/\s*$//;
                   5045:         if ($pattern =~ /\*$/) {
                   5046:             #35.8.*
                   5047:             $pattern=~s/\*//;
                   5048:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   5049:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   5050:             #35.8.3.[34-56]
                   5051:             my $low=$2;
                   5052:             my $high=$3;
                   5053:             $pattern=$1;
                   5054:             if ($ip =~ /^\Q$pattern\E/) {
                   5055:                 my $last=(split(/\./,$ip))[3];
                   5056:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   5057:             }
                   5058:         } elsif ($pattern =~ /^\*/) {
                   5059:             #*.msu.edu
                   5060:             $pattern=~s/\*//;
                   5061:             if (!defined($name)) {
                   5062:                 use Socket;
                   5063:                 my $netaddr=inet_aton($ip);
                   5064:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5065:             }
                   5066:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   5067:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   5068:             #127.0.0.1
                   5069:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   5070:         } else {
                   5071:             #some.name.com
                   5072:             if (!defined($name)) {
                   5073:                 use Socket;
                   5074:                 my $netaddr=inet_aton($ip);
                   5075:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5076:             }
                   5077:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   5078:         }
                   5079:         if ($allowed) { last; }
                   5080:     }
                   5081:     return $allowed;
                   5082: }
                   5083: 
                   5084: ###############################################
                   5085: 
1.60      matthew  5086: =pod
                   5087: 
1.112     bowersj2 5088: =head1 Domain Template Functions
                   5089: 
                   5090: =over 4
                   5091: 
                   5092: =item * &determinedomain()
1.60      matthew  5093: 
                   5094: Inputs: $domain (usually will be undef)
                   5095: 
1.63      www      5096: Returns: Determines which domain should be used for designs
1.60      matthew  5097: 
                   5098: =cut
1.54      www      5099: 
1.60      matthew  5100: ###############################################
1.63      www      5101: sub determinedomain {
                   5102:     my $domain=shift;
1.531     albertel 5103:     if (! $domain) {
1.60      matthew  5104:         # Determine domain if we have not been given one
1.893     raeburn  5105:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 5106:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   5107:         if ($env{'request.role.domain'}) { 
                   5108:             $domain=$env{'request.role.domain'}; 
1.60      matthew  5109:         }
                   5110:     }
1.63      www      5111:     return $domain;
                   5112: }
                   5113: ###############################################
1.517     raeburn  5114: 
1.518     albertel 5115: sub devalidate_domconfig_cache {
                   5116:     my ($udom)=@_;
                   5117:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   5118: }
                   5119: 
                   5120: # ---------------------- Get domain configuration for a domain
                   5121: sub get_domainconf {
                   5122:     my ($udom) = @_;
                   5123:     my $cachetime=1800;
                   5124:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   5125:     if (defined($cached)) { return %{$result}; }
                   5126: 
                   5127:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  5128: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  5129:     my (%designhash,%legacy);
1.518     albertel 5130:     if (keys(%domconfig) > 0) {
                   5131:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  5132:             if (keys(%{$domconfig{'login'}})) {
                   5133:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  5134:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1075.2.87  raeburn  5135:                         if (($key eq 'loginvia') || ($key eq 'headtag')) {
                   5136:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   5137:                                 foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
                   5138:                                     if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
                   5139:                                         if ($key eq 'loginvia') {
                   5140:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   5141:                                                 my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   5142:                                                 $designhash{$udom.'.login.loginvia'} = $server;
                   5143:                                                 if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   5144:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   5145:                                                 } else {
                   5146:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   5147:                                                 }
1.948     raeburn  5148:                                             }
1.1075.2.87  raeburn  5149:                                         } elsif ($key eq 'headtag') {
                   5150:                                             if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
                   5151:                                                 $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948     raeburn  5152:                                             }
1.946     raeburn  5153:                                         }
1.1075.2.87  raeburn  5154:                                         if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
                   5155:                                             $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
                   5156:                                         }
1.946     raeburn  5157:                                     }
                   5158:                                 }
                   5159:                             }
                   5160:                         } else {
                   5161:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   5162:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   5163:                                     $domconfig{'login'}{$key}{$img};
                   5164:                             }
1.699     raeburn  5165:                         }
                   5166:                     } else {
                   5167:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   5168:                     }
1.632     raeburn  5169:                 }
                   5170:             } else {
                   5171:                 $legacy{'login'} = 1;
1.518     albertel 5172:             }
1.632     raeburn  5173:         } else {
                   5174:             $legacy{'login'} = 1;
1.518     albertel 5175:         }
                   5176:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  5177:             if (keys(%{$domconfig{'rolecolors'}})) {
                   5178:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   5179:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   5180:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   5181:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   5182:                         }
1.518     albertel 5183:                     }
                   5184:                 }
1.632     raeburn  5185:             } else {
                   5186:                 $legacy{'rolecolors'} = 1;
1.518     albertel 5187:             }
1.632     raeburn  5188:         } else {
                   5189:             $legacy{'rolecolors'} = 1;
1.518     albertel 5190:         }
1.948     raeburn  5191:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   5192:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   5193:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   5194:             }
                   5195:         }
1.632     raeburn  5196:         if (keys(%legacy) > 0) {
                   5197:             my %legacyhash = &get_legacy_domconf($udom);
                   5198:             foreach my $item (keys(%legacyhash)) {
                   5199:                 if ($item =~ /^\Q$udom\E\.login/) {
                   5200:                     if ($legacy{'login'}) { 
                   5201:                         $designhash{$item} = $legacyhash{$item};
                   5202:                     }
                   5203:                 } else {
                   5204:                     if ($legacy{'rolecolors'}) {
                   5205:                         $designhash{$item} = $legacyhash{$item};
                   5206:                     }
1.518     albertel 5207:                 }
                   5208:             }
                   5209:         }
1.632     raeburn  5210:     } else {
                   5211:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 5212:     }
                   5213:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   5214: 				  $cachetime);
                   5215:     return %designhash;
                   5216: }
                   5217: 
1.632     raeburn  5218: sub get_legacy_domconf {
                   5219:     my ($udom) = @_;
                   5220:     my %legacyhash;
                   5221:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   5222:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   5223:     if (-e $designfile) {
1.1075.2.128  raeburn  5224:         if ( open (my $fh,'<',$designfile) ) {
1.632     raeburn  5225:             while (my $line = <$fh>) {
                   5226:                 next if ($line =~ /^\#/);
                   5227:                 chomp($line);
                   5228:                 my ($key,$val)=(split(/\=/,$line));
                   5229:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   5230:             }
                   5231:             close($fh);
                   5232:         }
                   5233:     }
1.1026    raeburn  5234:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  5235:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   5236:     }
                   5237:     return %legacyhash;
                   5238: }
                   5239: 
1.63      www      5240: =pod
                   5241: 
1.112     bowersj2 5242: =item * &domainlogo()
1.63      www      5243: 
                   5244: Inputs: $domain (usually will be undef)
                   5245: 
                   5246: Returns: A link to a domain logo, if the domain logo exists.
                   5247: If the domain logo does not exist, a description of the domain.
                   5248: 
                   5249: =cut
1.112     bowersj2 5250: 
1.63      www      5251: ###############################################
                   5252: sub domainlogo {
1.517     raeburn  5253:     my $domain = &determinedomain(shift);
1.518     albertel 5254:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  5255:     # See if there is a logo
                   5256:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  5257:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 5258:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   5259: 	    if ($imgsrc =~ m{^/res/}) {
                   5260: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   5261: 		&Apache::lonnet::repcopy($local_name);
                   5262: 	    }
                   5263: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  5264:         } 
                   5265:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 5266:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   5267:         return &Apache::lonnet::domain($domain,'description');
1.59      www      5268:     } else {
1.60      matthew  5269:         return '';
1.59      www      5270:     }
                   5271: }
1.63      www      5272: ##############################################
                   5273: 
                   5274: =pod
                   5275: 
1.112     bowersj2 5276: =item * &designparm()
1.63      www      5277: 
                   5278: Inputs: $which parameter; $domain (usually will be undef)
                   5279: 
                   5280: Returns: value of designparamter $which
                   5281: 
                   5282: =cut
1.112     bowersj2 5283: 
1.397     albertel 5284: 
1.400     albertel 5285: ##############################################
1.397     albertel 5286: sub designparm {
                   5287:     my ($which,$domain)=@_;
                   5288:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   5289:         return $env{'environment.color.'.$which};
1.96      www      5290:     }
1.63      www      5291:     $domain=&determinedomain($domain);
1.1016    raeburn  5292:     my %domdesign;
                   5293:     unless ($domain eq 'public') {
                   5294:         %domdesign = &get_domainconf($domain);
                   5295:     }
1.520     raeburn  5296:     my $output;
1.517     raeburn  5297:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   5298:         $output = $domdesign{$domain.'.'.$which};
1.63      www      5299:     } else {
1.520     raeburn  5300:         $output = $defaultdesign{$which};
                   5301:     }
                   5302:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  5303:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 5304:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   5305:             if ($output =~ m{^/res/}) {
                   5306:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   5307:                 &Apache::lonnet::repcopy($local_name);
                   5308:             }
1.520     raeburn  5309:             $output = &lonhttpdurl($output);
                   5310:         }
1.63      www      5311:     }
1.520     raeburn  5312:     return $output;
1.63      www      5313: }
1.59      www      5314: 
1.822     bisitz   5315: ##############################################
                   5316: =pod
                   5317: 
1.832     bisitz   5318: =item * &authorspace()
                   5319: 
1.1028    raeburn  5320: Inputs: $url (usually will be undef).
1.832     bisitz   5321: 
1.1075.2.40  raeburn  5322: Returns: Path to Authoring Space containing the resource or 
1.1028    raeburn  5323:          directory being viewed (or for which action is being taken). 
                   5324:          If $url is provided, and begins /priv/<domain>/<uname>
                   5325:          the path will be that portion of the $context argument.
                   5326:          Otherwise the path will be for the author space of the current
                   5327:          user when the current role is author, or for that of the 
                   5328:          co-author/assistant co-author space when the current role 
                   5329:          is co-author or assistant co-author.
1.832     bisitz   5330: 
                   5331: =cut
                   5332: 
                   5333: sub authorspace {
1.1028    raeburn  5334:     my ($url) = @_;
                   5335:     if ($url ne '') {
                   5336:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   5337:            return $1;
                   5338:         }
                   5339:     }
1.832     bisitz   5340:     my $caname = '';
1.1024    www      5341:     my $cadom = '';
1.1028    raeburn  5342:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      5343:         ($cadom,$caname) =
1.832     bisitz   5344:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  5345:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   5346:         $caname = $env{'user.name'};
1.1024    www      5347:         $cadom = $env{'user.domain'};
1.832     bisitz   5348:     }
1.1028    raeburn  5349:     if (($caname ne '') && ($cadom ne '')) {
                   5350:         return "/priv/$cadom/$caname/";
                   5351:     }
                   5352:     return;
1.832     bisitz   5353: }
                   5354: 
                   5355: ##############################################
                   5356: =pod
                   5357: 
1.822     bisitz   5358: =item * &head_subbox()
                   5359: 
                   5360: Inputs: $content (contains HTML code with page functions, etc.)
                   5361: 
                   5362: Returns: HTML div with $content
                   5363:          To be included in page header
                   5364: 
                   5365: =cut
                   5366: 
                   5367: sub head_subbox {
                   5368:     my ($content)=@_;
                   5369:     my $output =
1.993     raeburn  5370:         '<div class="LC_head_subbox">'
1.822     bisitz   5371:        .$content
                   5372:        .'</div>'
                   5373: }
                   5374: 
                   5375: ##############################################
                   5376: =pod
                   5377: 
                   5378: =item * &CSTR_pageheader()
                   5379: 
1.1026    raeburn  5380: Input: (optional) filename from which breadcrumb trail is built.
                   5381:        In most cases no input as needed, as $env{'request.filename'}
                   5382:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   5383: 
                   5384: Returns: HTML div with CSTR path and recent box
1.1075.2.40  raeburn  5385:          To be included on Authoring Space pages
1.822     bisitz   5386: 
                   5387: =cut
                   5388: 
                   5389: sub CSTR_pageheader {
1.1026    raeburn  5390:     my ($trailfile) = @_;
                   5391:     if ($trailfile eq '') {
                   5392:         $trailfile = $env{'request.filename'};
                   5393:     }
                   5394: 
                   5395: # this is for resources; directories have customtitle, and crumbs
                   5396: # and select recent are created in lonpubdir.pm
                   5397: 
                   5398:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      5399:     my ($udom,$uname,$thisdisfn)=
1.1075.2.29  raeburn  5400:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  5401:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   5402:     $formaction =~ s{/+}{/}g;
1.822     bisitz   5403: 
                   5404:     my $parentpath = '';
                   5405:     my $lastitem = '';
                   5406:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   5407:         $parentpath = $1;
                   5408:         $lastitem = $2;
                   5409:     } else {
                   5410:         $lastitem = $thisdisfn;
                   5411:     }
1.921     bisitz   5412: 
                   5413:     my $output =
1.822     bisitz   5414:          '<div>'
                   5415:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1075.2.40  raeburn  5416:         .'<b>'.&mt('Authoring Space:').'</b> '
1.822     bisitz   5417:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   5418:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      5419:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   5420: 
                   5421:     if ($lastitem) {
                   5422:         $output .=
                   5423:              '<span class="LC_filename">'
                   5424:             .$lastitem
                   5425:             .'</span>';
                   5426:     }
                   5427:     $output .=
                   5428:          '<br />'
1.822     bisitz   5429:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   5430:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   5431:         .'</form>'
                   5432:         .&Apache::lonmenu::constspaceform()
                   5433:         .'</div>';
1.921     bisitz   5434: 
                   5435:     return $output;
1.822     bisitz   5436: }
                   5437: 
1.60      matthew  5438: ###############################################
                   5439: ###############################################
                   5440: 
                   5441: =pod
                   5442: 
1.112     bowersj2 5443: =back
                   5444: 
1.549     albertel 5445: =head1 HTML Helpers
1.112     bowersj2 5446: 
                   5447: =over 4
                   5448: 
                   5449: =item * &bodytag()
1.60      matthew  5450: 
                   5451: Returns a uniform header for LON-CAPA web pages.
                   5452: 
                   5453: Inputs: 
                   5454: 
1.112     bowersj2 5455: =over 4
                   5456: 
                   5457: =item * $title, A title to be displayed on the page.
                   5458: 
                   5459: =item * $function, the current role (can be undef).
                   5460: 
                   5461: =item * $addentries, extra parameters for the <body> tag.
                   5462: 
                   5463: =item * $bodyonly, if defined, only return the <body> tag.
                   5464: 
                   5465: =item * $domain, if defined, force a given domain.
                   5466: 
                   5467: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      5468:             text interface only)
1.60      matthew  5469: 
1.814     bisitz   5470: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   5471:                      navigational links
1.317     albertel 5472: 
1.338     albertel 5473: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   5474: 
1.1075.2.12  raeburn  5475: =item * $no_inline_link, if true and in remote mode, don't show the
                   5476:          'Switch To Inline Menu' link
                   5477: 
1.460     albertel 5478: =item * $args, optional argument valid values are
                   5479:             no_auto_mt_title -> prevents &mt()ing the title arg
1.1075.2.133  raeburn  5480:             use_absolute     -> for external resource or syllabus, this will
                   5481:                                 contain https://<hostname> if server uses
                   5482:                                 https (as per hosts.tab), but request is for http
                   5483:             hostname         -> hostname, from $r->hostname().
1.460     albertel 5484: 
1.1075.2.15  raeburn  5485: =item * $advtoolsref, optional argument, ref to an array containing
                   5486:             inlineremote items to be added in "Functions" menu below
                   5487:             breadcrumbs.
                   5488: 
1.112     bowersj2 5489: =back
                   5490: 
1.60      matthew  5491: Returns: A uniform header for LON-CAPA web pages.  
                   5492: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   5493: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   5494: other decorations will be returned.
                   5495: 
                   5496: =cut
                   5497: 
1.54      www      5498: sub bodytag {
1.831     bisitz   5499:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.15  raeburn  5500:         $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref)=@_;
1.339     albertel 5501: 
1.954     raeburn  5502:     my $public;
                   5503:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   5504:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   5505:         $public = 1;
                   5506:     }
1.460     albertel 5507:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.52  raeburn  5508:     my $httphost = $args->{'use_absolute'};
1.1075.2.133  raeburn  5509:     my $hostname = $args->{'hostname'};
1.339     albertel 5510: 
1.183     matthew  5511:     $function = &get_users_function() if (!$function);
1.339     albertel 5512:     my $img =    &designparm($function.'.img',$domain);
                   5513:     my $font =   &designparm($function.'.font',$domain);
                   5514:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   5515: 
1.803     bisitz   5516:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 5517: 		   'bgcolor' => $pgbg,
1.339     albertel 5518: 		   'text'    => $font,
                   5519:                    'alink'   => &designparm($function.'.alink',$domain),
                   5520: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   5521: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 5522:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 5523: 
1.63      www      5524:  # role and realm
1.1075.2.68  raeburn  5525:     my ($role,$realm) = split(m{\./},$env{'request.role'},2);
                   5526:     if ($realm) {
                   5527:         $realm = '/'.$realm;
                   5528:     }
1.378     raeburn  5529:     if ($role  eq 'ca') {
1.479     albertel 5530:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 5531:         $realm = &plainname($rname,$rdom);
1.378     raeburn  5532:     } 
1.55      www      5533: # realm
1.258     albertel 5534:     if ($env{'request.course.id'}) {
1.378     raeburn  5535:         if ($env{'request.role'} !~ /^cr/) {
                   5536:             $role = &Apache::lonnet::plaintext($role,&course_type());
1.1075.2.115  raeburn  5537:         } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1075.2.121  raeburn  5538:             if ($env{'request.role.desc'}) {
                   5539:                 $role = $env{'request.role.desc'};
                   5540:             } else {
                   5541:                 $role = &mt('Helpdesk[_1]','&nbsp;'.$2);
                   5542:             }
1.1075.2.115  raeburn  5543:         } else {
                   5544:             $role = (split(/\//,$role,4))[-1];
1.378     raeburn  5545:         }
1.898     raeburn  5546:         if ($env{'request.course.sec'}) {
                   5547:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   5548:         }   
1.359     albertel 5549: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  5550:     } else {
                   5551:         $role = &Apache::lonnet::plaintext($role);
1.54      www      5552:     }
1.433     albertel 5553: 
1.359     albertel 5554:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 5555: 
1.438     albertel 5556:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 5557: 
1.101     www      5558: # construct main body tag
1.359     albertel 5559:     my $bodytag = "<body $extra_body_attr>".
1.1075.2.100  raeburn  5560: 	&Apache::lontexconvert::init_math_support();
1.252     albertel 5561: 
1.1075.2.38  raeburn  5562:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   5563: 
                   5564:     if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60      matthew  5565:         return $bodytag;
1.1075.2.38  raeburn  5566:     }
1.359     albertel 5567: 
1.954     raeburn  5568:     if ($public) {
1.433     albertel 5569: 	undef($role);
                   5570:     }
1.359     albertel 5571:     
1.762     bisitz   5572:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 5573:     #
                   5574:     # Extra info if you are the DC
                   5575:     my $dc_info = '';
                   5576:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   5577:                         $env{'course.'.$env{'request.course.id'}.
                   5578:                                  '.domain'}.'/'})) {
                   5579:         my $cid = $env{'request.course.id'};
1.917     raeburn  5580:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      5581:         $dc_info =~ s/\s+$//;
1.359     albertel 5582:     }
                   5583: 
1.1075.2.108  raeburn  5584:     $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.903     droeschl 5585: 
1.1075.2.13  raeburn  5586:     if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   5587: 
1.1075.2.38  raeburn  5588: 
                   5589: 
1.1075.2.21  raeburn  5590:     my $funclist;
                   5591:     if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
1.1075.2.52  raeburn  5592:         $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions($httphost), 'start')."\n".
1.1075.2.21  raeburn  5593:                     Apache::lonmenu::serverform();
                   5594:         my $forbodytag;
                   5595:         &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5596:                                             $forcereg,$args->{'group'},
                   5597:                                             $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5598:                                             $advtoolsref,'','',\$forbodytag);
1.1075.2.21  raeburn  5599:         unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5600:             $funclist = $forbodytag;
                   5601:         }
                   5602:     } else {
1.903     droeschl 5603: 
                   5604:         #    if ($env{'request.state'} eq 'construct') {
                   5605:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   5606:         #    }
                   5607: 
1.1075.2.38  raeburn  5608:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5609:             Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359     albertel 5610: 
1.1075.2.38  raeburn  5611:         my ($left,$right) = Apache::lonmenu::primary_menu();
1.1075.2.2  raeburn  5612: 
1.916     droeschl 5613:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.22  raeburn  5614:             if ($dc_info) {
                   5615:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
1.1075.2.1  raeburn  5616:             }
1.1075.2.38  raeburn  5617:             $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.1075.2.22  raeburn  5618:                            <em>$realm</em> $dc_info</div>|;
1.903     droeschl 5619:             return $bodytag;
                   5620:         }
1.894     droeschl 5621: 
1.927     raeburn  5622:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1075.2.38  raeburn  5623:             $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927     raeburn  5624:         }
1.916     droeschl 5625: 
1.1075.2.38  raeburn  5626:         $bodytag .= $right;
1.852     droeschl 5627: 
1.917     raeburn  5628:         if ($dc_info) {
                   5629:             $dc_info = &dc_courseid_toggle($dc_info);
                   5630:         }
                   5631:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 5632: 
1.1075.2.61  raeburn  5633:         #if directed to not display the secondary menu, don't.
                   5634:         if ($args->{'no_secondary_menu'}) {
                   5635:             return $bodytag;
                   5636:         }
1.903     droeschl 5637:         #don't show menus for public users
1.954     raeburn  5638:         if (!$public){
1.1075.2.52  raeburn  5639:             $bodytag .= Apache::lonmenu::secondary_menu($httphost);
1.903     droeschl 5640:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  5641:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   5642:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5643:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1075.2.133  raeburn  5644:                                 $args->{'bread_crumbs'},'','',$hostname);
1.1075.2.116  raeburn  5645:             } elsif ($forcereg) {
1.1075.2.22  raeburn  5646:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1075.2.116  raeburn  5647:                                                             $args->{'group'},
1.1075.2.133  raeburn  5648:                                                             $args->{'hide_buttons',
                   5649:                                                             $hostname});
1.1075.2.15  raeburn  5650:             } else {
1.1075.2.21  raeburn  5651:                 my $forbodytag;
                   5652:                 &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5653:                                                     $forcereg,$args->{'group'},
                   5654:                                                     $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5655:                                                     $advtoolsref,'',$hostname,
                   5656:                                                     \$forbodytag);
1.1075.2.21  raeburn  5657:                 unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5658:                     $bodytag .= $forbodytag;
                   5659:                 }
1.920     raeburn  5660:             }
1.903     droeschl 5661:         }else{
                   5662:             # this is to seperate menu from content when there's no secondary
                   5663:             # menu. Especially needed for public accessible ressources.
                   5664:             $bodytag .= '<hr style="clear:both" />';
                   5665:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5666:         }
1.903     droeschl 5667: 
1.235     raeburn  5668:         return $bodytag;
1.1075.2.12  raeburn  5669:     }
                   5670: 
                   5671: #
                   5672: # Top frame rendering, Remote is up
                   5673: #
                   5674: 
                   5675:     my $imgsrc = $img;
                   5676:     if ($img =~ /^\/adm/) {
                   5677:         $imgsrc = &lonhttpdurl($img);
                   5678:     }
                   5679:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
                   5680: 
1.1075.2.60  raeburn  5681:     my $help=($no_inline_link?''
                   5682:               :&Apache::loncommon::top_nav_help('Help'));
                   5683: 
1.1075.2.12  raeburn  5684:     # Explicit link to get inline menu
                   5685:     my $menu= ($no_inline_link?''
                   5686:                :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
                   5687: 
                   5688:     if ($dc_info) {
                   5689:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   5690:     }
                   5691: 
1.1075.2.38  raeburn  5692:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   5693:     unless ($public) {
                   5694:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5695:                                 undef,'LC_menubuttons_link');
                   5696:     }
                   5697: 
1.1075.2.12  raeburn  5698:     unless ($env{'form.inhibitmenu'}) {
                   5699:         $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.1075.2.38  raeburn  5700:                        <ol class="LC_primary_menu LC_floatright LC_right">
1.1075.2.60  raeburn  5701:                        <li>$help</li>
1.1075.2.12  raeburn  5702:                        <li>$menu</li>
                   5703:                        </ol><div id="LC_realm"> $realm $dc_info</div>|;
                   5704:     }
1.1075.2.13  raeburn  5705:     if ($env{'request.state'} eq 'construct') {
                   5706:         if (!$public){
                   5707:             if ($env{'request.state'} eq 'construct') {
                   5708:                 $funclist = &Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5709:                                 &Apache::lonmenu::utilityfunctions($httphost), 'start').
1.1075.2.13  raeburn  5710:                             &Apache::lonhtmlcommon::scripttag('','end').
                   5711:                             &Apache::lonmenu::innerregister($forcereg,
                   5712:                                                             $args->{'bread_crumbs'});
                   5713:             }
                   5714:         }
                   5715:     }
1.1075.2.21  raeburn  5716:     return $bodytag."\n".$funclist;
1.182     matthew  5717: }
                   5718: 
1.917     raeburn  5719: sub dc_courseid_toggle {
                   5720:     my ($dc_info) = @_;
1.980     raeburn  5721:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5722:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5723:            &mt('(More ...)').'</a></span>'.
                   5724:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5725: }
                   5726: 
1.330     albertel 5727: sub make_attr_string {
                   5728:     my ($register,$attr_ref) = @_;
                   5729: 
                   5730:     if ($attr_ref && !ref($attr_ref)) {
                   5731: 	die("addentries Must be a hash ref ".
                   5732: 	    join(':',caller(1))." ".
                   5733: 	    join(':',caller(0))." ");
                   5734:     }
                   5735: 
                   5736:     if ($register) {
1.339     albertel 5737: 	my ($on_load,$on_unload);
                   5738: 	foreach my $key (keys(%{$attr_ref})) {
                   5739: 	    if      (lc($key) eq 'onload') {
                   5740: 		$on_load.=$attr_ref->{$key}.';';
                   5741: 		delete($attr_ref->{$key});
                   5742: 
                   5743: 	    } elsif (lc($key) eq 'onunload') {
                   5744: 		$on_unload.=$attr_ref->{$key}.';';
                   5745: 		delete($attr_ref->{$key});
                   5746: 	    }
                   5747: 	}
1.1075.2.12  raeburn  5748:         if ($env{'environment.remote'} eq 'on') {
                   5749:             $attr_ref->{'onload'}  =
                   5750:                 &Apache::lonmenu::loadevents().  $on_load;
                   5751:             $attr_ref->{'onunload'}=
                   5752:                 &Apache::lonmenu::unloadevents().$on_unload;
                   5753:         } else {  
                   5754: 	    $attr_ref->{'onload'}  = $on_load;
                   5755: 	    $attr_ref->{'onunload'}= $on_unload;
                   5756:         }
1.330     albertel 5757:     }
1.339     albertel 5758: 
1.330     albertel 5759:     my $attr_string;
1.1075.2.56  raeburn  5760:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 5761: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5762:     }
                   5763:     return $attr_string;
                   5764: }
                   5765: 
                   5766: 
1.182     matthew  5767: ###############################################
1.251     albertel 5768: ###############################################
                   5769: 
                   5770: =pod
                   5771: 
                   5772: =item * &endbodytag()
                   5773: 
                   5774: Returns a uniform footer for LON-CAPA web pages.
                   5775: 
1.635     raeburn  5776: Inputs: 1 - optional reference to an args hash
                   5777: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5778: a 'Continue' link is not displayed if the page contains an
                   5779: internal redirect in the <head></head> section,
                   5780: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 5781: 
                   5782: =cut
                   5783: 
                   5784: sub endbodytag {
1.635     raeburn  5785:     my ($args) = @_;
1.1075.2.6  raeburn  5786:     my $endbodytag;
                   5787:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   5788:         $endbodytag='</body>';
                   5789:     }
1.315     albertel 5790:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  5791:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   5792: 	    $endbodytag=
                   5793: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   5794: 	        &mt('Continue').'</a>'.
                   5795: 	        $endbodytag;
                   5796:         }
1.315     albertel 5797:     }
1.251     albertel 5798:     return $endbodytag;
                   5799: }
                   5800: 
1.352     albertel 5801: =pod
                   5802: 
                   5803: =item * &standard_css()
                   5804: 
                   5805: Returns a style sheet
                   5806: 
                   5807: Inputs: (all optional)
                   5808:             domain         -> force to color decorate a page for a specific
                   5809:                                domain
                   5810:             function       -> force usage of a specific rolish color scheme
                   5811:             bgcolor        -> override the default page bgcolor
                   5812: 
                   5813: =cut
                   5814: 
1.343     albertel 5815: sub standard_css {
1.345     albertel 5816:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 5817:     $function  = &get_users_function() if (!$function);
                   5818:     my $img    = &designparm($function.'.img',   $domain);
                   5819:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   5820:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 5821:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 5822: #second colour for later usage
1.345     albertel 5823:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 5824:     my $pgbg_or_bgcolor =
                   5825: 	         $bgcolor ||
1.352     albertel 5826: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 5827:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 5828:     my $alink  = &designparm($function.'.alink', $domain);
                   5829:     my $vlink  = &designparm($function.'.vlink', $domain);
                   5830:     my $link   = &designparm($function.'.link',  $domain);
                   5831: 
1.602     albertel 5832:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 5833:     my $mono                 = 'monospace';
1.850     bisitz   5834:     my $data_table_head      = $sidebg;
                   5835:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   5836:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 5837:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 5838:     my $data_table_highlight = '#FFFF00';
1.352     albertel 5839:     my $mail_new             = '#FFBB77';
                   5840:     my $mail_new_hover       = '#DD9955';
                   5841:     my $mail_read            = '#BBBB77';
                   5842:     my $mail_read_hover      = '#999944';
                   5843:     my $mail_replied         = '#AAAA88';
                   5844:     my $mail_replied_hover   = '#888855';
                   5845:     my $mail_other           = '#99BBBB';
                   5846:     my $mail_other_hover     = '#669999';
1.391     albertel 5847:     my $table_header         = '#DDDDDD';
1.489     raeburn  5848:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   5849:     my $lg_border_color      = '#C8C8C8';
1.952     onken    5850:     my $button_hover         = '#BF2317';
1.392     albertel 5851: 
1.608     albertel 5852:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   5853:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   5854:                                              : '0 3px 0 4px';
1.448     albertel 5855: 
1.523     albertel 5856: 
1.343     albertel 5857:     return <<END;
1.947     droeschl 5858: 
                   5859: /* needed for iframe to allow 100% height in FF */
                   5860: body, html { 
                   5861:     margin: 0;
                   5862:     padding: 0 0.5%;
                   5863:     height: 99%; /* to avoid scrollbars */
                   5864: }
                   5865: 
1.795     www      5866: body {
1.911     bisitz   5867:   font-family: $sans;
                   5868:   line-height:130%;
                   5869:   font-size:0.83em;
                   5870:   color:$font;
1.795     www      5871: }
                   5872: 
1.959     onken    5873: a:focus,
                   5874: a:focus img {
1.795     www      5875:   color: red;
                   5876: }
1.698     harmsja  5877: 
1.911     bisitz   5878: form, .inline {
                   5879:   display: inline;
1.795     www      5880: }
1.721     harmsja  5881: 
1.795     www      5882: .LC_right {
1.911     bisitz   5883:   text-align:right;
1.795     www      5884: }
                   5885: 
                   5886: .LC_middle {
1.911     bisitz   5887:   vertical-align:middle;
1.795     www      5888: }
1.721     harmsja  5889: 
1.1075.2.38  raeburn  5890: .LC_floatleft {
                   5891:   float: left;
                   5892: }
                   5893: 
                   5894: .LC_floatright {
                   5895:   float: right;
                   5896: }
                   5897: 
1.911     bisitz   5898: .LC_400Box {
                   5899:   width:400px;
                   5900: }
1.721     harmsja  5901: 
1.947     droeschl 5902: .LC_iframecontainer {
                   5903:     width: 98%;
                   5904:     margin: 0;
                   5905:     position: fixed;
                   5906:     top: 8.5em;
                   5907:     bottom: 0;
                   5908: }
                   5909: 
                   5910: .LC_iframecontainer iframe{
                   5911:     border: none;
                   5912:     width: 100%;
                   5913:     height: 100%;
                   5914: }
                   5915: 
1.778     bisitz   5916: .LC_filename {
                   5917:   font-family: $mono;
                   5918:   white-space:pre;
1.921     bisitz   5919:   font-size: 120%;
1.778     bisitz   5920: }
                   5921: 
                   5922: .LC_fileicon {
                   5923:   border: none;
                   5924:   height: 1.3em;
                   5925:   vertical-align: text-bottom;
                   5926:   margin-right: 0.3em;
                   5927:   text-decoration:none;
                   5928: }
                   5929: 
1.1008    www      5930: .LC_setting {
                   5931:   text-decoration:underline;
                   5932: }
                   5933: 
1.350     albertel 5934: .LC_error {
                   5935:   color: red;
                   5936: }
1.795     www      5937: 
1.1075.2.15  raeburn  5938: .LC_warning {
                   5939:   color: darkorange;
                   5940: }
                   5941: 
1.457     albertel 5942: .LC_diff_removed {
1.733     bisitz   5943:   color: red;
1.394     albertel 5944: }
1.532     albertel 5945: 
                   5946: .LC_info,
1.457     albertel 5947: .LC_success,
                   5948: .LC_diff_added {
1.350     albertel 5949:   color: green;
                   5950: }
1.795     www      5951: 
1.802     bisitz   5952: div.LC_confirm_box {
                   5953:   background-color: #FAFAFA;
                   5954:   border: 1px solid $lg_border_color;
                   5955:   margin-right: 0;
                   5956:   padding: 5px;
                   5957: }
                   5958: 
                   5959: div.LC_confirm_box .LC_error img,
                   5960: div.LC_confirm_box .LC_success img {
                   5961:   vertical-align: middle;
                   5962: }
                   5963: 
1.1075.2.108  raeburn  5964: .LC_maxwidth {
                   5965:   max-width: 100%;
                   5966:   height: auto;
                   5967: }
                   5968: 
                   5969: .LC_textsize_mobile {
                   5970:   \@media only screen and (max-device-width: 480px) {
                   5971:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   5972:   }
                   5973: }
                   5974: 
1.440     albertel 5975: .LC_icon {
1.771     droeschl 5976:   border: none;
1.790     droeschl 5977:   vertical-align: middle;
1.771     droeschl 5978: }
                   5979: 
1.543     albertel 5980: .LC_docs_spacer {
                   5981:   width: 25px;
                   5982:   height: 1px;
1.771     droeschl 5983:   border: none;
1.543     albertel 5984: }
1.346     albertel 5985: 
1.532     albertel 5986: .LC_internal_info {
1.735     bisitz   5987:   color: #999999;
1.532     albertel 5988: }
                   5989: 
1.794     www      5990: .LC_discussion {
1.1050    www      5991:   background: $data_table_dark;
1.911     bisitz   5992:   border: 1px solid black;
                   5993:   margin: 2px;
1.794     www      5994: }
                   5995: 
                   5996: .LC_disc_action_left {
1.1050    www      5997:   background: $sidebg;
1.911     bisitz   5998:   text-align: left;
1.1050    www      5999:   padding: 4px;
                   6000:   margin: 2px;
1.794     www      6001: }
                   6002: 
                   6003: .LC_disc_action_right {
1.1050    www      6004:   background: $sidebg;
1.911     bisitz   6005:   text-align: right;
1.1050    www      6006:   padding: 4px;
                   6007:   margin: 2px;
1.794     www      6008: }
                   6009: 
                   6010: .LC_disc_new_item {
1.911     bisitz   6011:   background: white;
                   6012:   border: 2px solid red;
1.1050    www      6013:   margin: 4px;
                   6014:   padding: 4px;
1.794     www      6015: }
                   6016: 
                   6017: .LC_disc_old_item {
1.911     bisitz   6018:   background: white;
1.1050    www      6019:   margin: 4px;
                   6020:   padding: 4px;
1.794     www      6021: }
                   6022: 
1.458     albertel 6023: table.LC_pastsubmission {
                   6024:   border: 1px solid black;
                   6025:   margin: 2px;
                   6026: }
                   6027: 
1.924     bisitz   6028: table#LC_menubuttons {
1.345     albertel 6029:   width: 100%;
                   6030:   background: $pgbg;
1.392     albertel 6031:   border: 2px;
1.402     albertel 6032:   border-collapse: separate;
1.803     bisitz   6033:   padding: 0;
1.345     albertel 6034: }
1.392     albertel 6035: 
1.801     tempelho 6036: table#LC_title_bar a {
                   6037:   color: $fontmenu;
                   6038: }
1.836     bisitz   6039: 
1.807     droeschl 6040: table#LC_title_bar {
1.819     tempelho 6041:   clear: both;
1.836     bisitz   6042:   display: none;
1.807     droeschl 6043: }
                   6044: 
1.795     www      6045: table#LC_title_bar,
1.933     droeschl 6046: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 6047: table#LC_title_bar.LC_with_remote {
1.359     albertel 6048:   width: 100%;
1.392     albertel 6049:   border-color: $pgbg;
                   6050:   border-style: solid;
                   6051:   border-width: $border;
1.379     albertel 6052:   background: $pgbg;
1.801     tempelho 6053:   color: $fontmenu;
1.392     albertel 6054:   border-collapse: collapse;
1.803     bisitz   6055:   padding: 0;
1.819     tempelho 6056:   margin: 0;
1.359     albertel 6057: }
1.795     www      6058: 
1.933     droeschl 6059: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 6060:     margin: 0;
                   6061:     padding: 0;
1.933     droeschl 6062:     position: relative;
                   6063:     list-style: none;
1.913     droeschl 6064: }
1.933     droeschl 6065: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 6066:     display: inline;
                   6067: }
1.933     droeschl 6068: 
                   6069: .LC_breadcrumb_tools_navigation {
1.913     droeschl 6070:     padding: 0;
1.933     droeschl 6071:     margin: 0;
                   6072:     float: left;
1.913     droeschl 6073: }
1.933     droeschl 6074: .LC_breadcrumb_tools_tools {
                   6075:     padding: 0;
                   6076:     margin: 0;
1.913     droeschl 6077:     float: right;
                   6078: }
                   6079: 
1.359     albertel 6080: table#LC_title_bar td {
                   6081:   background: $tabbg;
                   6082: }
1.795     www      6083: 
1.911     bisitz   6084: table#LC_menubuttons img {
1.803     bisitz   6085:   border: none;
1.346     albertel 6086: }
1.795     www      6087: 
1.842     droeschl 6088: .LC_breadcrumbs_component {
1.911     bisitz   6089:   float: right;
                   6090:   margin: 0 1em;
1.357     albertel 6091: }
1.842     droeschl 6092: .LC_breadcrumbs_component img {
1.911     bisitz   6093:   vertical-align: middle;
1.777     tempelho 6094: }
1.795     www      6095: 
1.1075.2.108  raeburn  6096: .LC_breadcrumbs_hoverable {
                   6097:   background: $sidebg;
                   6098: }
                   6099: 
1.383     albertel 6100: td.LC_table_cell_checkbox {
                   6101:   text-align: center;
                   6102: }
1.795     www      6103: 
                   6104: .LC_fontsize_small {
1.911     bisitz   6105:   font-size: 70%;
1.705     tempelho 6106: }
                   6107: 
1.844     bisitz   6108: #LC_breadcrumbs {
1.911     bisitz   6109:   clear:both;
                   6110:   background: $sidebg;
                   6111:   border-bottom: 1px solid $lg_border_color;
                   6112:   line-height: 2.5em;
1.933     droeschl 6113:   overflow: hidden;
1.911     bisitz   6114:   margin: 0;
                   6115:   padding: 0;
1.995     raeburn  6116:   text-align: left;
1.819     tempelho 6117: }
1.862     bisitz   6118: 
1.1075.2.16  raeburn  6119: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   6120:   clear:both;
                   6121:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 6122:   border: 1px solid $sidebg;
1.1075.2.16  raeburn  6123:   margin: 0 0 10px 0;
1.966     bisitz   6124:   padding: 3px;
1.995     raeburn  6125:   text-align: left;
1.822     bisitz   6126: }
                   6127: 
1.795     www      6128: .LC_fontsize_medium {
1.911     bisitz   6129:   font-size: 85%;
1.705     tempelho 6130: }
                   6131: 
1.795     www      6132: .LC_fontsize_large {
1.911     bisitz   6133:   font-size: 120%;
1.705     tempelho 6134: }
                   6135: 
1.346     albertel 6136: .LC_menubuttons_inline_text {
                   6137:   color: $font;
1.698     harmsja  6138:   font-size: 90%;
1.701     harmsja  6139:   padding-left:3px;
1.346     albertel 6140: }
                   6141: 
1.934     droeschl 6142: .LC_menubuttons_inline_text img{
                   6143:   vertical-align: middle;
                   6144: }
                   6145: 
1.1051    www      6146: li.LC_menubuttons_inline_text img {
1.951     onken    6147:   cursor:pointer;
1.1002    droeschl 6148:   text-decoration: none;
1.951     onken    6149: }
                   6150: 
1.526     www      6151: .LC_menubuttons_link {
                   6152:   text-decoration: none;
                   6153: }
1.795     www      6154: 
1.522     albertel 6155: .LC_menubuttons_category {
1.521     www      6156:   color: $font;
1.526     www      6157:   background: $pgbg;
1.521     www      6158:   font-size: larger;
                   6159:   font-weight: bold;
                   6160: }
                   6161: 
1.346     albertel 6162: td.LC_menubuttons_text {
1.911     bisitz   6163:   color: $font;
1.346     albertel 6164: }
1.706     harmsja  6165: 
1.346     albertel 6166: .LC_current_location {
                   6167:   background: $tabbg;
                   6168: }
1.795     www      6169: 
1.1075.2.134  raeburn  6170: td.LC_zero_height {
                   6171:   line-height: 0;
                   6172:   cellpadding: 0;
                   6173: }
                   6174: 
1.938     bisitz   6175: table.LC_data_table {
1.347     albertel 6176:   border: 1px solid #000000;
1.402     albertel 6177:   border-collapse: separate;
1.426     albertel 6178:   border-spacing: 1px;
1.610     albertel 6179:   background: $pgbg;
1.347     albertel 6180: }
1.795     www      6181: 
1.422     albertel 6182: .LC_data_table_dense {
                   6183:   font-size: small;
                   6184: }
1.795     www      6185: 
1.507     raeburn  6186: table.LC_nested_outer {
                   6187:   border: 1px solid #000000;
1.589     raeburn  6188:   border-collapse: collapse;
1.803     bisitz   6189:   border-spacing: 0;
1.507     raeburn  6190:   width: 100%;
                   6191: }
1.795     www      6192: 
1.879     raeburn  6193: table.LC_innerpickbox,
1.507     raeburn  6194: table.LC_nested {
1.803     bisitz   6195:   border: none;
1.589     raeburn  6196:   border-collapse: collapse;
1.803     bisitz   6197:   border-spacing: 0;
1.507     raeburn  6198:   width: 100%;
                   6199: }
1.795     www      6200: 
1.911     bisitz   6201: table.LC_data_table tr th,
                   6202: table.LC_calendar tr th,
1.879     raeburn  6203: table.LC_prior_tries tr th,
                   6204: table.LC_innerpickbox tr th {
1.349     albertel 6205:   font-weight: bold;
                   6206:   background-color: $data_table_head;
1.801     tempelho 6207:   color:$fontmenu;
1.701     harmsja  6208:   font-size:90%;
1.347     albertel 6209: }
1.795     www      6210: 
1.879     raeburn  6211: table.LC_innerpickbox tr th,
                   6212: table.LC_innerpickbox tr td {
                   6213:   vertical-align: top;
                   6214: }
                   6215: 
1.711     raeburn  6216: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6217:   background-color: #CCCCCC;
1.711     raeburn  6218:   font-weight: bold;
                   6219:   text-align: left;
                   6220: }
1.795     www      6221: 
1.912     bisitz   6222: table.LC_data_table tr.LC_odd_row > td {
                   6223:   background-color: $data_table_light;
                   6224:   padding: 2px;
                   6225:   vertical-align: top;
                   6226: }
                   6227: 
1.809     bisitz   6228: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6229:   background-color: $data_table_light;
1.912     bisitz   6230:   vertical-align: top;
                   6231: }
                   6232: 
                   6233: table.LC_data_table tr.LC_even_row > td {
                   6234:   background-color: $data_table_dark;
1.425     albertel 6235:   padding: 2px;
1.900     bisitz   6236:   vertical-align: top;
1.347     albertel 6237: }
1.795     www      6238: 
1.809     bisitz   6239: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6240:   background-color: $data_table_dark;
1.900     bisitz   6241:   vertical-align: top;
1.347     albertel 6242: }
1.795     www      6243: 
1.425     albertel 6244: table.LC_data_table tr.LC_data_table_highlight td {
                   6245:   background-color: $data_table_darker;
                   6246: }
1.795     www      6247: 
1.639     raeburn  6248: table.LC_data_table tr td.LC_leftcol_header {
                   6249:   background-color: $data_table_head;
                   6250:   font-weight: bold;
                   6251: }
1.795     www      6252: 
1.451     albertel 6253: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6254: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6255:   font-weight: bold;
                   6256:   font-style: italic;
                   6257:   text-align: center;
                   6258:   padding: 8px;
1.347     albertel 6259: }
1.795     www      6260: 
1.1075.2.30  raeburn  6261: table.LC_data_table tr.LC_empty_row td,
                   6262: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6263:   background-color: $sidebg;
                   6264: }
                   6265: 
                   6266: table.LC_nested tr.LC_empty_row td {
                   6267:   background-color: #FFFFFF;
                   6268: }
                   6269: 
1.890     droeschl 6270: table.LC_caption {
                   6271: }
                   6272: 
1.507     raeburn  6273: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6274:   padding: 4ex
                   6275: }
1.795     www      6276: 
1.507     raeburn  6277: table.LC_nested_outer tr th {
                   6278:   font-weight: bold;
1.801     tempelho 6279:   color:$fontmenu;
1.507     raeburn  6280:   background-color: $data_table_head;
1.701     harmsja  6281:   font-size: small;
1.507     raeburn  6282:   border-bottom: 1px solid #000000;
                   6283: }
1.795     www      6284: 
1.507     raeburn  6285: table.LC_nested_outer tr td.LC_subheader {
                   6286:   background-color: $data_table_head;
                   6287:   font-weight: bold;
                   6288:   font-size: small;
                   6289:   border-bottom: 1px solid #000000;
                   6290:   text-align: right;
1.451     albertel 6291: }
1.795     www      6292: 
1.507     raeburn  6293: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6294:   background-color: #CCCCCC;
1.451     albertel 6295:   font-weight: bold;
                   6296:   font-size: small;
1.507     raeburn  6297:   text-align: center;
                   6298: }
1.795     www      6299: 
1.589     raeburn  6300: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6301: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6302:   text-align: left;
1.451     albertel 6303: }
1.795     www      6304: 
1.507     raeburn  6305: table.LC_nested td {
1.735     bisitz   6306:   background-color: #FFFFFF;
1.451     albertel 6307:   font-size: small;
1.507     raeburn  6308: }
1.795     www      6309: 
1.507     raeburn  6310: table.LC_nested_outer tr th.LC_right_item,
                   6311: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6312: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6313: table.LC_nested tr td.LC_right_item {
1.451     albertel 6314:   text-align: right;
                   6315: }
                   6316: 
1.507     raeburn  6317: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6318:   background-color: #EEEEEE;
1.451     albertel 6319: }
                   6320: 
1.473     raeburn  6321: table.LC_createuser {
                   6322: }
                   6323: 
                   6324: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6325:   font-size: small;
1.473     raeburn  6326: }
                   6327: 
                   6328: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6329:   background-color: #CCCCCC;
1.473     raeburn  6330:   font-weight: bold;
                   6331:   text-align: center;
                   6332: }
                   6333: 
1.349     albertel 6334: table.LC_calendar {
                   6335:   border: 1px solid #000000;
                   6336:   border-collapse: collapse;
1.917     raeburn  6337:   width: 98%;
1.349     albertel 6338: }
1.795     www      6339: 
1.349     albertel 6340: table.LC_calendar_pickdate {
                   6341:   font-size: xx-small;
                   6342: }
1.795     www      6343: 
1.349     albertel 6344: table.LC_calendar tr td {
                   6345:   border: 1px solid #000000;
                   6346:   vertical-align: top;
1.917     raeburn  6347:   width: 14%;
1.349     albertel 6348: }
1.795     www      6349: 
1.349     albertel 6350: table.LC_calendar tr td.LC_calendar_day_empty {
                   6351:   background-color: $data_table_dark;
                   6352: }
1.795     www      6353: 
1.779     bisitz   6354: table.LC_calendar tr td.LC_calendar_day_current {
                   6355:   background-color: $data_table_highlight;
1.777     tempelho 6356: }
1.795     www      6357: 
1.938     bisitz   6358: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6359:   background-color: $mail_new;
                   6360: }
1.795     www      6361: 
1.938     bisitz   6362: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6363:   background-color: $mail_new_hover;
                   6364: }
1.795     www      6365: 
1.938     bisitz   6366: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6367:   background-color: $mail_read;
                   6368: }
1.795     www      6369: 
1.938     bisitz   6370: /*
                   6371: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6372:   background-color: $mail_read_hover;
                   6373: }
1.938     bisitz   6374: */
1.795     www      6375: 
1.938     bisitz   6376: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6377:   background-color: $mail_replied;
                   6378: }
1.795     www      6379: 
1.938     bisitz   6380: /*
                   6381: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6382:   background-color: $mail_replied_hover;
                   6383: }
1.938     bisitz   6384: */
1.795     www      6385: 
1.938     bisitz   6386: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6387:   background-color: $mail_other;
                   6388: }
1.795     www      6389: 
1.938     bisitz   6390: /*
                   6391: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6392:   background-color: $mail_other_hover;
                   6393: }
1.938     bisitz   6394: */
1.494     raeburn  6395: 
1.777     tempelho 6396: table.LC_data_table tr > td.LC_browser_file,
                   6397: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6398:   background: #AAEE77;
1.389     albertel 6399: }
1.795     www      6400: 
1.777     tempelho 6401: table.LC_data_table tr > td.LC_browser_file_locked,
                   6402: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6403:   background: #FFAA99;
1.387     albertel 6404: }
1.795     www      6405: 
1.777     tempelho 6406: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6407:   background: #888888;
1.779     bisitz   6408: }
1.795     www      6409: 
1.777     tempelho 6410: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6411: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6412:   background: #F8F866;
1.777     tempelho 6413: }
1.795     www      6414: 
1.696     bisitz   6415: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6416:   background: #E0E8FF;
1.387     albertel 6417: }
1.696     bisitz   6418: 
1.707     bisitz   6419: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6420:   /* background: #77FF77; */
1.707     bisitz   6421: }
1.795     www      6422: 
1.707     bisitz   6423: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6424:   border-right: 8px solid #FFFF77;
1.707     bisitz   6425: }
1.795     www      6426: 
1.707     bisitz   6427: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6428:   border-right: 8px solid #FFAA77;
1.707     bisitz   6429: }
1.795     www      6430: 
1.707     bisitz   6431: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6432:   border-right: 8px solid #FF7777;
1.707     bisitz   6433: }
1.795     www      6434: 
1.707     bisitz   6435: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6436:   border-right: 8px solid #AAFF77;
1.707     bisitz   6437: }
1.795     www      6438: 
1.707     bisitz   6439: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6440:   border-right: 8px solid #11CC55;
1.707     bisitz   6441: }
                   6442: 
1.388     albertel 6443: span.LC_current_location {
1.701     harmsja  6444:   font-size:larger;
1.388     albertel 6445:   background: $pgbg;
                   6446: }
1.387     albertel 6447: 
1.1029    www      6448: span.LC_current_nav_location {
                   6449:   font-weight:bold;
                   6450:   background: $sidebg;
                   6451: }
                   6452: 
1.395     albertel 6453: span.LC_parm_menu_item {
                   6454:   font-size: larger;
                   6455: }
1.795     www      6456: 
1.395     albertel 6457: span.LC_parm_scope_all {
                   6458:   color: red;
                   6459: }
1.795     www      6460: 
1.395     albertel 6461: span.LC_parm_scope_folder {
                   6462:   color: green;
                   6463: }
1.795     www      6464: 
1.395     albertel 6465: span.LC_parm_scope_resource {
                   6466:   color: orange;
                   6467: }
1.795     www      6468: 
1.395     albertel 6469: span.LC_parm_part {
                   6470:   color: blue;
                   6471: }
1.795     www      6472: 
1.911     bisitz   6473: span.LC_parm_folder,
                   6474: span.LC_parm_symb {
1.395     albertel 6475:   font-size: x-small;
                   6476:   font-family: $mono;
                   6477:   color: #AAAAAA;
                   6478: }
                   6479: 
1.977     bisitz   6480: ul.LC_parm_parmlist li {
                   6481:   display: inline-block;
                   6482:   padding: 0.3em 0.8em;
                   6483:   vertical-align: top;
                   6484:   width: 150px;
                   6485:   border-top:1px solid $lg_border_color;
                   6486: }
                   6487: 
1.795     www      6488: td.LC_parm_overview_level_menu,
                   6489: td.LC_parm_overview_map_menu,
                   6490: td.LC_parm_overview_parm_selectors,
                   6491: td.LC_parm_overview_restrictions  {
1.396     albertel 6492:   border: 1px solid black;
                   6493:   border-collapse: collapse;
                   6494: }
1.795     www      6495: 
1.396     albertel 6496: table.LC_parm_overview_restrictions td {
                   6497:   border-width: 1px 4px 1px 4px;
                   6498:   border-style: solid;
                   6499:   border-color: $pgbg;
                   6500:   text-align: center;
                   6501: }
1.795     www      6502: 
1.396     albertel 6503: table.LC_parm_overview_restrictions th {
                   6504:   background: $tabbg;
                   6505:   border-width: 1px 4px 1px 4px;
                   6506:   border-style: solid;
                   6507:   border-color: $pgbg;
                   6508: }
1.795     www      6509: 
1.398     albertel 6510: table#LC_helpmenu {
1.803     bisitz   6511:   border: none;
1.398     albertel 6512:   height: 55px;
1.803     bisitz   6513:   border-spacing: 0;
1.398     albertel 6514: }
                   6515: 
                   6516: table#LC_helpmenu fieldset legend {
                   6517:   font-size: larger;
                   6518: }
1.795     www      6519: 
1.397     albertel 6520: table#LC_helpmenu_links {
                   6521:   width: 100%;
                   6522:   border: 1px solid black;
                   6523:   background: $pgbg;
1.803     bisitz   6524:   padding: 0;
1.397     albertel 6525:   border-spacing: 1px;
                   6526: }
1.795     www      6527: 
1.397     albertel 6528: table#LC_helpmenu_links tr td {
                   6529:   padding: 1px;
                   6530:   background: $tabbg;
1.399     albertel 6531:   text-align: center;
                   6532:   font-weight: bold;
1.397     albertel 6533: }
1.396     albertel 6534: 
1.795     www      6535: table#LC_helpmenu_links a:link,
                   6536: table#LC_helpmenu_links a:visited,
1.397     albertel 6537: table#LC_helpmenu_links a:active {
                   6538:   text-decoration: none;
                   6539:   color: $font;
                   6540: }
1.795     www      6541: 
1.397     albertel 6542: table#LC_helpmenu_links a:hover {
                   6543:   text-decoration: underline;
                   6544:   color: $vlink;
                   6545: }
1.396     albertel 6546: 
1.417     albertel 6547: .LC_chrt_popup_exists {
                   6548:   border: 1px solid #339933;
                   6549:   margin: -1px;
                   6550: }
1.795     www      6551: 
1.417     albertel 6552: .LC_chrt_popup_up {
                   6553:   border: 1px solid yellow;
                   6554:   margin: -1px;
                   6555: }
1.795     www      6556: 
1.417     albertel 6557: .LC_chrt_popup {
                   6558:   border: 1px solid #8888FF;
                   6559:   background: #CCCCFF;
                   6560: }
1.795     www      6561: 
1.421     albertel 6562: table.LC_pick_box {
                   6563:   border-collapse: separate;
                   6564:   background: white;
                   6565:   border: 1px solid black;
                   6566:   border-spacing: 1px;
                   6567: }
1.795     www      6568: 
1.421     albertel 6569: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6570:   background: $sidebg;
1.421     albertel 6571:   font-weight: bold;
1.900     bisitz   6572:   text-align: left;
1.740     bisitz   6573:   vertical-align: top;
1.421     albertel 6574:   width: 184px;
                   6575:   padding: 8px;
                   6576: }
1.795     www      6577: 
1.579     raeburn  6578: table.LC_pick_box td.LC_pick_box_value {
                   6579:   text-align: left;
                   6580:   padding: 8px;
                   6581: }
1.795     www      6582: 
1.579     raeburn  6583: table.LC_pick_box td.LC_pick_box_select {
                   6584:   text-align: left;
                   6585:   padding: 8px;
                   6586: }
1.795     www      6587: 
1.424     albertel 6588: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6589:   padding: 0;
1.421     albertel 6590:   height: 1px;
                   6591:   background: black;
                   6592: }
1.795     www      6593: 
1.421     albertel 6594: table.LC_pick_box td.LC_pick_box_submit {
                   6595:   text-align: right;
                   6596: }
1.795     www      6597: 
1.579     raeburn  6598: table.LC_pick_box td.LC_evenrow_value {
                   6599:   text-align: left;
                   6600:   padding: 8px;
                   6601:   background-color: $data_table_light;
                   6602: }
1.795     www      6603: 
1.579     raeburn  6604: table.LC_pick_box td.LC_oddrow_value {
                   6605:   text-align: left;
                   6606:   padding: 8px;
                   6607:   background-color: $data_table_light;
                   6608: }
1.795     www      6609: 
1.579     raeburn  6610: span.LC_helpform_receipt_cat {
                   6611:   font-weight: bold;
                   6612: }
1.795     www      6613: 
1.424     albertel 6614: table.LC_group_priv_box {
                   6615:   background: white;
                   6616:   border: 1px solid black;
                   6617:   border-spacing: 1px;
                   6618: }
1.795     www      6619: 
1.424     albertel 6620: table.LC_group_priv_box td.LC_pick_box_title {
                   6621:   background: $tabbg;
                   6622:   font-weight: bold;
                   6623:   text-align: right;
                   6624:   width: 184px;
                   6625: }
1.795     www      6626: 
1.424     albertel 6627: table.LC_group_priv_box td.LC_groups_fixed {
                   6628:   background: $data_table_light;
                   6629:   text-align: center;
                   6630: }
1.795     www      6631: 
1.424     albertel 6632: table.LC_group_priv_box td.LC_groups_optional {
                   6633:   background: $data_table_dark;
                   6634:   text-align: center;
                   6635: }
1.795     www      6636: 
1.424     albertel 6637: table.LC_group_priv_box td.LC_groups_functionality {
                   6638:   background: $data_table_darker;
                   6639:   text-align: center;
                   6640:   font-weight: bold;
                   6641: }
1.795     www      6642: 
1.424     albertel 6643: table.LC_group_priv td {
                   6644:   text-align: left;
1.803     bisitz   6645:   padding: 0;
1.424     albertel 6646: }
                   6647: 
                   6648: .LC_navbuttons {
                   6649:   margin: 2ex 0ex 2ex 0ex;
                   6650: }
1.795     www      6651: 
1.423     albertel 6652: .LC_topic_bar {
                   6653:   font-weight: bold;
                   6654:   background: $tabbg;
1.918     wenzelju 6655:   margin: 1em 0em 1em 2em;
1.805     bisitz   6656:   padding: 3px;
1.918     wenzelju 6657:   font-size: 1.2em;
1.423     albertel 6658: }
1.795     www      6659: 
1.423     albertel 6660: .LC_topic_bar span {
1.918     wenzelju 6661:   left: 0.5em;
                   6662:   position: absolute;
1.423     albertel 6663:   vertical-align: middle;
1.918     wenzelju 6664:   font-size: 1.2em;
1.423     albertel 6665: }
1.795     www      6666: 
1.423     albertel 6667: table.LC_course_group_status {
                   6668:   margin: 20px;
                   6669: }
1.795     www      6670: 
1.423     albertel 6671: table.LC_status_selector td {
                   6672:   vertical-align: top;
                   6673:   text-align: center;
1.424     albertel 6674:   padding: 4px;
                   6675: }
1.795     www      6676: 
1.599     albertel 6677: div.LC_feedback_link {
1.616     albertel 6678:   clear: both;
1.829     kalberla 6679:   background: $sidebg;
1.779     bisitz   6680:   width: 100%;
1.829     kalberla 6681:   padding-bottom: 10px;
                   6682:   border: 1px $tabbg solid;
1.833     kalberla 6683:   height: 22px;
                   6684:   line-height: 22px;
                   6685:   padding-top: 5px;
                   6686: }
                   6687: 
                   6688: div.LC_feedback_link img {
                   6689:   height: 22px;
1.867     kalberla 6690:   vertical-align:middle;
1.829     kalberla 6691: }
                   6692: 
1.911     bisitz   6693: div.LC_feedback_link a {
1.829     kalberla 6694:   text-decoration: none;
1.489     raeburn  6695: }
1.795     www      6696: 
1.867     kalberla 6697: div.LC_comblock {
1.911     bisitz   6698:   display:inline;
1.867     kalberla 6699:   color:$font;
                   6700:   font-size:90%;
                   6701: }
                   6702: 
                   6703: div.LC_feedback_link div.LC_comblock {
                   6704:   padding-left:5px;
                   6705: }
                   6706: 
                   6707: div.LC_feedback_link div.LC_comblock a {
                   6708:   color:$font;
                   6709: }
                   6710: 
1.489     raeburn  6711: span.LC_feedback_link {
1.858     bisitz   6712:   /* background: $feedback_link_bg; */
1.599     albertel 6713:   font-size: larger;
                   6714: }
1.795     www      6715: 
1.599     albertel 6716: span.LC_message_link {
1.858     bisitz   6717:   /* background: $feedback_link_bg; */
1.599     albertel 6718:   font-size: larger;
                   6719:   position: absolute;
                   6720:   right: 1em;
1.489     raeburn  6721: }
1.421     albertel 6722: 
1.515     albertel 6723: table.LC_prior_tries {
1.524     albertel 6724:   border: 1px solid #000000;
                   6725:   border-collapse: separate;
                   6726:   border-spacing: 1px;
1.515     albertel 6727: }
1.523     albertel 6728: 
1.515     albertel 6729: table.LC_prior_tries td {
1.524     albertel 6730:   padding: 2px;
1.515     albertel 6731: }
1.523     albertel 6732: 
                   6733: .LC_answer_correct {
1.795     www      6734:   background: lightgreen;
                   6735:   color: darkgreen;
                   6736:   padding: 6px;
1.523     albertel 6737: }
1.795     www      6738: 
1.523     albertel 6739: .LC_answer_charged_try {
1.797     www      6740:   background: #FFAAAA;
1.795     www      6741:   color: darkred;
                   6742:   padding: 6px;
1.523     albertel 6743: }
1.795     www      6744: 
1.779     bisitz   6745: .LC_answer_not_charged_try,
1.523     albertel 6746: .LC_answer_no_grade,
                   6747: .LC_answer_late {
1.795     www      6748:   background: lightyellow;
1.523     albertel 6749:   color: black;
1.795     www      6750:   padding: 6px;
1.523     albertel 6751: }
1.795     www      6752: 
1.523     albertel 6753: .LC_answer_previous {
1.795     www      6754:   background: lightblue;
                   6755:   color: darkblue;
                   6756:   padding: 6px;
1.523     albertel 6757: }
1.795     www      6758: 
1.779     bisitz   6759: .LC_answer_no_message {
1.777     tempelho 6760:   background: #FFFFFF;
                   6761:   color: black;
1.795     www      6762:   padding: 6px;
1.779     bisitz   6763: }
1.795     www      6764: 
1.1075.2.140  raeburn  6765: .LC_answer_unknown,
                   6766: .LC_answer_warning {
1.779     bisitz   6767:   background: orange;
                   6768:   color: black;
1.795     www      6769:   padding: 6px;
1.777     tempelho 6770: }
1.795     www      6771: 
1.529     albertel 6772: span.LC_prior_numerical,
                   6773: span.LC_prior_string,
                   6774: span.LC_prior_custom,
                   6775: span.LC_prior_reaction,
                   6776: span.LC_prior_math {
1.925     bisitz   6777:   font-family: $mono;
1.523     albertel 6778:   white-space: pre;
                   6779: }
                   6780: 
1.525     albertel 6781: span.LC_prior_string {
1.925     bisitz   6782:   font-family: $mono;
1.525     albertel 6783:   white-space: pre;
                   6784: }
                   6785: 
1.523     albertel 6786: table.LC_prior_option {
                   6787:   width: 100%;
                   6788:   border-collapse: collapse;
                   6789: }
1.795     www      6790: 
1.911     bisitz   6791: table.LC_prior_rank,
1.795     www      6792: table.LC_prior_match {
1.528     albertel 6793:   border-collapse: collapse;
                   6794: }
1.795     www      6795: 
1.528     albertel 6796: table.LC_prior_option tr td,
                   6797: table.LC_prior_rank tr td,
                   6798: table.LC_prior_match tr td {
1.524     albertel 6799:   border: 1px solid #000000;
1.515     albertel 6800: }
                   6801: 
1.855     bisitz   6802: .LC_nobreak {
1.544     albertel 6803:   white-space: nowrap;
1.519     raeburn  6804: }
                   6805: 
1.576     raeburn  6806: span.LC_cusr_emph {
                   6807:   font-style: italic;
                   6808: }
                   6809: 
1.633     raeburn  6810: span.LC_cusr_subheading {
                   6811:   font-weight: normal;
                   6812:   font-size: 85%;
                   6813: }
                   6814: 
1.861     bisitz   6815: div.LC_docs_entry_move {
1.859     bisitz   6816:   border: 1px solid #BBBBBB;
1.545     albertel 6817:   background: #DDDDDD;
1.861     bisitz   6818:   width: 22px;
1.859     bisitz   6819:   padding: 1px;
                   6820:   margin: 0;
1.545     albertel 6821: }
                   6822: 
1.861     bisitz   6823: table.LC_data_table tr > td.LC_docs_entry_commands,
                   6824: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 6825:   font-size: x-small;
                   6826: }
1.795     www      6827: 
1.861     bisitz   6828: .LC_docs_entry_parameter {
                   6829:   white-space: nowrap;
                   6830: }
                   6831: 
1.544     albertel 6832: .LC_docs_copy {
1.545     albertel 6833:   color: #000099;
1.544     albertel 6834: }
1.795     www      6835: 
1.544     albertel 6836: .LC_docs_cut {
1.545     albertel 6837:   color: #550044;
1.544     albertel 6838: }
1.795     www      6839: 
1.544     albertel 6840: .LC_docs_rename {
1.545     albertel 6841:   color: #009900;
1.544     albertel 6842: }
1.795     www      6843: 
1.544     albertel 6844: .LC_docs_remove {
1.545     albertel 6845:   color: #990000;
                   6846: }
                   6847: 
1.1075.2.134  raeburn  6848: .LC_domprefs_email,
1.547     albertel 6849: .LC_docs_reinit_warn,
                   6850: .LC_docs_ext_edit {
                   6851:   font-size: x-small;
                   6852: }
                   6853: 
1.545     albertel 6854: table.LC_docs_adddocs td,
                   6855: table.LC_docs_adddocs th {
                   6856:   border: 1px solid #BBBBBB;
                   6857:   padding: 4px;
                   6858:   background: #DDDDDD;
1.543     albertel 6859: }
                   6860: 
1.584     albertel 6861: table.LC_sty_begin {
                   6862:   background: #BBFFBB;
                   6863: }
1.795     www      6864: 
1.584     albertel 6865: table.LC_sty_end {
                   6866:   background: #FFBBBB;
                   6867: }
                   6868: 
1.589     raeburn  6869: table.LC_double_column {
1.803     bisitz   6870:   border-width: 0;
1.589     raeburn  6871:   border-collapse: collapse;
                   6872:   width: 100%;
                   6873:   padding: 2px;
                   6874: }
                   6875: 
                   6876: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  6877:   top: 2px;
1.589     raeburn  6878:   left: 2px;
                   6879:   width: 47%;
                   6880:   vertical-align: top;
                   6881: }
                   6882: 
                   6883: table.LC_double_column tr td.LC_right_col {
                   6884:   top: 2px;
1.779     bisitz   6885:   right: 2px;
1.589     raeburn  6886:   width: 47%;
                   6887:   vertical-align: top;
                   6888: }
                   6889: 
1.591     raeburn  6890: div.LC_left_float {
                   6891:   float: left;
                   6892:   padding-right: 5%;
1.597     albertel 6893:   padding-bottom: 4px;
1.591     raeburn  6894: }
                   6895: 
                   6896: div.LC_clear_float_header {
1.597     albertel 6897:   padding-bottom: 2px;
1.591     raeburn  6898: }
                   6899: 
                   6900: div.LC_clear_float_footer {
1.597     albertel 6901:   padding-top: 10px;
1.591     raeburn  6902:   clear: both;
                   6903: }
                   6904: 
1.597     albertel 6905: div.LC_grade_show_user {
1.941     bisitz   6906: /*  border-left: 5px solid $sidebg; */
                   6907:   border-top: 5px solid #000000;
                   6908:   margin: 50px 0 0 0;
1.936     bisitz   6909:   padding: 15px 0 5px 10px;
1.597     albertel 6910: }
1.795     www      6911: 
1.936     bisitz   6912: div.LC_grade_show_user_odd_row {
1.941     bisitz   6913: /*  border-left: 5px solid #000000; */
                   6914: }
                   6915: 
                   6916: div.LC_grade_show_user div.LC_Box {
                   6917:   margin-right: 50px;
1.597     albertel 6918: }
                   6919: 
                   6920: div.LC_grade_submissions,
                   6921: div.LC_grade_message_center,
1.936     bisitz   6922: div.LC_grade_info_links {
1.597     albertel 6923:   margin: 5px;
                   6924:   width: 99%;
                   6925:   background: #FFFFFF;
                   6926: }
1.795     www      6927: 
1.597     albertel 6928: div.LC_grade_submissions_header,
1.936     bisitz   6929: div.LC_grade_message_center_header {
1.705     tempelho 6930:   font-weight: bold;
                   6931:   font-size: large;
1.597     albertel 6932: }
1.795     www      6933: 
1.597     albertel 6934: div.LC_grade_submissions_body,
1.936     bisitz   6935: div.LC_grade_message_center_body {
1.597     albertel 6936:   border: 1px solid black;
                   6937:   width: 99%;
                   6938:   background: #FFFFFF;
                   6939: }
1.795     www      6940: 
1.613     albertel 6941: table.LC_scantron_action {
                   6942:   width: 100%;
                   6943: }
1.795     www      6944: 
1.613     albertel 6945: table.LC_scantron_action tr th {
1.698     harmsja  6946:   font-weight:bold;
                   6947:   font-style:normal;
1.613     albertel 6948: }
1.795     www      6949: 
1.779     bisitz   6950: .LC_edit_problem_header,
1.614     albertel 6951: div.LC_edit_problem_footer {
1.705     tempelho 6952:   font-weight: normal;
                   6953:   font-size:  medium;
1.602     albertel 6954:   margin: 2px;
1.1060    bisitz   6955:   background-color: $sidebg;
1.600     albertel 6956: }
1.795     www      6957: 
1.600     albertel 6958: div.LC_edit_problem_header,
1.602     albertel 6959: div.LC_edit_problem_header div,
1.614     albertel 6960: div.LC_edit_problem_footer,
                   6961: div.LC_edit_problem_footer div,
1.602     albertel 6962: div.LC_edit_problem_editxml_header,
                   6963: div.LC_edit_problem_editxml_header div {
1.1075.2.112  raeburn  6964:   z-index: 100;
1.600     albertel 6965: }
1.795     www      6966: 
1.600     albertel 6967: div.LC_edit_problem_header_title {
1.705     tempelho 6968:   font-weight: bold;
                   6969:   font-size: larger;
1.602     albertel 6970:   background: $tabbg;
                   6971:   padding: 3px;
1.1060    bisitz   6972:   margin: 0 0 5px 0;
1.602     albertel 6973: }
1.795     www      6974: 
1.602     albertel 6975: table.LC_edit_problem_header_title {
                   6976:   width: 100%;
1.600     albertel 6977:   background: $tabbg;
1.602     albertel 6978: }
                   6979: 
1.1075.2.112  raeburn  6980: div.LC_edit_actionbar {
                   6981:     background-color: $sidebg;
                   6982:     margin: 0;
                   6983:     padding: 0;
                   6984:     line-height: 200%;
1.602     albertel 6985: }
1.795     www      6986: 
1.1075.2.112  raeburn  6987: div.LC_edit_actionbar div{
                   6988:     padding: 0;
                   6989:     margin: 0;
                   6990:     display: inline-block;
1.600     albertel 6991: }
1.795     www      6992: 
1.1075.2.34  raeburn  6993: .LC_edit_opt {
                   6994:   padding-left: 1em;
                   6995:   white-space: nowrap;
                   6996: }
                   6997: 
1.1075.2.57  raeburn  6998: .LC_edit_problem_latexhelper{
                   6999:     text-align: right;
                   7000: }
                   7001: 
                   7002: #LC_edit_problem_colorful div{
                   7003:     margin-left: 40px;
                   7004: }
                   7005: 
1.1075.2.112  raeburn  7006: #LC_edit_problem_codemirror div{
                   7007:     margin-left: 0px;
                   7008: }
                   7009: 
1.911     bisitz   7010: img.stift {
1.803     bisitz   7011:   border-width: 0;
                   7012:   vertical-align: middle;
1.677     riegler  7013: }
1.680     riegler  7014: 
1.923     bisitz   7015: table td.LC_mainmenu_col_fieldset {
1.680     riegler  7016:   vertical-align: top;
1.777     tempelho 7017: }
1.795     www      7018: 
1.716     raeburn  7019: div.LC_createcourse {
1.911     bisitz   7020:   margin: 10px 10px 10px 10px;
1.716     raeburn  7021: }
                   7022: 
1.917     raeburn  7023: .LC_dccid {
1.1075.2.38  raeburn  7024:   float: right;
1.917     raeburn  7025:   margin: 0.2em 0 0 0;
                   7026:   padding: 0;
                   7027:   font-size: 90%;
                   7028:   display:none;
                   7029: }
                   7030: 
1.897     wenzelju 7031: ol.LC_primary_menu a:hover,
1.721     harmsja  7032: ol#LC_MenuBreadcrumbs a:hover,
                   7033: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 7034: ul#LC_secondary_menu a:hover,
1.721     harmsja  7035: .LC_FormSectionClearButton input:hover
1.795     www      7036: ul.LC_TabContent   li:hover a {
1.952     onken    7037:   color:$button_hover;
1.911     bisitz   7038:   text-decoration:none;
1.693     droeschl 7039: }
                   7040: 
1.779     bisitz   7041: h1 {
1.911     bisitz   7042:   padding: 0;
                   7043:   line-height:130%;
1.693     droeschl 7044: }
1.698     harmsja  7045: 
1.911     bisitz   7046: h2,
                   7047: h3,
                   7048: h4,
                   7049: h5,
                   7050: h6 {
                   7051:   margin: 5px 0 5px 0;
                   7052:   padding: 0;
                   7053:   line-height:130%;
1.693     droeschl 7054: }
1.795     www      7055: 
                   7056: .LC_hcell {
1.911     bisitz   7057:   padding:3px 15px 3px 15px;
                   7058:   margin: 0;
                   7059:   background-color:$tabbg;
                   7060:   color:$fontmenu;
                   7061:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 7062: }
1.795     www      7063: 
1.840     bisitz   7064: .LC_Box > .LC_hcell {
1.911     bisitz   7065:   margin: 0 -10px 10px -10px;
1.835     bisitz   7066: }
                   7067: 
1.721     harmsja  7068: .LC_noBorder {
1.911     bisitz   7069:   border: 0;
1.698     harmsja  7070: }
1.693     droeschl 7071: 
1.721     harmsja  7072: .LC_FormSectionClearButton input {
1.911     bisitz   7073:   background-color:transparent;
                   7074:   border: none;
                   7075:   cursor:pointer;
                   7076:   text-decoration:underline;
1.693     droeschl 7077: }
1.763     bisitz   7078: 
                   7079: .LC_help_open_topic {
1.911     bisitz   7080:   color: #FFFFFF;
                   7081:   background-color: #EEEEFF;
                   7082:   margin: 1px;
                   7083:   padding: 4px;
                   7084:   border: 1px solid #000033;
                   7085:   white-space: nowrap;
                   7086:   /* vertical-align: middle; */
1.759     neumanie 7087: }
1.693     droeschl 7088: 
1.911     bisitz   7089: dl,
                   7090: ul,
                   7091: div,
                   7092: fieldset {
                   7093:   margin: 10px 10px 10px 0;
                   7094:   /* overflow: hidden; */
1.693     droeschl 7095: }
1.795     www      7096: 
1.1075.2.90  raeburn  7097: article.geogebraweb div {
                   7098:     margin: 0;
                   7099: }
                   7100: 
1.838     bisitz   7101: fieldset > legend {
1.911     bisitz   7102:   font-weight: bold;
                   7103:   padding: 0 5px 0 5px;
1.838     bisitz   7104: }
                   7105: 
1.813     bisitz   7106: #LC_nav_bar {
1.911     bisitz   7107:   float: left;
1.995     raeburn  7108:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   7109:   margin: 0 0 2px 0;
1.807     droeschl 7110: }
                   7111: 
1.916     droeschl 7112: #LC_realm {
                   7113:   margin: 0.2em 0 0 0;
                   7114:   padding: 0;
                   7115:   font-weight: bold;
                   7116:   text-align: center;
1.995     raeburn  7117:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 7118: }
                   7119: 
1.911     bisitz   7120: #LC_nav_bar em {
                   7121:   font-weight: bold;
                   7122:   font-style: normal;
1.807     droeschl 7123: }
                   7124: 
1.897     wenzelju 7125: ol.LC_primary_menu {
1.934     droeschl 7126:   margin: 0;
1.1075.2.2  raeburn  7127:   padding: 0;
1.807     droeschl 7128: }
                   7129: 
1.852     droeschl 7130: ol#LC_PathBreadcrumbs {
1.911     bisitz   7131:   margin: 0;
1.693     droeschl 7132: }
                   7133: 
1.897     wenzelju 7134: ol.LC_primary_menu li {
1.1075.2.2  raeburn  7135:   color: RGB(80, 80, 80);
                   7136:   vertical-align: middle;
                   7137:   text-align: left;
                   7138:   list-style: none;
1.1075.2.112  raeburn  7139:   position: relative;
1.1075.2.2  raeburn  7140:   float: left;
1.1075.2.112  raeburn  7141:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   7142:   line-height: 1.5em;
1.1075.2.2  raeburn  7143: }
                   7144: 
1.1075.2.113  raeburn  7145: ol.LC_primary_menu li a, 
1.1075.2.112  raeburn  7146: ol.LC_primary_menu li p {
1.1075.2.2  raeburn  7147:   display: block;
                   7148:   margin: 0;
                   7149:   padding: 0 5px 0 10px;
                   7150:   text-decoration: none;
                   7151: }
                   7152: 
1.1075.2.112  raeburn  7153: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   7154:   display: inline-block;
                   7155:   width: 95%;
                   7156:   text-align: left;
                   7157: }
                   7158: 
                   7159: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   7160:   display: inline-block;
                   7161:   width: 5%;
                   7162:   float: right;
                   7163:   text-align: right;
                   7164:   font-size: 70%;
                   7165: }
                   7166: 
                   7167: ol.LC_primary_menu ul {
1.1075.2.2  raeburn  7168:   display: none;
1.1075.2.112  raeburn  7169:   width: 15em;
1.1075.2.2  raeburn  7170:   background-color: $data_table_light;
1.1075.2.112  raeburn  7171:   position: absolute;
                   7172:   top: 100%;
                   7173: }
                   7174: 
                   7175: ol.LC_primary_menu ul ul {
                   7176:   left: 100%;
                   7177:   top: 0;
1.1075.2.2  raeburn  7178: }
                   7179: 
1.1075.2.112  raeburn  7180: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2  raeburn  7181:   display: block;
                   7182:   position: absolute;
                   7183:   margin: 0;
                   7184:   padding: 0;
1.1075.2.5  raeburn  7185:   z-index: 2;
1.1075.2.2  raeburn  7186: }
                   7187: 
                   7188: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112  raeburn  7189: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2  raeburn  7190:   font-size: 90%;
1.911     bisitz   7191:   vertical-align: top;
1.1075.2.2  raeburn  7192:   float: none;
1.1075.2.5  raeburn  7193:   border-left: 1px solid black;
                   7194:   border-right: 1px solid black;
1.1075.2.112  raeburn  7195: /* A dark bottom border to visualize different menu options;
                   7196: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7197:   border-bottom: 1px solid $data_table_dark;
1.1075.2.2  raeburn  7198: }
                   7199: 
1.1075.2.112  raeburn  7200: ol.LC_primary_menu li li p:hover {
                   7201:   color:$button_hover;
                   7202:   text-decoration:none;
                   7203:   background-color:$data_table_dark;
1.1075.2.2  raeburn  7204: }
                   7205: 
                   7206: ol.LC_primary_menu li li a:hover {
                   7207:    color:$button_hover;
                   7208:    background-color:$data_table_dark;
1.693     droeschl 7209: }
                   7210: 
1.1075.2.112  raeburn  7211: /* Font-size equal to the size of the predecessors*/
                   7212: ol.LC_primary_menu li:hover li li {
                   7213:   font-size: 100%;
                   7214: }
                   7215: 
1.897     wenzelju 7216: ol.LC_primary_menu li img {
1.911     bisitz   7217:   vertical-align: bottom;
1.934     droeschl 7218:   height: 1.1em;
1.1075.2.3  raeburn  7219:   margin: 0.2em 0 0 0;
1.693     droeschl 7220: }
                   7221: 
1.897     wenzelju 7222: ol.LC_primary_menu a {
1.911     bisitz   7223:   color: RGB(80, 80, 80);
                   7224:   text-decoration: none;
1.693     droeschl 7225: }
1.795     www      7226: 
1.949     droeschl 7227: ol.LC_primary_menu a.LC_new_message {
                   7228:   font-weight:bold;
                   7229:   color: darkred;
                   7230: }
                   7231: 
1.975     raeburn  7232: ol.LC_docs_parameters {
                   7233:   margin-left: 0;
                   7234:   padding: 0;
                   7235:   list-style: none;
                   7236: }
                   7237: 
                   7238: ol.LC_docs_parameters li {
                   7239:   margin: 0;
                   7240:   padding-right: 20px;
                   7241:   display: inline;
                   7242: }
                   7243: 
1.976     raeburn  7244: ol.LC_docs_parameters li:before {
                   7245:   content: "\\002022 \\0020";
                   7246: }
                   7247: 
                   7248: li.LC_docs_parameters_title {
                   7249:   font-weight: bold;
                   7250: }
                   7251: 
                   7252: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7253:   content: "";
                   7254: }
                   7255: 
1.897     wenzelju 7256: ul#LC_secondary_menu {
1.1075.2.23  raeburn  7257:   clear: right;
1.911     bisitz   7258:   color: $fontmenu;
                   7259:   background: $tabbg;
                   7260:   list-style: none;
                   7261:   padding: 0;
                   7262:   margin: 0;
                   7263:   width: 100%;
1.995     raeburn  7264:   text-align: left;
1.1075.2.4  raeburn  7265:   float: left;
1.808     droeschl 7266: }
                   7267: 
1.897     wenzelju 7268: ul#LC_secondary_menu li {
1.911     bisitz   7269:   font-weight: bold;
                   7270:   line-height: 1.8em;
                   7271:   border-right: 1px solid black;
1.1075.2.4  raeburn  7272:   float: left;
                   7273: }
                   7274: 
                   7275: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7276:   background-color: $data_table_light;
                   7277: }
                   7278: 
                   7279: ul#LC_secondary_menu li a {
                   7280:   padding: 0 0.8em;
                   7281: }
                   7282: 
                   7283: ul#LC_secondary_menu li ul {
                   7284:   display: none;
                   7285: }
                   7286: 
                   7287: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7288:   display: block;
                   7289:   position: absolute;
                   7290:   margin: 0;
                   7291:   padding: 0;
                   7292:   list-style:none;
                   7293:   float: none;
                   7294:   background-color: $data_table_light;
1.1075.2.5  raeburn  7295:   z-index: 2;
1.1075.2.10  raeburn  7296:   margin-left: -1px;
1.1075.2.4  raeburn  7297: }
                   7298: 
                   7299: ul#LC_secondary_menu li ul li {
                   7300:   font-size: 90%;
                   7301:   vertical-align: top;
                   7302:   border-left: 1px solid black;
                   7303:   border-right: 1px solid black;
1.1075.2.33  raeburn  7304:   background-color: $data_table_light;
1.1075.2.4  raeburn  7305:   list-style:none;
                   7306:   float: none;
                   7307: }
                   7308: 
                   7309: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7310:   background-color: $data_table_dark;
1.807     droeschl 7311: }
                   7312: 
1.847     tempelho 7313: ul.LC_TabContent {
1.911     bisitz   7314:   display:block;
                   7315:   background: $sidebg;
                   7316:   border-bottom: solid 1px $lg_border_color;
                   7317:   list-style:none;
1.1020    raeburn  7318:   margin: -1px -10px 0 -10px;
1.911     bisitz   7319:   padding: 0;
1.693     droeschl 7320: }
                   7321: 
1.795     www      7322: ul.LC_TabContent li,
                   7323: ul.LC_TabContentBigger li {
1.911     bisitz   7324:   float:left;
1.741     harmsja  7325: }
1.795     www      7326: 
1.897     wenzelju 7327: ul#LC_secondary_menu li a {
1.911     bisitz   7328:   color: $fontmenu;
                   7329:   text-decoration: none;
1.693     droeschl 7330: }
1.795     www      7331: 
1.721     harmsja  7332: ul.LC_TabContent {
1.952     onken    7333:   min-height:20px;
1.721     harmsja  7334: }
1.795     www      7335: 
                   7336: ul.LC_TabContent li {
1.911     bisitz   7337:   vertical-align:middle;
1.959     onken    7338:   padding: 0 16px 0 10px;
1.911     bisitz   7339:   background-color:$tabbg;
                   7340:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7341:   border-left: solid 1px $font;
1.721     harmsja  7342: }
1.795     www      7343: 
1.847     tempelho 7344: ul.LC_TabContent .right {
1.911     bisitz   7345:   float:right;
1.847     tempelho 7346: }
                   7347: 
1.911     bisitz   7348: ul.LC_TabContent li a,
                   7349: ul.LC_TabContent li {
                   7350:   color:rgb(47,47,47);
                   7351:   text-decoration:none;
                   7352:   font-size:95%;
                   7353:   font-weight:bold;
1.952     onken    7354:   min-height:20px;
                   7355: }
                   7356: 
1.959     onken    7357: ul.LC_TabContent li a:hover,
                   7358: ul.LC_TabContent li a:focus {
1.952     onken    7359:   color: $button_hover;
1.959     onken    7360:   background:none;
                   7361:   outline:none;
1.952     onken    7362: }
                   7363: 
                   7364: ul.LC_TabContent li:hover {
                   7365:   color: $button_hover;
                   7366:   cursor:pointer;
1.721     harmsja  7367: }
1.795     www      7368: 
1.911     bisitz   7369: ul.LC_TabContent li.active {
1.952     onken    7370:   color: $font;
1.911     bisitz   7371:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7372:   border-bottom:solid 1px #FFFFFF;
                   7373:   cursor: default;
1.744     ehlerst  7374: }
1.795     www      7375: 
1.959     onken    7376: ul.LC_TabContent li.active a {
                   7377:   color:$font;
                   7378:   background:#FFFFFF;
                   7379:   outline: none;
                   7380: }
1.1047    raeburn  7381: 
                   7382: ul.LC_TabContent li.goback {
                   7383:   float: left;
                   7384:   border-left: none;
                   7385: }
                   7386: 
1.870     tempelho 7387: #maincoursedoc {
1.911     bisitz   7388:   clear:both;
1.870     tempelho 7389: }
                   7390: 
                   7391: ul.LC_TabContentBigger {
1.911     bisitz   7392:   display:block;
                   7393:   list-style:none;
                   7394:   padding: 0;
1.870     tempelho 7395: }
                   7396: 
1.795     www      7397: ul.LC_TabContentBigger li {
1.911     bisitz   7398:   vertical-align:bottom;
                   7399:   height: 30px;
                   7400:   font-size:110%;
                   7401:   font-weight:bold;
                   7402:   color: #737373;
1.841     tempelho 7403: }
                   7404: 
1.957     onken    7405: ul.LC_TabContentBigger li.active {
                   7406:   position: relative;
                   7407:   top: 1px;
                   7408: }
                   7409: 
1.870     tempelho 7410: ul.LC_TabContentBigger li a {
1.911     bisitz   7411:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7412:   height: 30px;
                   7413:   line-height: 30px;
                   7414:   text-align: center;
                   7415:   display: block;
                   7416:   text-decoration: none;
1.958     onken    7417:   outline: none;  
1.741     harmsja  7418: }
1.795     www      7419: 
1.870     tempelho 7420: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7421:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7422:   color:$font;
1.744     ehlerst  7423: }
1.795     www      7424: 
1.870     tempelho 7425: ul.LC_TabContentBigger li b {
1.911     bisitz   7426:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7427:   display: block;
                   7428:   float: left;
                   7429:   padding: 0 30px;
1.957     onken    7430:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7431: }
                   7432: 
1.956     onken    7433: ul.LC_TabContentBigger li:hover b {
                   7434:   color:$button_hover;
                   7435: }
                   7436: 
1.870     tempelho 7437: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7438:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7439:   color:$font;
1.957     onken    7440:   border: 0;
1.741     harmsja  7441: }
1.693     droeschl 7442: 
1.870     tempelho 7443: 
1.862     bisitz   7444: ul.LC_CourseBreadcrumbs {
                   7445:   background: $sidebg;
1.1020    raeburn  7446:   height: 2em;
1.862     bisitz   7447:   padding-left: 10px;
1.1020    raeburn  7448:   margin: 0;
1.862     bisitz   7449:   list-style-position: inside;
                   7450: }
                   7451: 
1.911     bisitz   7452: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7453: ol#LC_PathBreadcrumbs {
1.911     bisitz   7454:   padding-left: 10px;
                   7455:   margin: 0;
1.933     droeschl 7456:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7457: }
                   7458: 
1.911     bisitz   7459: ol#LC_MenuBreadcrumbs li,
                   7460: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7461: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7462:   display: inline;
1.933     droeschl 7463:   white-space: normal;  
1.693     droeschl 7464: }
                   7465: 
1.823     bisitz   7466: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7467: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7468:   text-decoration: none;
                   7469:   font-size:90%;
1.693     droeschl 7470: }
1.795     www      7471: 
1.969     droeschl 7472: ol#LC_MenuBreadcrumbs h1 {
                   7473:   display: inline;
                   7474:   font-size: 90%;
                   7475:   line-height: 2.5em;
                   7476:   margin: 0;
                   7477:   padding: 0;
                   7478: }
                   7479: 
1.795     www      7480: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7481:   text-decoration:none;
                   7482:   font-size:100%;
                   7483:   font-weight:bold;
1.693     droeschl 7484: }
1.795     www      7485: 
1.840     bisitz   7486: .LC_Box {
1.911     bisitz   7487:   border: solid 1px $lg_border_color;
                   7488:   padding: 0 10px 10px 10px;
1.746     neumanie 7489: }
1.795     www      7490: 
1.1020    raeburn  7491: .LC_DocsBox {
                   7492:   border: solid 1px $lg_border_color;
                   7493:   padding: 0 0 10px 10px;
                   7494: }
                   7495: 
1.795     www      7496: .LC_AboutMe_Image {
1.911     bisitz   7497:   float:left;
                   7498:   margin-right:10px;
1.747     neumanie 7499: }
1.795     www      7500: 
                   7501: .LC_Clear_AboutMe_Image {
1.911     bisitz   7502:   clear:left;
1.747     neumanie 7503: }
1.795     www      7504: 
1.721     harmsja  7505: dl.LC_ListStyleClean dt {
1.911     bisitz   7506:   padding-right: 5px;
                   7507:   display: table-header-group;
1.693     droeschl 7508: }
                   7509: 
1.721     harmsja  7510: dl.LC_ListStyleClean dd {
1.911     bisitz   7511:   display: table-row;
1.693     droeschl 7512: }
                   7513: 
1.721     harmsja  7514: .LC_ListStyleClean,
                   7515: .LC_ListStyleSimple,
                   7516: .LC_ListStyleNormal,
1.795     www      7517: .LC_ListStyleSpecial {
1.911     bisitz   7518:   /* display:block; */
                   7519:   list-style-position: inside;
                   7520:   list-style-type: none;
                   7521:   overflow: hidden;
                   7522:   padding: 0;
1.693     droeschl 7523: }
                   7524: 
1.721     harmsja  7525: .LC_ListStyleSimple li,
                   7526: .LC_ListStyleSimple dd,
                   7527: .LC_ListStyleNormal li,
                   7528: .LC_ListStyleNormal dd,
                   7529: .LC_ListStyleSpecial li,
1.795     www      7530: .LC_ListStyleSpecial dd {
1.911     bisitz   7531:   margin: 0;
                   7532:   padding: 5px 5px 5px 10px;
                   7533:   clear: both;
1.693     droeschl 7534: }
                   7535: 
1.721     harmsja  7536: .LC_ListStyleClean li,
                   7537: .LC_ListStyleClean dd {
1.911     bisitz   7538:   padding-top: 0;
                   7539:   padding-bottom: 0;
1.693     droeschl 7540: }
                   7541: 
1.721     harmsja  7542: .LC_ListStyleSimple dd,
1.795     www      7543: .LC_ListStyleSimple li {
1.911     bisitz   7544:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 7545: }
                   7546: 
1.721     harmsja  7547: .LC_ListStyleSpecial li,
                   7548: .LC_ListStyleSpecial dd {
1.911     bisitz   7549:   list-style-type: none;
                   7550:   background-color: RGB(220, 220, 220);
                   7551:   margin-bottom: 4px;
1.693     droeschl 7552: }
                   7553: 
1.721     harmsja  7554: table.LC_SimpleTable {
1.911     bisitz   7555:   margin:5px;
                   7556:   border:solid 1px $lg_border_color;
1.795     www      7557: }
1.693     droeschl 7558: 
1.721     harmsja  7559: table.LC_SimpleTable tr {
1.911     bisitz   7560:   padding: 0;
                   7561:   border:solid 1px $lg_border_color;
1.693     droeschl 7562: }
1.795     www      7563: 
                   7564: table.LC_SimpleTable thead {
1.911     bisitz   7565:   background:rgb(220,220,220);
1.693     droeschl 7566: }
                   7567: 
1.721     harmsja  7568: div.LC_columnSection {
1.911     bisitz   7569:   display: block;
                   7570:   clear: both;
                   7571:   overflow: hidden;
                   7572:   margin: 0;
1.693     droeschl 7573: }
                   7574: 
1.721     harmsja  7575: div.LC_columnSection>* {
1.911     bisitz   7576:   float: left;
                   7577:   margin: 10px 20px 10px 0;
                   7578:   overflow:hidden;
1.693     droeschl 7579: }
1.721     harmsja  7580: 
1.795     www      7581: table em {
1.911     bisitz   7582:   font-weight: bold;
                   7583:   font-style: normal;
1.748     schulted 7584: }
1.795     www      7585: 
1.779     bisitz   7586: table.LC_tableBrowseRes,
1.795     www      7587: table.LC_tableOfContent {
1.911     bisitz   7588:   border:none;
                   7589:   border-spacing: 1px;
                   7590:   padding: 3px;
                   7591:   background-color: #FFFFFF;
                   7592:   font-size: 90%;
1.753     droeschl 7593: }
1.789     droeschl 7594: 
1.911     bisitz   7595: table.LC_tableOfContent {
                   7596:   border-collapse: collapse;
1.789     droeschl 7597: }
                   7598: 
1.771     droeschl 7599: table.LC_tableBrowseRes a,
1.768     schulted 7600: table.LC_tableOfContent a {
1.911     bisitz   7601:   background-color: transparent;
                   7602:   text-decoration: none;
1.753     droeschl 7603: }
                   7604: 
1.795     www      7605: table.LC_tableOfContent img {
1.911     bisitz   7606:   border: none;
                   7607:   height: 1.3em;
                   7608:   vertical-align: text-bottom;
                   7609:   margin-right: 0.3em;
1.753     droeschl 7610: }
1.757     schulted 7611: 
1.795     www      7612: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7613:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7614: }
                   7615: 
1.795     www      7616: a#LC_content_toolbar_everything {
1.911     bisitz   7617:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7618: }
                   7619: 
1.795     www      7620: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7621:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7622: }
                   7623: 
1.795     www      7624: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7625:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7626: }
                   7627: 
1.795     www      7628: a#LC_content_toolbar_changefolder {
1.911     bisitz   7629:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7630: }
                   7631: 
1.795     www      7632: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7633:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7634: }
                   7635: 
1.1043    raeburn  7636: a#LC_content_toolbar_edittoplevel {
                   7637:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7638: }
                   7639: 
1.795     www      7640: ul#LC_toolbar li a:hover {
1.911     bisitz   7641:   background-position: bottom center;
1.757     schulted 7642: }
                   7643: 
1.795     www      7644: ul#LC_toolbar {
1.911     bisitz   7645:   padding: 0;
                   7646:   margin: 2px;
                   7647:   list-style:none;
                   7648:   position:relative;
                   7649:   background-color:white;
1.1075.2.9  raeburn  7650:   overflow: auto;
1.757     schulted 7651: }
                   7652: 
1.795     www      7653: ul#LC_toolbar li {
1.911     bisitz   7654:   border:1px solid white;
                   7655:   padding: 0;
                   7656:   margin: 0;
                   7657:   float: left;
                   7658:   display:inline;
                   7659:   vertical-align:middle;
1.1075.2.9  raeburn  7660:   white-space: nowrap;
1.911     bisitz   7661: }
1.757     schulted 7662: 
1.783     amueller 7663: 
1.795     www      7664: a.LC_toolbarItem {
1.911     bisitz   7665:   display:block;
                   7666:   padding: 0;
                   7667:   margin: 0;
                   7668:   height: 32px;
                   7669:   width: 32px;
                   7670:   color:white;
                   7671:   border: none;
                   7672:   background-repeat:no-repeat;
                   7673:   background-color:transparent;
1.757     schulted 7674: }
                   7675: 
1.915     droeschl 7676: ul.LC_funclist {
                   7677:     margin: 0;
                   7678:     padding: 0.5em 1em 0.5em 0;
                   7679: }
                   7680: 
1.933     droeschl 7681: ul.LC_funclist > li:first-child {
                   7682:     font-weight:bold; 
                   7683:     margin-left:0.8em;
                   7684: }
                   7685: 
1.915     droeschl 7686: ul.LC_funclist + ul.LC_funclist {
                   7687:     /* 
                   7688:        left border as a seperator if we have more than
                   7689:        one list 
                   7690:     */
                   7691:     border-left: 1px solid $sidebg;
                   7692:     /* 
                   7693:        this hides the left border behind the border of the 
                   7694:        outer box if element is wrapped to the next 'line' 
                   7695:     */
                   7696:     margin-left: -1px;
                   7697: }
                   7698: 
1.843     bisitz   7699: ul.LC_funclist li {
1.915     droeschl 7700:   display: inline;
1.782     bisitz   7701:   white-space: nowrap;
1.915     droeschl 7702:   margin: 0 0 0 25px;
                   7703:   line-height: 150%;
1.782     bisitz   7704: }
                   7705: 
1.974     wenzelju 7706: .LC_hidden {
                   7707:   display: none;
                   7708: }
                   7709: 
1.1030    www      7710: .LCmodal-overlay {
                   7711: 		position:fixed;
                   7712: 		top:0;
                   7713: 		right:0;
                   7714: 		bottom:0;
                   7715: 		left:0;
                   7716: 		height:100%;
                   7717: 		width:100%;
                   7718: 		margin:0;
                   7719: 		padding:0;
                   7720: 		background:#999;
                   7721: 		opacity:.75;
                   7722: 		filter: alpha(opacity=75);
                   7723: 		-moz-opacity: 0.75;
                   7724: 		z-index:101;
                   7725: }
                   7726: 
                   7727: * html .LCmodal-overlay {   
                   7728: 		position: absolute;
                   7729: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7730: }
                   7731: 
                   7732: .LCmodal-window {
                   7733: 		position:fixed;
                   7734: 		top:50%;
                   7735: 		left:50%;
                   7736: 		margin:0;
                   7737: 		padding:0;
                   7738: 		z-index:102;
                   7739: 	}
                   7740: 
                   7741: * html .LCmodal-window {
                   7742: 		position:absolute;
                   7743: }
                   7744: 
                   7745: .LCclose-window {
                   7746: 		position:absolute;
                   7747: 		width:32px;
                   7748: 		height:32px;
                   7749: 		right:8px;
                   7750: 		top:8px;
                   7751: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   7752: 		text-indent:-99999px;
                   7753: 		overflow:hidden;
                   7754: 		cursor:pointer;
                   7755: }
                   7756: 
1.1075.2.141  raeburn  7757: pre.LC_wordwrap {
                   7758:   white-space: pre-wrap;
                   7759:   white-space: -moz-pre-wrap;
                   7760:   white-space: -pre-wrap;
                   7761:   white-space: -o-pre-wrap;
                   7762:   word-wrap: break-word;
                   7763: }
                   7764: 
1.1075.2.17  raeburn  7765: /*
                   7766:   styles used by TTH when "Default set of options to pass to tth/m
                   7767:   when converting TeX" in course settings has been set
                   7768: 
                   7769:   option passed: -t
                   7770: 
                   7771: */
                   7772: 
                   7773: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   7774: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   7775: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   7776: td div.norm {line-height:normal;}
                   7777: 
                   7778: /*
                   7779:   option passed -y3
                   7780: */
                   7781: 
                   7782: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   7783: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   7784: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   7785: 
1.1075.2.121  raeburn  7786: #LC_minitab_header {
                   7787:   float:left;
                   7788:   width:100%;
                   7789:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   7790:   font-size:93%;
                   7791:   line-height:normal;
                   7792:   margin: 0.5em 0 0.5em 0;
                   7793: }
                   7794: #LC_minitab_header ul {
                   7795:   margin:0;
                   7796:   padding:10px 10px 0;
                   7797:   list-style:none;
                   7798: }
                   7799: #LC_minitab_header li {
                   7800:   float:left;
                   7801:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   7802:   margin:0;
                   7803:   padding:0 0 0 9px;
                   7804: }
                   7805: #LC_minitab_header a {
                   7806:   display:block;
                   7807:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   7808:   padding:5px 15px 4px 6px;
                   7809: }
                   7810: #LC_minitab_header #LC_current_minitab {
                   7811:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   7812: }
                   7813: #LC_minitab_header #LC_current_minitab a {
                   7814:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   7815:   padding-bottom:5px;
                   7816: }
                   7817: 
                   7818: 
1.343     albertel 7819: END
                   7820: }
                   7821: 
1.306     albertel 7822: =pod
                   7823: 
                   7824: =item * &headtag()
                   7825: 
                   7826: Returns a uniform footer for LON-CAPA web pages.
                   7827: 
1.307     albertel 7828: Inputs: $title - optional title for the head
                   7829:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 7830:         $args - optional arguments
1.319     albertel 7831:             force_register - if is true call registerurl so the remote is 
                   7832:                              informed
1.415     albertel 7833:             redirect       -> array ref of
                   7834:                                    1- seconds before redirect occurs
                   7835:                                    2- url to redirect to
                   7836:                                    3- whether the side effect should occur
1.315     albertel 7837:                            (side effect of setting 
                   7838:                                $env{'internal.head.redirect'} to the url 
                   7839:                                redirected too)
1.352     albertel 7840:             domain         -> force to color decorate a page for a specific
                   7841:                                domain
                   7842:             function       -> force usage of a specific rolish color scheme
                   7843:             bgcolor        -> override the default page bgcolor
1.460     albertel 7844:             no_auto_mt_title
                   7845:                            -> prevent &mt()ing the title arg
1.464     albertel 7846: 
1.306     albertel 7847: =cut
                   7848: 
                   7849: sub headtag {
1.313     albertel 7850:     my ($title,$head_extra,$args) = @_;
1.306     albertel 7851:     
1.363     albertel 7852:     my $function = $args->{'function'} || &get_users_function();
                   7853:     my $domain   = $args->{'domain'}   || &determinedomain();
                   7854:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1075.2.52  raeburn  7855:     my $httphost = $args->{'use_absolute'};
1.418     albertel 7856:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 7857: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 7858: 		   #time(),
1.418     albertel 7859: 		   $env{'environment.color.timestamp'},
1.363     albertel 7860: 		   $function,$domain,$bgcolor);
                   7861: 
1.369     www      7862:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 7863: 
1.308     albertel 7864:     my $result =
                   7865: 	'<head>'.
1.1075.2.56  raeburn  7866: 	&font_settings($args);
1.319     albertel 7867: 
1.1075.2.72  raeburn  7868:     my $inhibitprint;
                   7869:     if ($args->{'print_suppress'}) {
                   7870:         $inhibitprint = &print_suppression();
                   7871:     }
1.1064    raeburn  7872: 
1.461     albertel 7873:     if (!$args->{'frameset'}) {
                   7874: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   7875:     }
1.1075.2.12  raeburn  7876:     if ($args->{'force_register'}) {
                   7877:         $result .= &Apache::lonmenu::registerurl(1);
1.319     albertel 7878:     }
1.436     albertel 7879:     if (!$args->{'no_nav_bar'} 
                   7880: 	&& !$args->{'only_body'}
                   7881: 	&& !$args->{'frameset'}) {
1.1075.2.52  raeburn  7882: 	$result .= &help_menu_js($httphost);
1.1032    www      7883:         $result.=&modal_window();
1.1038    www      7884:         $result.=&togglebox_script();
1.1034    www      7885:         $result.=&wishlist_window();
1.1041    www      7886:         $result.=&LCprogressbarUpdate_script();
1.1034    www      7887:     } else {
                   7888:         if ($args->{'add_modal'}) {
                   7889:            $result.=&modal_window();
                   7890:         }
                   7891:         if ($args->{'add_wishlist'}) {
                   7892:            $result.=&wishlist_window();
                   7893:         }
1.1038    www      7894:         if ($args->{'add_togglebox'}) {
                   7895:            $result.=&togglebox_script();
                   7896:         }
1.1041    www      7897:         if ($args->{'add_progressbar'}) {
                   7898:            $result.=&LCprogressbarUpdate_script();
                   7899:         }
1.436     albertel 7900:     }
1.314     albertel 7901:     if (ref($args->{'redirect'})) {
1.414     albertel 7902: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 7903: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 7904: 	if (!$inhibit_continue) {
                   7905: 	    $env{'internal.head.redirect'} = $url;
                   7906: 	}
1.313     albertel 7907: 	$result.=<<ADDMETA
                   7908: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 7909: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 7910: ADDMETA
1.1075.2.89  raeburn  7911:     } else {
                   7912:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   7913:             my $requrl = $env{'request.uri'};
                   7914:             if ($requrl eq '') {
                   7915:                 $requrl = $ENV{'REQUEST_URI'};
                   7916:                 $requrl =~ s/\?.+$//;
                   7917:             }
                   7918:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   7919:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   7920:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   7921:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   7922:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   7923:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
                   7924:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   7925:                         my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   7926:                         if ($domdefs{'offloadnow'}{$lonhost}) {
                   7927:                             my $newserver = &Apache::lonnet::spareserver(30000,undef,1,$dom_in_use);
                   7928:                             if (($newserver) && ($newserver ne $lonhost)) {
                   7929:                                 my $numsec = 5;
                   7930:                                 my $timeout = $numsec * 1000;
                   7931:                                 my ($newurl,$locknum,%locks,$msg);
                   7932:                                 if ($env{'request.role.adv'}) {
                   7933:                                     ($locknum,%locks) = &Apache::lonnet::get_locks();
                   7934:                                 }
                   7935:                                 my $disable_submit = 0;
                   7936:                                 if ($requrl =~ /$LONCAPA::assess_re/) {
                   7937:                                     $disable_submit = 1;
                   7938:                                 }
                   7939:                                 if ($locknum) {
                   7940:                                     my @lockinfo = sort(values(%locks));
                   7941:                                     $msg = &mt('Once the following tasks are complete: ')."\\n".
                   7942:                                            join(", ",sort(values(%locks)))."\\n".
                   7943:                                            &mt('your session will be transferred to a different server, after you click "Roles".');
                   7944:                                 } else {
                   7945:                                     if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   7946:                                         $msg = &mt('Your LON-CAPA submission has been recorded')."\\n";
                   7947:                                     }
                   7948:                                     $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   7949:                                     $newurl = '/adm/switchserver?otherserver='.$newserver;
                   7950:                                     if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   7951:                                         $newurl .= '&role='.$env{'request.role'};
                   7952:                                     }
                   7953:                                     if ($env{'request.symb'}) {
                   7954:                                         $newurl .= '&symb='.$env{'request.symb'};
                   7955:                                     } else {
                   7956:                                         $newurl .= '&origurl='.$requrl;
                   7957:                                     }
                   7958:                                 }
1.1075.2.98  raeburn  7959:                                 &js_escape(\$msg);
1.1075.2.89  raeburn  7960:                                 $result.=<<OFFLOAD
                   7961: <meta http-equiv="pragma" content="no-cache" />
                   7962: <script type="text/javascript">
1.1075.2.92  raeburn  7963: // <![CDATA[
1.1075.2.89  raeburn  7964: function LC_Offload_Now() {
                   7965:     var dest = "$newurl";
                   7966:     if (dest != '') {
                   7967:         window.location.href="$newurl";
                   7968:     }
                   7969: }
1.1075.2.92  raeburn  7970: \$(document).ready(function () {
                   7971:     window.alert('$msg');
                   7972:     if ($disable_submit) {
1.1075.2.89  raeburn  7973:         \$(".LC_hwk_submit").prop("disabled", true);
                   7974:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92  raeburn  7975:     }
                   7976:     setTimeout('LC_Offload_Now()', $timeout);
                   7977: });
                   7978: // ]]>
1.1075.2.89  raeburn  7979: </script>
                   7980: OFFLOAD
                   7981:                             }
                   7982:                         }
                   7983:                     }
                   7984:                 }
                   7985:             }
                   7986:         }
1.313     albertel 7987:     }
1.306     albertel 7988:     if (!defined($title)) {
                   7989: 	$title = 'The LearningOnline Network with CAPA';
                   7990:     }
1.460     albertel 7991:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   7992:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.1075.2.61  raeburn  7993: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'"';
                   7994:     if (!$args->{'frameset'}) {
                   7995:         $result .= ' /';
                   7996:     }
                   7997:     $result .= '>'
1.1064    raeburn  7998:         .$inhibitprint
1.414     albertel 7999: 	.$head_extra;
1.1075.2.108  raeburn  8000:     my $clientmobile;
                   8001:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   8002:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   8003:     } else {
                   8004:         $clientmobile = $env{'browser.mobile'};
                   8005:     }
                   8006:     if ($clientmobile) {
1.1075.2.42  raeburn  8007:         $result .= '
                   8008: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   8009: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   8010:     }
1.1075.2.126  raeburn  8011:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 8012:     return $result.'</head>';
1.306     albertel 8013: }
                   8014: 
                   8015: =pod
                   8016: 
1.340     albertel 8017: =item * &font_settings()
                   8018: 
                   8019: Returns neccessary <meta> to set the proper encoding
                   8020: 
1.1075.2.56  raeburn  8021: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 8022: 
                   8023: =cut
                   8024: 
                   8025: sub font_settings {
1.1075.2.56  raeburn  8026:     my ($args) = @_;
1.340     albertel 8027:     my $headerstring='';
1.1075.2.56  raeburn  8028:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   8029:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340     albertel 8030: 	$headerstring.=
1.1075.2.61  raeburn  8031: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   8032:         if (!$args->{'frameset'}) {
                   8033:             $headerstring.= ' /';
                   8034:         }
                   8035:         $headerstring .= '>'."\n";
1.340     albertel 8036:     }
                   8037:     return $headerstring;
                   8038: }
                   8039: 
1.341     albertel 8040: =pod
                   8041: 
1.1064    raeburn  8042: =item * &print_suppression()
                   8043: 
                   8044: In course context returns css which causes the body to be blank when media="print",
                   8045: if printout generation is unavailable for the current resource.
                   8046: 
                   8047: This could be because:
                   8048: 
                   8049: (a) printstartdate is in the future
                   8050: 
                   8051: (b) printenddate is in the past
                   8052: 
                   8053: (c) there is an active exam block with "printout"
                   8054: functionality blocked
                   8055: 
                   8056: Users with pav, pfo or evb privileges are exempt.
                   8057: 
                   8058: Inputs: none
                   8059: 
                   8060: =cut
                   8061: 
                   8062: 
                   8063: sub print_suppression {
                   8064:     my $noprint;
                   8065:     if ($env{'request.course.id'}) {
                   8066:         my $scope = $env{'request.course.id'};
                   8067:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8068:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   8069:             return;
                   8070:         }
                   8071:         if ($env{'request.course.sec'} ne '') {
                   8072:             $scope .= "/$env{'request.course.sec'}";
                   8073:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8074:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  8075:                 return;
1.1064    raeburn  8076:             }
                   8077:         }
                   8078:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8079:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.73  raeburn  8080:         my $blocked = &blocking_status('printout',$cnum,$cdom,undef,1);
1.1064    raeburn  8081:         if ($blocked) {
                   8082:             my $checkrole = "cm./$cdom/$cnum";
                   8083:             if ($env{'request.course.sec'} ne '') {
                   8084:                 $checkrole .= "/$env{'request.course.sec'}";
                   8085:             }
                   8086:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   8087:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   8088:                 $noprint = 1;
                   8089:             }
                   8090:         }
                   8091:         unless ($noprint) {
                   8092:             my $symb = &Apache::lonnet::symbread();
                   8093:             if ($symb ne '') {
                   8094:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   8095:                 if (ref($navmap)) {
                   8096:                     my $res = $navmap->getBySymb($symb);
                   8097:                     if (ref($res)) {
                   8098:                         if (!$res->resprintable()) {
                   8099:                             $noprint = 1;
                   8100:                         }
                   8101:                     }
                   8102:                 }
                   8103:             }
                   8104:         }
                   8105:         if ($noprint) {
                   8106:             return <<"ENDSTYLE";
                   8107: <style type="text/css" media="print">
                   8108:     body { display:none }
                   8109: </style>
                   8110: ENDSTYLE
                   8111:         }
                   8112:     }
                   8113:     return;
                   8114: }
                   8115: 
                   8116: =pod
                   8117: 
1.341     albertel 8118: =item * &xml_begin()
                   8119: 
                   8120: Returns the needed doctype and <html>
                   8121: 
                   8122: Inputs: none
                   8123: 
                   8124: =cut
                   8125: 
                   8126: sub xml_begin {
1.1075.2.61  raeburn  8127:     my ($is_frameset) = @_;
1.341     albertel 8128:     my $output='';
                   8129: 
                   8130:     if ($env{'browser.mathml'}) {
                   8131: 	$output='<?xml version="1.0"?>'
                   8132:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   8133: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   8134:             
                   8135: #	    .'<!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">] >'
                   8136: 	    .'<!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">'
                   8137:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   8138: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61  raeburn  8139:     } elsif ($is_frameset) {
                   8140:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   8141:                 '<html>'."\n";
1.341     albertel 8142:     } else {
1.1075.2.61  raeburn  8143: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   8144:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 8145:     }
                   8146:     return $output;
                   8147: }
1.340     albertel 8148: 
                   8149: =pod
                   8150: 
1.306     albertel 8151: =item * &start_page()
                   8152: 
                   8153: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   8154: 
1.648     raeburn  8155: Inputs:
                   8156: 
                   8157: =over 4
                   8158: 
                   8159: $title - optional title for the page
                   8160: 
                   8161: $head_extra - optional extra HTML to incude inside the <head>
                   8162: 
                   8163: $args - additional optional args supported are:
                   8164: 
                   8165: =over 8
                   8166: 
                   8167:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 8168:                                     arg on
1.814     bisitz   8169:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  8170:              add_entries    -> additional attributes to add to the  <body>
                   8171:              domain         -> force to color decorate a page for a 
1.317     albertel 8172:                                     specific domain
1.648     raeburn  8173:              function       -> force usage of a specific rolish color
1.317     albertel 8174:                                     scheme
1.648     raeburn  8175:              redirect       -> see &headtag()
                   8176:              bgcolor        -> override the default page bg color
                   8177:              js_ready       -> return a string ready for being used in 
1.317     albertel 8178:                                     a javascript writeln
1.648     raeburn  8179:              html_encode    -> return a string ready for being used in 
1.320     albertel 8180:                                     a html attribute
1.648     raeburn  8181:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 8182:                                     $forcereg arg
1.648     raeburn  8183:              frameset       -> if true will start with a <frameset>
1.330     albertel 8184:                                     rather than <body>
1.648     raeburn  8185:              skip_phases    -> hash ref of 
1.338     albertel 8186:                                     head -> skip the <html><head> generation
                   8187:                                     body -> skip all <body> generation
1.1075.2.12  raeburn  8188:              no_inline_link -> if true and in remote mode, don't show the
                   8189:                                     'Switch To Inline Menu' link
1.648     raeburn  8190:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 8191:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  8192:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1075.2.123  raeburn  8193:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   8194:                                     to lonhtmlcommon::breadcrumbs
1.1075.2.15  raeburn  8195:              group          -> includes the current group, if page is for a
                   8196:                                specific group
1.1075.2.133  raeburn  8197:              use_absolute   -> for request for external resource or syllabus, this
                   8198:                                will contain https://<hostname> if server uses
                   8199:                                https (as per hosts.tab), but request is for http
                   8200:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.361     albertel 8201: 
1.648     raeburn  8202: =back
1.460     albertel 8203: 
1.648     raeburn  8204: =back
1.562     albertel 8205: 
1.306     albertel 8206: =cut
                   8207: 
                   8208: sub start_page {
1.309     albertel 8209:     my ($title,$head_extra,$args) = @_;
1.318     albertel 8210:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 8211: 
1.315     albertel 8212:     $env{'internal.start_page'}++;
1.1075.2.15  raeburn  8213:     my ($result,@advtools);
1.964     droeschl 8214: 
1.338     albertel 8215:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62  raeburn  8216:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 8217:     }
                   8218:     
                   8219:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   8220: 	if ($args->{'frameset'}) {
                   8221: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   8222: 						$args->{'add_entries'});
                   8223: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8224:         } else {
                   8225:             $result .=
                   8226:                 &bodytag($title, 
                   8227:                          $args->{'function'},       $args->{'add_entries'},
                   8228:                          $args->{'only_body'},      $args->{'domain'},
                   8229:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12  raeburn  8230:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
1.1075.2.15  raeburn  8231:                          $args,                     \@advtools);
1.831     bisitz   8232:         }
1.330     albertel 8233:     }
1.338     albertel 8234: 
1.315     albertel 8235:     if ($args->{'js_ready'}) {
1.713     kaisler  8236: 		$result = &js_ready($result);
1.315     albertel 8237:     }
1.320     albertel 8238:     if ($args->{'html_encode'}) {
1.713     kaisler  8239: 		$result = &html_encode($result);
                   8240:     }
                   8241: 
1.813     bisitz   8242:     # Preparation for new and consistent functionlist at top of screen
                   8243:     # if ($args->{'functionlist'}) {
                   8244:     #            $result .= &build_functionlist();
                   8245:     #}
                   8246: 
1.964     droeschl 8247:     # Don't add anything more if only_body wanted or in const space
                   8248:     return $result if    $args->{'only_body'} 
                   8249:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8250: 
                   8251:     #Breadcrumbs
1.758     kaisler  8252:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   8253: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8254: 		#if any br links exists, add them to the breadcrumbs
                   8255: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8256: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8257: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8258: 			}
                   8259: 		}
1.1075.2.19  raeburn  8260:                 # if @advtools array contains items add then to the breadcrumbs
                   8261:                 if (@advtools > 0) {
                   8262:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8263:                 }
1.1075.2.123  raeburn  8264:                 my $menulink;
                   8265:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   8266:                 if (exists($args->{'bread_crumbs_nomenu'})) {
                   8267:                     $menulink = 0;
                   8268:                 } else {
                   8269:                     undef($menulink);
                   8270:                 }
1.758     kaisler  8271: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8272: 		if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123  raeburn  8273: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.758     kaisler  8274: 		}else{
1.1075.2.123  raeburn  8275: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  8276: 		}
1.1075.2.24  raeburn  8277:     } elsif (($env{'environment.remote'} eq 'on') &&
                   8278:              ($env{'form.inhibitmenu'} ne 'yes') &&
                   8279:              ($env{'request.noversionuri'} =~ m{^/res/}) &&
                   8280:              ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21  raeburn  8281:         $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320     albertel 8282:     }
1.315     albertel 8283:     return $result;
1.306     albertel 8284: }
                   8285: 
                   8286: sub end_page {
1.315     albertel 8287:     my ($args) = @_;
                   8288:     $env{'internal.end_page'}++;
1.330     albertel 8289:     my $result;
1.335     albertel 8290:     if ($args->{'discussion'}) {
                   8291: 	my ($target,$parser);
                   8292: 	if (ref($args->{'discussion'})) {
                   8293: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8294: 				$args->{'discussion'}{'parser'});
                   8295: 	}
                   8296: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8297:     }
1.330     albertel 8298:     if ($args->{'frameset'}) {
                   8299: 	$result .= '</frameset>';
                   8300:     } else {
1.635     raeburn  8301: 	$result .= &endbodytag($args);
1.330     albertel 8302:     }
1.1075.2.6  raeburn  8303:     unless ($args->{'notbody'}) {
                   8304:         $result .= "\n</html>";
                   8305:     }
1.330     albertel 8306: 
1.315     albertel 8307:     if ($args->{'js_ready'}) {
1.317     albertel 8308: 	$result = &js_ready($result);
1.315     albertel 8309:     }
1.335     albertel 8310: 
1.320     albertel 8311:     if ($args->{'html_encode'}) {
                   8312: 	$result = &html_encode($result);
                   8313:     }
1.335     albertel 8314: 
1.315     albertel 8315:     return $result;
                   8316: }
                   8317: 
1.1034    www      8318: sub wishlist_window {
                   8319:     return(<<'ENDWISHLIST');
1.1046    raeburn  8320: <script type="text/javascript">
1.1034    www      8321: // <![CDATA[
                   8322: // <!-- BEGIN LON-CAPA Internal
                   8323: function set_wishlistlink(title, path) {
                   8324:     if (!title) {
                   8325:         title = document.title;
                   8326:         title = title.replace(/^LON-CAPA /,'');
                   8327:     }
1.1075.2.65  raeburn  8328:     title = encodeURIComponent(title);
1.1075.2.83  raeburn  8329:     title = title.replace("'","\\\'");
1.1034    www      8330:     if (!path) {
                   8331:         path = location.pathname;
                   8332:     }
1.1075.2.65  raeburn  8333:     path = encodeURIComponent(path);
1.1075.2.83  raeburn  8334:     path = path.replace("'","\\\'");
1.1034    www      8335:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   8336:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   8337: }
                   8338: // END LON-CAPA Internal -->
                   8339: // ]]>
                   8340: </script>
                   8341: ENDWISHLIST
                   8342: }
                   8343: 
1.1030    www      8344: sub modal_window {
                   8345:     return(<<'ENDMODAL');
1.1046    raeburn  8346: <script type="text/javascript">
1.1030    www      8347: // <![CDATA[
                   8348: // <!-- BEGIN LON-CAPA Internal
                   8349: var modalWindow = {
                   8350: 	parent:"body",
                   8351: 	windowId:null,
                   8352: 	content:null,
                   8353: 	width:null,
                   8354: 	height:null,
                   8355: 	close:function()
                   8356: 	{
                   8357: 	        $(".LCmodal-window").remove();
                   8358: 	        $(".LCmodal-overlay").remove();
                   8359: 	},
                   8360: 	open:function()
                   8361: 	{
                   8362: 		var modal = "";
                   8363: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   8364: 		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;\">";
                   8365: 		modal += this.content;
                   8366: 		modal += "</div>";	
                   8367: 
                   8368: 		$(this.parent).append(modal);
                   8369: 
                   8370: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   8371: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   8372: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   8373: 	}
                   8374: };
1.1075.2.42  raeburn  8375: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      8376: 	{
1.1075.2.119  raeburn  8377:                 source = source.replace(/'/g,"&#39;");
1.1030    www      8378: 		modalWindow.windowId = "myModal";
                   8379: 		modalWindow.width = width;
                   8380: 		modalWindow.height = height;
1.1075.2.80  raeburn  8381: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      8382: 		modalWindow.open();
1.1075.2.87  raeburn  8383: 	};
1.1030    www      8384: // END LON-CAPA Internal -->
                   8385: // ]]>
                   8386: </script>
                   8387: ENDMODAL
                   8388: }
                   8389: 
                   8390: sub modal_link {
1.1075.2.42  raeburn  8391:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      8392:     unless ($width) { $width=480; }
                   8393:     unless ($height) { $height=400; }
1.1031    www      8394:     unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42  raeburn  8395:     unless ($transparency) { $transparency='true'; }
                   8396: 
1.1074    raeburn  8397:     my $target_attr;
                   8398:     if (defined($target)) {
                   8399:         $target_attr = 'target="'.$target.'"';
                   8400:     }
                   8401:     return <<"ENDLINK";
1.1075.2.143! raeburn  8402: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  8403: ENDLINK
1.1030    www      8404: }
                   8405: 
1.1032    www      8406: sub modal_adhoc_script {
                   8407:     my ($funcname,$width,$height,$content)=@_;
                   8408:     return (<<ENDADHOC);
1.1046    raeburn  8409: <script type="text/javascript">
1.1032    www      8410: // <![CDATA[
                   8411:         var $funcname = function()
                   8412:         {
                   8413:                 modalWindow.windowId = "myModal";
                   8414:                 modalWindow.width = $width;
                   8415:                 modalWindow.height = $height;
                   8416:                 modalWindow.content = '$content';
                   8417:                 modalWindow.open();
                   8418:         };  
                   8419: // ]]>
                   8420: </script>
                   8421: ENDADHOC
                   8422: }
                   8423: 
1.1041    www      8424: sub modal_adhoc_inner {
                   8425:     my ($funcname,$width,$height,$content)=@_;
                   8426:     my $innerwidth=$width-20;
                   8427:     $content=&js_ready(
1.1042    www      8428:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  8429:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8430:                  $content.
1.1041    www      8431:                  &end_scrollbox().
1.1075.2.42  raeburn  8432:                  &end_page()
1.1041    www      8433:              );
                   8434:     return &modal_adhoc_script($funcname,$width,$height,$content);
                   8435: }
                   8436: 
                   8437: sub modal_adhoc_window {
                   8438:     my ($funcname,$width,$height,$content,$linktext)=@_;
                   8439:     return &modal_adhoc_inner($funcname,$width,$height,$content).
                   8440:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8441: }
                   8442: 
                   8443: sub modal_adhoc_launch {
                   8444:     my ($funcname,$width,$height,$content)=@_;
                   8445:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8446: <script type="text/javascript">
                   8447: // <![CDATA[
                   8448: $funcname();
                   8449: // ]]>
                   8450: </script>
                   8451: ENDLAUNCH
                   8452: }
                   8453: 
                   8454: sub modal_adhoc_close {
                   8455:     return (<<ENDCLOSE);
                   8456: <script type="text/javascript">
                   8457: // <![CDATA[
                   8458: modalWindow.close();
                   8459: // ]]>
                   8460: </script>
                   8461: ENDCLOSE
                   8462: }
                   8463: 
1.1038    www      8464: sub togglebox_script {
                   8465:    return(<<ENDTOGGLE);
                   8466: <script type="text/javascript"> 
                   8467: // <![CDATA[
                   8468: function LCtoggleDisplay(id,hidetext,showtext) {
                   8469:    link = document.getElementById(id + "link").childNodes[0];
                   8470:    with (document.getElementById(id).style) {
                   8471:       if (display == "none" ) {
                   8472:           display = "inline";
                   8473:           link.nodeValue = hidetext;
                   8474:         } else {
                   8475:           display = "none";
                   8476:           link.nodeValue = showtext;
                   8477:        }
                   8478:    }
                   8479: }
                   8480: // ]]>
                   8481: </script>
                   8482: ENDTOGGLE
                   8483: }
                   8484: 
1.1039    www      8485: sub start_togglebox {
                   8486:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   8487:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   8488:     unless ($showtext) { $showtext=&mt('show'); }
                   8489:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   8490:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   8491:     return &start_data_table().
                   8492:            &start_data_table_header_row().
                   8493:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   8494:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   8495:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   8496:            &end_data_table_header_row().
                   8497:            '<tr id="'.$id.'" style="display:none""><td>';
                   8498: }
                   8499: 
                   8500: sub end_togglebox {
                   8501:     return '</td></tr>'.&end_data_table();
                   8502: }
                   8503: 
1.1041    www      8504: sub LCprogressbar_script {
1.1075.2.130  raeburn  8505:    my ($id,$number_to_do)=@_;
                   8506:    if ($number_to_do) {
                   8507:        return(<<ENDPROGRESS);
1.1041    www      8508: <script type="text/javascript">
                   8509: // <![CDATA[
1.1045    www      8510: \$('#progressbar$id').progressbar({
1.1041    www      8511:   value: 0,
                   8512:   change: function(event, ui) {
                   8513:     var newVal = \$(this).progressbar('option', 'value');
                   8514:     \$('.pblabel', this).text(LCprogressTxt);
                   8515:   }
                   8516: });
                   8517: // ]]>
                   8518: </script>
                   8519: ENDPROGRESS
1.1075.2.130  raeburn  8520:    } else {
                   8521:        return(<<ENDPROGRESS);
                   8522: <script type="text/javascript">
                   8523: // <![CDATA[
                   8524: \$('#progressbar$id').progressbar({
                   8525:   value: false,
                   8526:   create: function(event, ui) {
                   8527:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   8528:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   8529:   }
                   8530: });
                   8531: // ]]>
                   8532: </script>
                   8533: ENDPROGRESS
                   8534:    }
1.1041    www      8535: }
                   8536: 
                   8537: sub LCprogressbarUpdate_script {
                   8538:    return(<<ENDPROGRESSUPDATE);
                   8539: <style type="text/css">
                   8540: .ui-progressbar { position:relative; }
1.1075.2.130  raeburn  8541: .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      8542: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   8543: </style>
                   8544: <script type="text/javascript">
                   8545: // <![CDATA[
1.1045    www      8546: var LCprogressTxt='---';
                   8547: 
1.1075.2.130  raeburn  8548: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      8549:    LCprogressTxt=progresstext;
1.1075.2.130  raeburn  8550:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   8551:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   8552:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
                   8553:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   8554:    } else {
                   8555:        \$('#progressbar'+id).progressbar('value',percent);
                   8556:    }
1.1041    www      8557: }
                   8558: // ]]>
                   8559: </script>
                   8560: ENDPROGRESSUPDATE
                   8561: }
                   8562: 
1.1042    www      8563: my $LClastpercent;
1.1045    www      8564: my $LCidcnt;
                   8565: my $LCcurrentid;
1.1042    www      8566: 
1.1041    www      8567: sub LCprogressbar {
1.1075.2.130  raeburn  8568:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      8569:     $LClastpercent=0;
1.1045    www      8570:     $LCidcnt++;
                   8571:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130  raeburn  8572:     my ($starting,$content);
                   8573:     if ($number_to_do) {
                   8574:         $starting=&mt('Starting');
                   8575:         $content=(<<ENDPROGBAR);
                   8576: $preamble
1.1045    www      8577:   <div id="progressbar$LCcurrentid">
1.1041    www      8578:     <span class="pblabel">$starting</span>
                   8579:   </div>
                   8580: ENDPROGBAR
1.1075.2.130  raeburn  8581:     } else {
                   8582:         $starting=&mt('Loading...');
                   8583:         $LClastpercent='false';
                   8584:         $content=(<<ENDPROGBAR);
                   8585: $preamble
                   8586:   <div id="progressbar$LCcurrentid">
                   8587:       <div class="progress-label">$starting</div>
                   8588:   </div>
                   8589: ENDPROGBAR
                   8590:     }
                   8591:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      8592: }
                   8593: 
                   8594: sub LCprogressbarUpdate {
1.1075.2.130  raeburn  8595:     my ($r,$val,$text,$number_to_do)=@_;
                   8596:     if ($number_to_do) {
                   8597:         unless ($val) { 
                   8598:             if ($LClastpercent) {
                   8599:                 $val=$LClastpercent;
                   8600:             } else {
                   8601:                 $val=0;
                   8602:             }
                   8603:         }
                   8604:         if ($val<0) { $val=0; }
                   8605:         if ($val>100) { $val=0; }
                   8606:         $LClastpercent=$val;
                   8607:         unless ($text) { $text=$val.'%'; }
                   8608:     } else {
                   8609:         $val = 'false';
1.1042    www      8610:     }
1.1041    www      8611:     $text=&js_ready($text);
1.1044    www      8612:     &r_print($r,<<ENDUPDATE);
1.1041    www      8613: <script type="text/javascript">
                   8614: // <![CDATA[
1.1075.2.130  raeburn  8615: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      8616: // ]]>
                   8617: </script>
                   8618: ENDUPDATE
1.1035    www      8619: }
                   8620: 
1.1042    www      8621: sub LCprogressbarClose {
                   8622:     my ($r)=@_;
                   8623:     $LClastpercent=0;
1.1044    www      8624:     &r_print($r,<<ENDCLOSE);
1.1042    www      8625: <script type="text/javascript">
                   8626: // <![CDATA[
1.1045    www      8627: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      8628: // ]]>
                   8629: </script>
                   8630: ENDCLOSE
1.1044    www      8631: }
                   8632: 
                   8633: sub r_print {
                   8634:     my ($r,$to_print)=@_;
                   8635:     if ($r) {
                   8636:       $r->print($to_print);
                   8637:       $r->rflush();
                   8638:     } else {
                   8639:       print($to_print);
                   8640:     }
1.1042    www      8641: }
                   8642: 
1.320     albertel 8643: sub html_encode {
                   8644:     my ($result) = @_;
                   8645: 
1.322     albertel 8646:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 8647:     
                   8648:     return $result;
                   8649: }
1.1044    www      8650: 
1.317     albertel 8651: sub js_ready {
                   8652:     my ($result) = @_;
                   8653: 
1.323     albertel 8654:     $result =~ s/[\n\r]/ /xmsg;
                   8655:     $result =~ s/\\/\\\\/xmsg;
                   8656:     $result =~ s/'/\\'/xmsg;
1.372     albertel 8657:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 8658:     
                   8659:     return $result;
                   8660: }
                   8661: 
1.315     albertel 8662: sub validate_page {
                   8663:     if (  exists($env{'internal.start_page'})
1.316     albertel 8664: 	  &&     $env{'internal.start_page'} > 1) {
                   8665: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 8666: 				 $env{'internal.start_page'}.' '.
1.316     albertel 8667: 				 $ENV{'request.filename'});
1.315     albertel 8668:     }
                   8669:     if (  exists($env{'internal.end_page'})
1.316     albertel 8670: 	  &&     $env{'internal.end_page'} > 1) {
                   8671: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 8672: 				 $env{'internal.end_page'}.' '.
1.316     albertel 8673: 				 $env{'request.filename'});
1.315     albertel 8674:     }
                   8675:     if (     exists($env{'internal.start_page'})
                   8676: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 8677: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   8678: 				 $env{'request.filename'});
1.315     albertel 8679:     }
                   8680:     if (   ! exists($env{'internal.start_page'})
                   8681: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 8682: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   8683: 				 $env{'request.filename'});
1.315     albertel 8684:     }
1.306     albertel 8685: }
1.315     albertel 8686: 
1.996     www      8687: 
                   8688: sub start_scrollbox {
1.1075.2.56  raeburn  8689:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  8690:     unless ($outerwidth) { $outerwidth='520px'; }
                   8691:     unless ($width) { $width='500px'; }
                   8692:     unless ($height) { $height='200px'; }
1.1075    raeburn  8693:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  8694:     if ($id ne '') {
1.1075.2.42  raeburn  8695:         $table_id = ' id="table_'.$id.'"';
                   8696:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  8697:     }
1.1075    raeburn  8698:     if ($bgcolor ne '') {
                   8699:         $tdcol = "background-color: $bgcolor;";
                   8700:     }
1.1075.2.42  raeburn  8701:     my $nicescroll_js;
                   8702:     if ($env{'browser.mobile'}) {
                   8703:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   8704:     }
1.1075    raeburn  8705:     return <<"END";
1.1075.2.42  raeburn  8706: $nicescroll_js
                   8707: 
                   8708: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  8709: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  8710: END
1.996     www      8711: }
                   8712: 
                   8713: sub end_scrollbox {
1.1036    www      8714:     return '</div></td></tr></table>';
1.996     www      8715: }
                   8716: 
1.1075.2.42  raeburn  8717: sub nicescroll_javascript {
                   8718:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   8719:     my %options;
                   8720:     if (ref($cursor) eq 'HASH') {
                   8721:         %options = %{$cursor};
                   8722:     }
                   8723:     unless ($options{'railalign'} =~ /^left|right$/) {
                   8724:         $options{'railalign'} = 'left';
                   8725:     }
                   8726:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8727:         my $function  = &get_users_function();
                   8728:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   8729:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   8730:             $options{'cursorcolor'} = '#00F';
                   8731:         }
                   8732:     }
                   8733:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   8734:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   8735:             $options{'cursoropacity'}='1.0';
                   8736:         }
                   8737:     } else {
                   8738:         $options{'cursoropacity'}='1.0';
                   8739:     }
                   8740:     if ($options{'cursorfixedheight'} eq 'none') {
                   8741:         delete($options{'cursorfixedheight'});
                   8742:     } else {
                   8743:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   8744:     }
                   8745:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   8746:         delete($options{'railoffset'});
                   8747:     }
                   8748:     my @niceoptions;
                   8749:     while (my($key,$value) = each(%options)) {
                   8750:         if ($value =~ /^\{.+\}$/) {
                   8751:             push(@niceoptions,$key.':'.$value);
                   8752:         } else {
                   8753:             push(@niceoptions,$key.':"'.$value.'"');
                   8754:         }
                   8755:     }
                   8756:     my $nicescroll_js = '
                   8757: $(document).ready(
                   8758:       function() {
                   8759:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   8760:       }
                   8761: );
                   8762: ';
                   8763:     if ($framecheck) {
                   8764:         $nicescroll_js .= '
                   8765: function expand_div(caller) {
                   8766:     if (top === self) {
                   8767:         document.getElementById("'.$id.'").style.width = "auto";
                   8768:         document.getElementById("'.$id.'").style.height = "auto";
                   8769:     } else {
                   8770:         try {
                   8771:             if (parent.frames) {
                   8772:                 if (parent.frames.length > 1) {
                   8773:                     var framesrc = parent.frames[1].location.href;
                   8774:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   8775:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   8776:                         document.getElementById("'.$id.'").style.width = "auto";
                   8777:                         document.getElementById("'.$id.'").style.height = "auto";
                   8778:                     }
                   8779:                 }
                   8780:             }
                   8781:         } catch (e) {
                   8782:             return;
                   8783:         }
                   8784:     }
                   8785:     return;
                   8786: }
                   8787: ';
                   8788:     }
                   8789:     if ($needjsready) {
                   8790:         $nicescroll_js = '
                   8791: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   8792:     } else {
                   8793:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   8794:     }
                   8795:     return $nicescroll_js;
                   8796: }
                   8797: 
1.318     albertel 8798: sub simple_error_page {
1.1075.2.49  raeburn  8799:     my ($r,$title,$msg,$args) = @_;
                   8800:     if (ref($args) eq 'HASH') {
                   8801:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   8802:     } else {
                   8803:         $msg = &mt($msg);
                   8804:     }
                   8805: 
1.318     albertel 8806:     my $page =
                   8807: 	&Apache::loncommon::start_page($title).
1.1075.2.49  raeburn  8808: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 8809: 	&Apache::loncommon::end_page();
                   8810:     if (ref($r)) {
                   8811: 	$r->print($page);
1.327     albertel 8812: 	return;
1.318     albertel 8813:     }
                   8814:     return $page;
                   8815: }
1.347     albertel 8816: 
                   8817: {
1.610     albertel 8818:     my @row_count;
1.961     onken    8819: 
                   8820:     sub start_data_table_count {
                   8821:         unshift(@row_count, 0);
                   8822:         return;
                   8823:     }
                   8824: 
                   8825:     sub end_data_table_count {
                   8826:         shift(@row_count);
                   8827:         return;
                   8828:     }
                   8829: 
1.347     albertel 8830:     sub start_data_table {
1.1018    raeburn  8831: 	my ($add_class,$id) = @_;
1.422     albertel 8832: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  8833:         my $table_id;
                   8834:         if (defined($id)) {
                   8835:             $table_id = ' id="'.$id.'"';
                   8836:         }
1.961     onken    8837: 	&start_data_table_count();
1.1018    raeburn  8838: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 8839:     }
                   8840: 
                   8841:     sub end_data_table {
1.961     onken    8842: 	&end_data_table_count();
1.389     albertel 8843: 	return '</table>'."\n";;
1.347     albertel 8844:     }
                   8845: 
                   8846:     sub start_data_table_row {
1.974     wenzelju 8847: 	my ($add_class, $id) = @_;
1.610     albertel 8848: 	$row_count[0]++;
                   8849: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   8850: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 8851:         $id = (' id="'.$id.'"') unless ($id eq '');
                   8852:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 8853:     }
1.471     banghart 8854:     
                   8855:     sub continue_data_table_row {
1.974     wenzelju 8856: 	my ($add_class, $id) = @_;
1.610     albertel 8857: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 8858: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   8859:         $id = (' id="'.$id.'"') unless ($id eq '');
                   8860:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 8861:     }
1.347     albertel 8862: 
                   8863:     sub end_data_table_row {
1.389     albertel 8864: 	return '</tr>'."\n";;
1.347     albertel 8865:     }
1.367     www      8866: 
1.421     albertel 8867:     sub start_data_table_empty_row {
1.707     bisitz   8868: #	$row_count[0]++;
1.421     albertel 8869: 	return  '<tr class="LC_empty_row" >'."\n";;
                   8870:     }
                   8871: 
                   8872:     sub end_data_table_empty_row {
                   8873: 	return '</tr>'."\n";;
                   8874:     }
                   8875: 
1.367     www      8876:     sub start_data_table_header_row {
1.389     albertel 8877: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      8878:     }
                   8879: 
                   8880:     sub end_data_table_header_row {
1.389     albertel 8881: 	return '</tr>'."\n";;
1.367     www      8882:     }
1.890     droeschl 8883: 
                   8884:     sub data_table_caption {
                   8885:         my $caption = shift;
                   8886:         return "<caption class=\"LC_caption\">$caption</caption>";
                   8887:     }
1.347     albertel 8888: }
                   8889: 
1.548     albertel 8890: =pod
                   8891: 
                   8892: =item * &inhibit_menu_check($arg)
                   8893: 
                   8894: Checks for a inhibitmenu state and generates output to preserve it
                   8895: 
                   8896: Inputs:         $arg - can be any of
                   8897:                      - undef - in which case the return value is a string 
                   8898:                                to add  into arguments list of a uri
                   8899:                      - 'input' - in which case the return value is a HTML
                   8900:                                  <form> <input> field of type hidden to
                   8901:                                  preserve the value
                   8902:                      - a url - in which case the return value is the url with
                   8903:                                the neccesary cgi args added to preserve the
                   8904:                                inhibitmenu state
                   8905:                      - a ref to a url - no return value, but the string is
                   8906:                                         updated to include the neccessary cgi
                   8907:                                         args to preserve the inhibitmenu state
                   8908: 
                   8909: =cut
                   8910: 
                   8911: sub inhibit_menu_check {
                   8912:     my ($arg) = @_;
                   8913:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   8914:     if ($arg eq 'input') {
                   8915: 	if ($env{'form.inhibitmenu'}) {
                   8916: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   8917: 	} else {
                   8918: 	    return
                   8919: 	}
                   8920:     }
                   8921:     if ($env{'form.inhibitmenu'}) {
                   8922: 	if (ref($arg)) {
                   8923: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   8924: 	} elsif ($arg eq '') {
                   8925: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   8926: 	} else {
                   8927: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   8928: 	}
                   8929:     }
                   8930:     if (!ref($arg)) {
                   8931: 	return $arg;
                   8932:     }
                   8933: }
                   8934: 
1.251     albertel 8935: ###############################################
1.182     matthew  8936: 
                   8937: =pod
                   8938: 
1.549     albertel 8939: =back
                   8940: 
                   8941: =head1 User Information Routines
                   8942: 
                   8943: =over 4
                   8944: 
1.405     albertel 8945: =item * &get_users_function()
1.182     matthew  8946: 
                   8947: Used by &bodytag to determine the current users primary role.
                   8948: Returns either 'student','coordinator','admin', or 'author'.
                   8949: 
                   8950: =cut
                   8951: 
                   8952: ###############################################
                   8953: sub get_users_function {
1.815     tempelho 8954:     my $function = 'norole';
1.818     tempelho 8955:     if ($env{'request.role'}=~/^(st)/) {
                   8956:         $function='student';
                   8957:     }
1.907     raeburn  8958:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  8959:         $function='coordinator';
                   8960:     }
1.258     albertel 8961:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  8962:         $function='admin';
                   8963:     }
1.826     bisitz   8964:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  8965:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  8966:         $function='author';
                   8967:     }
                   8968:     return $function;
1.54      www      8969: }
1.99      www      8970: 
                   8971: ###############################################
                   8972: 
1.233     raeburn  8973: =pod
                   8974: 
1.821     raeburn  8975: =item * &show_course()
                   8976: 
                   8977: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   8978: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   8979: 
                   8980: Inputs:
                   8981: None
                   8982: 
                   8983: Outputs:
                   8984: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   8985: 
                   8986: =cut
                   8987: 
                   8988: ###############################################
                   8989: sub show_course {
                   8990:     my $course = !$env{'user.adv'};
                   8991:     if (!$env{'user.adv'}) {
                   8992:         foreach my $env (keys(%env)) {
                   8993:             next if ($env !~ m/^user\.priv\./);
                   8994:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   8995:                 $course = 0;
                   8996:                 last;
                   8997:             }
                   8998:         }
                   8999:     }
                   9000:     return $course;
                   9001: }
                   9002: 
                   9003: ###############################################
                   9004: 
                   9005: =pod
                   9006: 
1.542     raeburn  9007: =item * &check_user_status()
1.274     raeburn  9008: 
                   9009: Determines current status of supplied role for a
                   9010: specific user. Roles can be active, previous or future.
                   9011: 
                   9012: Inputs: 
                   9013: user's domain, user's username, course's domain,
1.375     raeburn  9014: course's number, optional section ID.
1.274     raeburn  9015: 
                   9016: Outputs:
                   9017: role status: active, previous or future. 
                   9018: 
                   9019: =cut
                   9020: 
                   9021: sub check_user_status {
1.412     raeburn  9022:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  9023:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  9024:     my @uroles = keys(%userinfo);
1.274     raeburn  9025:     my $srchstr;
                   9026:     my $active_chk = 'none';
1.412     raeburn  9027:     my $now = time;
1.274     raeburn  9028:     if (@uroles > 0) {
1.908     raeburn  9029:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  9030:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   9031:         } else {
1.412     raeburn  9032:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   9033:         }
                   9034:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  9035:             my $role_end = 0;
                   9036:             my $role_start = 0;
                   9037:             $active_chk = 'active';
1.412     raeburn  9038:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   9039:                 $role_end = $1;
                   9040:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   9041:                     $role_start = $1;
1.274     raeburn  9042:                 }
                   9043:             }
                   9044:             if ($role_start > 0) {
1.412     raeburn  9045:                 if ($now < $role_start) {
1.274     raeburn  9046:                     $active_chk = 'future';
                   9047:                 }
                   9048:             }
                   9049:             if ($role_end > 0) {
1.412     raeburn  9050:                 if ($now > $role_end) {
1.274     raeburn  9051:                     $active_chk = 'previous';
                   9052:                 }
                   9053:             }
                   9054:         }
                   9055:     }
                   9056:     return $active_chk;
                   9057: }
                   9058: 
                   9059: ###############################################
                   9060: 
                   9061: =pod
                   9062: 
1.405     albertel 9063: =item * &get_sections()
1.233     raeburn  9064: 
                   9065: Determines all the sections for a course including
                   9066: sections with students and sections containing other roles.
1.419     raeburn  9067: Incoming parameters: 
                   9068: 
                   9069: 1. domain
                   9070: 2. course number 
                   9071: 3. reference to array containing roles for which sections should 
                   9072: be gathered (optional).
                   9073: 4. reference to array containing status types for which sections 
                   9074: should be gathered (optional).
                   9075: 
                   9076: If the third argument is undefined, sections are gathered for any role. 
                   9077: If the fourth argument is undefined, sections are gathered for any status.
                   9078: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  9079:  
1.374     raeburn  9080: Returns section hash (keys are section IDs, values are
                   9081: number of users in each section), subject to the
1.419     raeburn  9082: optional roles filter, optional status filter 
1.233     raeburn  9083: 
                   9084: =cut
                   9085: 
                   9086: ###############################################
                   9087: sub get_sections {
1.419     raeburn  9088:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 9089:     if (!defined($cdom) || !defined($cnum)) {
                   9090:         my $cid =  $env{'request.course.id'};
                   9091: 
                   9092: 	return if (!defined($cid));
                   9093: 
                   9094:         $cdom = $env{'course.'.$cid.'.domain'};
                   9095:         $cnum = $env{'course.'.$cid.'.num'};
                   9096:     }
                   9097: 
                   9098:     my %sectioncount;
1.419     raeburn  9099:     my $now = time;
1.240     albertel 9100: 
1.1075.2.33  raeburn  9101:     my $check_students = 1;
                   9102:     my $only_students = 0;
                   9103:     if (ref($possible_roles) eq 'ARRAY') {
                   9104:         if (grep(/^st$/,@{$possible_roles})) {
                   9105:             if (@{$possible_roles} == 1) {
                   9106:                 $only_students = 1;
                   9107:             }
                   9108:         } else {
                   9109:             $check_students = 0;
                   9110:         }
                   9111:     }
                   9112: 
                   9113:     if ($check_students) {
1.276     albertel 9114: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 9115: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   9116: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  9117:         my $start_index = &Apache::loncoursedata::CL_START();
                   9118:         my $end_index = &Apache::loncoursedata::CL_END();
                   9119:         my $status;
1.366     albertel 9120: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  9121: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   9122: 				                     $data->[$status_index],
                   9123:                                                      $data->[$start_index],
                   9124:                                                      $data->[$end_index]);
                   9125:             if ($stu_status eq 'Active') {
                   9126:                 $status = 'active';
                   9127:             } elsif ($end < $now) {
                   9128:                 $status = 'previous';
                   9129:             } elsif ($start > $now) {
                   9130:                 $status = 'future';
                   9131:             } 
                   9132: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   9133:                 if ((!defined($possible_status)) || (($status ne '') && 
                   9134:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   9135: 		    $sectioncount{$section}++;
                   9136:                 }
1.240     albertel 9137: 	    }
                   9138: 	}
                   9139:     }
1.1075.2.33  raeburn  9140:     if ($only_students) {
                   9141:         return %sectioncount;
                   9142:     }
1.240     albertel 9143:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9144:     foreach my $user (sort(keys(%courseroles))) {
                   9145: 	if ($user !~ /^(\w{2})/) { next; }
                   9146: 	my ($role) = ($user =~ /^(\w{2})/);
                   9147: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9148: 	my ($section,$status);
1.240     albertel 9149: 	if ($role eq 'cr' &&
                   9150: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9151: 	    $section=$1;
                   9152: 	}
                   9153: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9154: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9155:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9156:         if ($end == -1 && $start == -1) {
                   9157:             next; #deleted role
                   9158:         }
                   9159:         if (!defined($possible_status)) { 
                   9160:             $sectioncount{$section}++;
                   9161:         } else {
                   9162:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9163:                 $status = 'active';
                   9164:             } elsif ($end < $now) {
                   9165:                 $status = 'future';
                   9166:             } elsif ($start > $now) {
                   9167:                 $status = 'previous';
                   9168:             }
                   9169:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9170:                 $sectioncount{$section}++;
                   9171:             }
                   9172:         }
1.233     raeburn  9173:     }
1.366     albertel 9174:     return %sectioncount;
1.233     raeburn  9175: }
                   9176: 
1.274     raeburn  9177: ###############################################
1.294     raeburn  9178: 
                   9179: =pod
1.405     albertel 9180: 
                   9181: =item * &get_course_users()
                   9182: 
1.275     raeburn  9183: Retrieves usernames:domains for users in the specified course
                   9184: with specific role(s), and access status. 
                   9185: 
                   9186: Incoming parameters:
1.277     albertel 9187: 1. course domain
                   9188: 2. course number
                   9189: 3. access status: users must have - either active, 
1.275     raeburn  9190: previous, future, or all.
1.277     albertel 9191: 4. reference to array of permissible roles
1.288     raeburn  9192: 5. reference to array of section restrictions (optional)
                   9193: 6. reference to results object (hash of hashes).
                   9194: 7. reference to optional userdata hash
1.609     raeburn  9195: 8. reference to optional statushash
1.630     raeburn  9196: 9. flag if privileged users (except those set to unhide in
                   9197:    course settings) should be excluded    
1.609     raeburn  9198: Keys of top level results hash are roles.
1.275     raeburn  9199: Keys of inner hashes are username:domain, with 
                   9200: values set to access type.
1.288     raeburn  9201: Optional userdata hash returns an array with arguments in the 
                   9202: same order as loncoursedata::get_classlist() for student data.
                   9203: 
1.609     raeburn  9204: Optional statushash returns
                   9205: 
1.288     raeburn  9206: Entries for end, start, section and status are blank because
                   9207: of the possibility of multiple values for non-student roles.
                   9208: 
1.275     raeburn  9209: =cut
1.405     albertel 9210: 
1.275     raeburn  9211: ###############################################
1.405     albertel 9212: 
1.275     raeburn  9213: sub get_course_users {
1.630     raeburn  9214:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  9215:     my %idx = ();
1.419     raeburn  9216:     my %seclists;
1.288     raeburn  9217: 
                   9218:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   9219:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   9220:     $idx{end} = &Apache::loncoursedata::CL_END();
                   9221:     $idx{start} = &Apache::loncoursedata::CL_START();
                   9222:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   9223:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   9224:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   9225:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   9226: 
1.290     albertel 9227:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 9228:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  9229:         my $now = time;
1.277     albertel 9230:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  9231:             my $match = 0;
1.412     raeburn  9232:             my $secmatch = 0;
1.419     raeburn  9233:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  9234:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  9235:             if ($section eq '') {
                   9236:                 $section = 'none';
                   9237:             }
1.291     albertel 9238:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9239:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9240:                     $secmatch = 1;
                   9241:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 9242:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9243:                         $secmatch = 1;
                   9244:                     }
                   9245:                 } else {  
1.419     raeburn  9246: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  9247: 		        $secmatch = 1;
                   9248:                     }
1.290     albertel 9249: 		}
1.412     raeburn  9250:                 if (!$secmatch) {
                   9251:                     next;
                   9252:                 }
1.419     raeburn  9253:             }
1.275     raeburn  9254:             if (defined($$types{'active'})) {
1.288     raeburn  9255:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  9256:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  9257:                     $match = 1;
1.275     raeburn  9258:                 }
                   9259:             }
                   9260:             if (defined($$types{'previous'})) {
1.609     raeburn  9261:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  9262:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  9263:                     $match = 1;
1.275     raeburn  9264:                 }
                   9265:             }
                   9266:             if (defined($$types{'future'})) {
1.609     raeburn  9267:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  9268:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  9269:                     $match = 1;
1.275     raeburn  9270:                 }
                   9271:             }
1.609     raeburn  9272:             if ($match) {
                   9273:                 push(@{$seclists{$student}},$section);
                   9274:                 if (ref($userdata) eq 'HASH') {
                   9275:                     $$userdata{$student} = $$classlist{$student};
                   9276:                 }
                   9277:                 if (ref($statushash) eq 'HASH') {
                   9278:                     $statushash->{$student}{'st'}{$section} = $status;
                   9279:                 }
1.288     raeburn  9280:             }
1.275     raeburn  9281:         }
                   9282:     }
1.412     raeburn  9283:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9284:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9285:         my $now = time;
1.609     raeburn  9286:         my %displaystatus = ( previous => 'Expired',
                   9287:                               active   => 'Active',
                   9288:                               future   => 'Future',
                   9289:                             );
1.1075.2.36  raeburn  9290:         my (%nothide,@possdoms);
1.630     raeburn  9291:         if ($hidepriv) {
                   9292:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9293:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9294:                 if ($user !~ /:/) {
                   9295:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9296:                 } else {
                   9297:                     $nothide{$user} = 1;
                   9298:                 }
                   9299:             }
1.1075.2.36  raeburn  9300:             my @possdoms = ($cdom);
                   9301:             if ($coursehash{'checkforpriv'}) {
                   9302:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9303:             }
1.630     raeburn  9304:         }
1.439     raeburn  9305:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9306:             my $match = 0;
1.412     raeburn  9307:             my $secmatch = 0;
1.439     raeburn  9308:             my $status;
1.412     raeburn  9309:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9310:             $user =~ s/:$//;
1.439     raeburn  9311:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9312:             if ($end == -1 || $start == -1) {
                   9313:                 next;
                   9314:             }
                   9315:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9316:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9317:                 my ($uname,$udom) = split(/:/,$user);
                   9318:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9319:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9320:                         $secmatch = 1;
                   9321:                     } elsif ($usec eq '') {
1.420     albertel 9322:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9323:                             $secmatch = 1;
                   9324:                         }
                   9325:                     } else {
                   9326:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9327:                             $secmatch = 1;
                   9328:                         }
                   9329:                     }
                   9330:                     if (!$secmatch) {
                   9331:                         next;
                   9332:                     }
1.288     raeburn  9333:                 }
1.419     raeburn  9334:                 if ($usec eq '') {
                   9335:                     $usec = 'none';
                   9336:                 }
1.275     raeburn  9337:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9338:                     if ($hidepriv) {
1.1075.2.36  raeburn  9339:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9340:                             (!$nothide{$uname.':'.$udom})) {
                   9341:                             next;
                   9342:                         }
                   9343:                     }
1.503     raeburn  9344:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9345:                         $status = 'previous';
                   9346:                     } elsif ($start > $now) {
                   9347:                         $status = 'future';
                   9348:                     } else {
                   9349:                         $status = 'active';
                   9350:                     }
1.277     albertel 9351:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9352:                         if ($status eq $type) {
1.420     albertel 9353:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9354:                                 push(@{$$users{$role}{$user}},$type);
                   9355:                             }
1.288     raeburn  9356:                             $match = 1;
                   9357:                         }
                   9358:                     }
1.419     raeburn  9359:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9360:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9361: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9362:                         }
1.420     albertel 9363:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9364:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9365:                         }
1.609     raeburn  9366:                         if (ref($statushash) eq 'HASH') {
                   9367:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9368:                         }
1.275     raeburn  9369:                     }
                   9370:                 }
                   9371:             }
                   9372:         }
1.290     albertel 9373:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9374:             if ((defined($cdom)) && (defined($cnum))) {
                   9375:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9376:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9377:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9378:                     next if ($owner eq '');
                   9379:                     my ($ownername,$ownerdom);
                   9380:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9381:                         $ownername = $1;
                   9382:                         $ownerdom = $2;
                   9383:                     } else {
                   9384:                         $ownername = $owner;
                   9385:                         $ownerdom = $cdom;
                   9386:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9387:                     }
                   9388:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9389:                     if (defined($userdata) && 
1.609     raeburn  9390: 			!exists($$userdata{$owner})) {
                   9391: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9392:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9393:                             push(@{$seclists{$owner}},'none');
                   9394:                         }
                   9395:                         if (ref($statushash) eq 'HASH') {
                   9396:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9397:                         }
1.290     albertel 9398: 		    }
1.279     raeburn  9399:                 }
                   9400:             }
                   9401:         }
1.419     raeburn  9402:         foreach my $user (keys(%seclists)) {
                   9403:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9404:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9405:         }
1.275     raeburn  9406:     }
                   9407:     return;
                   9408: }
                   9409: 
1.288     raeburn  9410: sub get_user_info {
                   9411:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9412:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9413: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9414:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9415:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9416:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9417:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9418:     return;
                   9419: }
1.275     raeburn  9420: 
1.472     raeburn  9421: ###############################################
                   9422: 
                   9423: =pod
                   9424: 
                   9425: =item * &get_user_quota()
                   9426: 
1.1075.2.41  raeburn  9427: Retrieves quota assigned for storage of user files.
                   9428: Default is to report quota for portfolio files.
1.472     raeburn  9429: 
                   9430: Incoming parameters:
                   9431: 1. user's username
                   9432: 2. user's domain
1.1075.2.41  raeburn  9433: 3. quota name - portfolio, author, or course
                   9434:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  9435: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  9436:    course
1.472     raeburn  9437: 
                   9438: Returns:
1.1075.2.58  raeburn  9439: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9440: 2. (Optional) Type of setting: custom or default
                   9441:    (individually assigned or default for user's 
                   9442:    institutional status).
                   9443: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9444:    or student - types as defined in localenroll::inst_usertypes 
                   9445:    for user's domain, which determines default quota for user.
                   9446: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9447: 
                   9448: If a value has been stored in the user's environment, 
1.536     raeburn  9449: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  9450: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9451: 
                   9452: =cut
                   9453: 
                   9454: ###############################################
                   9455: 
                   9456: 
                   9457: sub get_user_quota {
1.1075.2.42  raeburn  9458:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9459:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9460:     if (!defined($udom)) {
                   9461:         $udom = $env{'user.domain'};
                   9462:     }
                   9463:     if (!defined($uname)) {
                   9464:         $uname = $env{'user.name'};
                   9465:     }
                   9466:     if (($udom eq '' || $uname eq '') ||
                   9467:         ($udom eq 'public') && ($uname eq 'public')) {
                   9468:         $quota = 0;
1.536     raeburn  9469:         $quotatype = 'default';
                   9470:         $defquota = 0; 
1.472     raeburn  9471:     } else {
1.536     raeburn  9472:         my $inststatus;
1.1075.2.41  raeburn  9473:         if ($quotaname eq 'course') {
                   9474:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9475:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9476:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9477:             } else {
                   9478:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9479:                 $quota = $cenv{'internal.uploadquota'};
                   9480:             }
1.536     raeburn  9481:         } else {
1.1075.2.41  raeburn  9482:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   9483:                 if ($quotaname eq 'author') {
                   9484:                     $quota = $env{'environment.authorquota'};
                   9485:                 } else {
                   9486:                     $quota = $env{'environment.portfolioquota'};
                   9487:                 }
                   9488:                 $inststatus = $env{'environment.inststatus'};
                   9489:             } else {
                   9490:                 my %userenv = 
                   9491:                     &Apache::lonnet::get('environment',['portfolioquota',
                   9492:                                          'authorquota','inststatus'],$udom,$uname);
                   9493:                 my ($tmp) = keys(%userenv);
                   9494:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9495:                     if ($quotaname eq 'author') {
                   9496:                         $quota = $userenv{'authorquota'};
                   9497:                     } else {
                   9498:                         $quota = $userenv{'portfolioquota'};
                   9499:                     }
                   9500:                     $inststatus = $userenv{'inststatus'};
                   9501:                 } else {
                   9502:                     undef(%userenv);
                   9503:                 }
                   9504:             }
                   9505:         }
                   9506:         if ($quota eq '' || wantarray) {
                   9507:             if ($quotaname eq 'course') {
                   9508:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  9509:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   9510:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  9511:                     $defquota = $domdefs{$crstype.'quota'};
                   9512:                 }
                   9513:                 if ($defquota eq '') {
                   9514:                     $defquota = 500;
                   9515:                 }
1.1075.2.41  raeburn  9516:             } else {
                   9517:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   9518:             }
                   9519:             if ($quota eq '') {
                   9520:                 $quota = $defquota;
                   9521:                 $quotatype = 'default';
                   9522:             } else {
                   9523:                 $quotatype = 'custom';
                   9524:             }
1.472     raeburn  9525:         }
                   9526:     }
1.536     raeburn  9527:     if (wantarray) {
                   9528:         return ($quota,$quotatype,$settingstatus,$defquota);
                   9529:     } else {
                   9530:         return $quota;
                   9531:     }
1.472     raeburn  9532: }
                   9533: 
                   9534: ###############################################
                   9535: 
                   9536: =pod
                   9537: 
                   9538: =item * &default_quota()
                   9539: 
1.536     raeburn  9540: Retrieves default quota assigned for storage of user portfolio files,
                   9541: given an (optional) user's institutional status.
1.472     raeburn  9542: 
                   9543: Incoming parameters:
1.1075.2.42  raeburn  9544: 
1.472     raeburn  9545: 1. domain
1.536     raeburn  9546: 2. (Optional) institutional status(es).  This is a : separated list of 
                   9547:    status types (e.g., faculty, staff, student etc.)
                   9548:    which apply to the user for whom the default is being retrieved.
                   9549:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  9550:    default quota will be returned.
                   9551: 3.  quota name - portfolio, author, or course
                   9552:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  9553: 
                   9554: Returns:
1.1075.2.42  raeburn  9555: 
1.1075.2.58  raeburn  9556: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  9557: 2. (Optional) institutional type which determined the value of the
                   9558:    default quota.
1.472     raeburn  9559: 
                   9560: If a value has been stored in the domain's configuration db,
                   9561: it will return that, otherwise it returns 20 (for backwards 
                   9562: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  9563: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  9564: 
1.536     raeburn  9565: If the user's status includes multiple types (e.g., staff and student),
                   9566: the largest default quota which applies to the user determines the
                   9567: default quota returned.
                   9568: 
1.472     raeburn  9569: =cut
                   9570: 
                   9571: ###############################################
                   9572: 
                   9573: 
                   9574: sub default_quota {
1.1075.2.41  raeburn  9575:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  9576:     my ($defquota,$settingstatus);
                   9577:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  9578:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  9579:     my $key = 'defaultquota';
                   9580:     if ($quotaname eq 'author') {
                   9581:         $key = 'authorquota';
                   9582:     }
1.622     raeburn  9583:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  9584:         if ($inststatus ne '') {
1.765     raeburn  9585:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  9586:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  9587:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9588:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  9589:                         if ($defquota eq '') {
1.1075.2.41  raeburn  9590:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9591:                             $settingstatus = $item;
1.1075.2.41  raeburn  9592:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   9593:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9594:                             $settingstatus = $item;
                   9595:                         }
                   9596:                     }
1.1075.2.41  raeburn  9597:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  9598:                     if ($quotahash{'quotas'}{$item} ne '') {
                   9599:                         if ($defquota eq '') {
                   9600:                             $defquota = $quotahash{'quotas'}{$item};
                   9601:                             $settingstatus = $item;
                   9602:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   9603:                             $defquota = $quotahash{'quotas'}{$item};
                   9604:                             $settingstatus = $item;
                   9605:                         }
1.536     raeburn  9606:                     }
                   9607:                 }
                   9608:             }
                   9609:         }
                   9610:         if ($defquota eq '') {
1.1075.2.41  raeburn  9611:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9612:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   9613:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  9614:                 $defquota = $quotahash{'quotas'}{'default'};
                   9615:             }
1.536     raeburn  9616:             $settingstatus = 'default';
1.1075.2.42  raeburn  9617:             if ($defquota eq '') {
                   9618:                 if ($quotaname eq 'author') {
                   9619:                     $defquota = 500;
                   9620:                 }
                   9621:             }
1.536     raeburn  9622:         }
                   9623:     } else {
                   9624:         $settingstatus = 'default';
1.1075.2.41  raeburn  9625:         if ($quotaname eq 'author') {
                   9626:             $defquota = 500;
                   9627:         } else {
                   9628:             $defquota = 20;
                   9629:         }
1.536     raeburn  9630:     }
                   9631:     if (wantarray) {
                   9632:         return ($defquota,$settingstatus);
1.472     raeburn  9633:     } else {
1.536     raeburn  9634:         return $defquota;
1.472     raeburn  9635:     }
                   9636: }
                   9637: 
1.1075.2.41  raeburn  9638: ###############################################
                   9639: 
                   9640: =pod
                   9641: 
1.1075.2.42  raeburn  9642: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  9643: 
                   9644: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  9645: of existing file within authoring space will cause quota for the authoring
                   9646: space to be exceeded.
                   9647: 
                   9648: Same, if upload of a file directly to a course/community via Course Editor
                   9649: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  9650: 
1.1075.2.61  raeburn  9651: Inputs: 7 
1.1075.2.42  raeburn  9652: 1. username or coursenum
1.1075.2.41  raeburn  9653: 2. domain
1.1075.2.42  raeburn  9654: 3. context ('author' or 'course')
1.1075.2.41  raeburn  9655: 4. filename of file for which action is being requested
                   9656: 5. filesize (kB) of file
                   9657: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  9658: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  9659: 
                   9660: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   9661:          otherwise return null.
                   9662: 
1.1075.2.42  raeburn  9663: =back
                   9664: 
1.1075.2.41  raeburn  9665: =cut
                   9666: 
1.1075.2.42  raeburn  9667: sub excess_filesize_warning {
1.1075.2.59  raeburn  9668:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  9669:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  9670:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  9671:     if ($context eq 'author') {
                   9672:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   9673:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   9674:     } else {
                   9675:         foreach my $subdir ('docs','supplemental') {
                   9676:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   9677:         }
                   9678:     }
1.1075.2.41  raeburn  9679:     $disk_quota = int($disk_quota * 1000);
                   9680:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  9681:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  9682:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  9683:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   9684:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  9685:                             $disk_quota,$current_disk_usage).
                   9686:                '</p>';
                   9687:     }
                   9688:     return;
                   9689: }
                   9690: 
                   9691: ###############################################
                   9692: 
                   9693: 
1.384     raeburn  9694: sub get_secgrprole_info {
                   9695:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   9696:     my %sections_count = &get_sections($cdom,$cnum);
                   9697:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   9698:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   9699:     my @groups = sort(keys(%curr_groups));
                   9700:     my $allroles = [];
                   9701:     my $rolehash;
                   9702:     my $accesshash = {
                   9703:                      active => 'Currently has access',
                   9704:                      future => 'Will have future access',
                   9705:                      previous => 'Previously had access',
                   9706:                   };
                   9707:     if ($needroles) {
                   9708:         $rolehash = {'all' => 'all'};
1.385     albertel 9709:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9710: 	if (&Apache::lonnet::error(%user_roles)) {
                   9711: 	    undef(%user_roles);
                   9712: 	}
                   9713:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  9714:             my ($role)=split(/\:/,$item,2);
                   9715:             if ($role eq 'cr') { next; }
                   9716:             if ($role =~ /^cr/) {
                   9717:                 $$rolehash{$role} = (split('/',$role))[3];
                   9718:             } else {
                   9719:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   9720:             }
                   9721:         }
                   9722:         foreach my $key (sort(keys(%{$rolehash}))) {
                   9723:             push(@{$allroles},$key);
                   9724:         }
                   9725:         push (@{$allroles},'st');
                   9726:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   9727:     }
                   9728:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   9729: }
                   9730: 
1.555     raeburn  9731: sub user_picker {
1.1075.2.127  raeburn  9732:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  9733:     my $currdom = $dom;
1.1075.2.114  raeburn  9734:     my @alldoms = &Apache::lonnet::all_domains();
                   9735:     if (@alldoms == 1) {
                   9736:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   9737:                                                ['directorysrch'],$alldoms[0]);
                   9738:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   9739:         my $showdom = $domdesc;
                   9740:         if ($showdom eq '') {
                   9741:             $showdom = $dom;
                   9742:         }
                   9743:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   9744:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   9745:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   9746:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   9747:             }
                   9748:         }
                   9749:     }
1.555     raeburn  9750:     my %curr_selected = (
                   9751:                         srchin => 'dom',
1.580     raeburn  9752:                         srchby => 'lastname',
1.555     raeburn  9753:                       );
                   9754:     my $srchterm;
1.625     raeburn  9755:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  9756:         if ($srch->{'srchby'} ne '') {
                   9757:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   9758:         }
                   9759:         if ($srch->{'srchin'} ne '') {
                   9760:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   9761:         }
                   9762:         if ($srch->{'srchtype'} ne '') {
                   9763:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   9764:         }
                   9765:         if ($srch->{'srchdomain'} ne '') {
                   9766:             $currdom = $srch->{'srchdomain'};
                   9767:         }
                   9768:         $srchterm = $srch->{'srchterm'};
                   9769:     }
1.1075.2.98  raeburn  9770:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  9771:                     'usr'       => 'Search criteria',
1.563     raeburn  9772:                     'doma'      => 'Domain/institution to search',
1.558     albertel 9773:                     'uname'     => 'username',
                   9774:                     'lastname'  => 'last name',
1.555     raeburn  9775:                     'lastfirst' => 'last name, first name',
1.558     albertel 9776:                     'crs'       => 'in this course',
1.576     raeburn  9777:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 9778:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  9779:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 9780:                     'exact'     => 'is',
                   9781:                     'contains'  => 'contains',
1.569     raeburn  9782:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  9783:                                        );
                   9784:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  9785:                     'youm'      => "You must include some text to search for.",
                   9786:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   9787:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   9788:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   9789:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   9790:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   9791:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   9792:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  9793:                                        );
1.1075.2.98  raeburn  9794:     &html_escape(\%html_lt);
                   9795:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  9796:     my $domform;
1.1075.2.126  raeburn  9797:     my $allow_blank = 1;
1.1075.2.115  raeburn  9798:     if ($fixeddom) {
1.1075.2.126  raeburn  9799:         $allow_blank = 0;
                   9800:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  9801:     } else {
1.1075.2.126  raeburn  9802:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  9803:     }
1.563     raeburn  9804:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  9805: 
                   9806:     my @srchins = ('crs','dom','alc','instd');
                   9807: 
                   9808:     foreach my $option (@srchins) {
                   9809:         # FIXME 'alc' option unavailable until 
                   9810:         #       loncreateuser::print_user_query_page()
                   9811:         #       has been completed.
                   9812:         next if ($option eq 'alc');
1.880     raeburn  9813:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  9814:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  9815:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  9816:         if ($curr_selected{'srchin'} eq $option) {
                   9817:             $srchinsel .= ' 
1.1075.2.98  raeburn  9818:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  9819:         } else {
                   9820:             $srchinsel .= '
1.1075.2.98  raeburn  9821:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  9822:         }
1.555     raeburn  9823:     }
1.563     raeburn  9824:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  9825: 
                   9826:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  9827:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  9828:         if ($curr_selected{'srchby'} eq $option) {
                   9829:             $srchbysel .= '
1.1075.2.98  raeburn  9830:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  9831:         } else {
                   9832:             $srchbysel .= '
1.1075.2.98  raeburn  9833:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  9834:          }
                   9835:     }
                   9836:     $srchbysel .= "\n  </select>\n";
                   9837: 
                   9838:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  9839:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  9840:         if ($curr_selected{'srchtype'} eq $option) {
                   9841:             $srchtypesel .= '
1.1075.2.98  raeburn  9842:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  9843:         } else {
                   9844:             $srchtypesel .= '
1.1075.2.98  raeburn  9845:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  9846:         }
                   9847:     }
                   9848:     $srchtypesel .= "\n  </select>\n";
                   9849: 
1.558     albertel 9850:     my ($newuserscript,$new_user_create);
1.994     raeburn  9851:     my $context_dom = $env{'request.role.domain'};
                   9852:     if ($context eq 'requestcrs') {
                   9853:         if ($env{'form.coursedom'} ne '') { 
                   9854:             $context_dom = $env{'form.coursedom'};
                   9855:         }
                   9856:     }
1.556     raeburn  9857:     if ($forcenewuser) {
1.576     raeburn  9858:         if (ref($srch) eq 'HASH') {
1.994     raeburn  9859:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  9860:                 if ($cancreate) {
                   9861:                     $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>';
                   9862:                 } else {
1.799     bisitz   9863:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  9864:                     my %usertypetext = (
                   9865:                         official   => 'institutional',
                   9866:                         unofficial => 'non-institutional',
                   9867:                     );
1.799     bisitz   9868:                     $new_user_create = '<p class="LC_warning">'
                   9869:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   9870:                                       .' '
                   9871:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   9872:                                           ,'<a href="'.$helplink.'">','</a>')
                   9873:                                       .'</p><br />';
1.627     raeburn  9874:                 }
1.576     raeburn  9875:             }
                   9876:         }
                   9877: 
1.556     raeburn  9878:         $newuserscript = <<"ENDSCRIPT";
                   9879: 
1.570     raeburn  9880: function setSearch(createnew,callingForm) {
1.556     raeburn  9881:     if (createnew == 1) {
1.570     raeburn  9882:         for (var i=0; i<callingForm.srchby.length; i++) {
                   9883:             if (callingForm.srchby.options[i].value == 'uname') {
                   9884:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  9885:             }
                   9886:         }
1.570     raeburn  9887:         for (var i=0; i<callingForm.srchin.length; i++) {
                   9888:             if ( callingForm.srchin.options[i].value == 'dom') {
                   9889: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  9890:             }
                   9891:         }
1.570     raeburn  9892:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   9893:             if (callingForm.srchtype.options[i].value == 'exact') {
                   9894:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  9895:             }
                   9896:         }
1.570     raeburn  9897:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  9898:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  9899:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  9900:             }
                   9901:         }
                   9902:     }
                   9903: }
                   9904: ENDSCRIPT
1.558     albertel 9905: 
1.556     raeburn  9906:     }
                   9907: 
1.555     raeburn  9908:     my $output = <<"END_BLOCK";
1.556     raeburn  9909: <script type="text/javascript">
1.824     bisitz   9910: // <![CDATA[
1.570     raeburn  9911: function validateEntry(callingForm) {
1.558     albertel 9912: 
1.556     raeburn  9913:     var checkok = 1;
1.558     albertel 9914:     var srchin;
1.570     raeburn  9915:     for (var i=0; i<callingForm.srchin.length; i++) {
                   9916: 	if ( callingForm.srchin[i].checked ) {
                   9917: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 9918: 	}
                   9919:     }
                   9920: 
1.570     raeburn  9921:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   9922:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   9923:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   9924:     var srchterm =  callingForm.srchterm.value;
                   9925:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  9926:     var msg = "";
                   9927: 
                   9928:     if (srchterm == "") {
                   9929:         checkok = 0;
1.1075.2.98  raeburn  9930:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  9931:     }
                   9932: 
1.569     raeburn  9933:     if (srchtype== 'begins') {
                   9934:         if (srchterm.length < 2) {
                   9935:             checkok = 0;
1.1075.2.98  raeburn  9936:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  9937:         }
                   9938:     }
                   9939: 
1.556     raeburn  9940:     if (srchtype== 'contains') {
                   9941:         if (srchterm.length < 3) {
                   9942:             checkok = 0;
1.1075.2.98  raeburn  9943:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  9944:         }
                   9945:     }
                   9946:     if (srchin == 'instd') {
                   9947:         if (srchdomain == '') {
                   9948:             checkok = 0;
1.1075.2.98  raeburn  9949:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  9950:         }
                   9951:     }
                   9952:     if (srchin == 'dom') {
                   9953:         if (srchdomain == '') {
                   9954:             checkok = 0;
1.1075.2.98  raeburn  9955:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  9956:         }
                   9957:     }
                   9958:     if (srchby == 'lastfirst') {
                   9959:         if (srchterm.indexOf(",") == -1) {
                   9960:             checkok = 0;
1.1075.2.98  raeburn  9961:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  9962:         }
                   9963:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   9964:             checkok = 0;
1.1075.2.98  raeburn  9965:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  9966:         }
                   9967:     }
                   9968:     if (checkok == 0) {
1.1075.2.98  raeburn  9969:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  9970:         return;
                   9971:     }
                   9972:     if (checkok == 1) {
1.570     raeburn  9973:         callingForm.submit();
1.556     raeburn  9974:     }
                   9975: }
                   9976: 
                   9977: $newuserscript
                   9978: 
1.824     bisitz   9979: // ]]>
1.556     raeburn  9980: </script>
1.558     albertel 9981: 
                   9982: $new_user_create
                   9983: 
1.555     raeburn  9984: END_BLOCK
1.558     albertel 9985: 
1.876     raeburn  9986:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  9987:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  9988:                $domform.
                   9989:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  9990:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  9991:                $srchbysel.
                   9992:                $srchtypesel. 
                   9993:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   9994:                $srchinsel.
                   9995:                &Apache::lonhtmlcommon::row_closure(1). 
                   9996:                &Apache::lonhtmlcommon::end_pick_box().
                   9997:                '<br />';
1.1075.2.114  raeburn  9998:     return ($output,1);
1.555     raeburn  9999: }
                   10000: 
1.612     raeburn  10001: sub user_rule_check {
1.615     raeburn  10002:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  10003:     my ($response,%inst_response);
1.612     raeburn  10004:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  10005:         if (keys(%{$usershash}) > 1) {
                   10006:             my (%by_username,%by_id,%userdoms);
                   10007:             my $checkid;
1.612     raeburn  10008:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  10009:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   10010:                     $checkid = 1;
                   10011:                 }
                   10012:             }
                   10013:             foreach my $user (keys(%{$usershash})) {
                   10014:                 my ($uname,$udom) = split(/:/,$user);
                   10015:                 if ($checkid) {
                   10016:                     if (ref($usershash->{$user}) eq 'HASH') {
                   10017:                         if ($usershash->{$user}->{'id'} ne '') {
                   10018:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   10019:                             $userdoms{$udom} = 1;
                   10020:                             if (ref($inst_results) eq 'HASH') {
                   10021:                                 $inst_results->{$uname.':'.$udom} = {};
                   10022:                             }
                   10023:                         }
                   10024:                     }
                   10025:                 } else {
                   10026:                     $by_username{$udom}{$uname} = 1;
                   10027:                     $userdoms{$udom} = 1;
                   10028:                     if (ref($inst_results) eq 'HASH') {
                   10029:                         $inst_results->{$uname.':'.$udom} = {};
                   10030:                     }
                   10031:                 }
                   10032:             }
                   10033:             foreach my $udom (keys(%userdoms)) {
                   10034:                 if (!$got_rules->{$udom}) {
                   10035:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10036:                                                              ['usercreation'],$udom);
                   10037:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10038:                         foreach my $item ('username','id') {
                   10039:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10040:                                 $$curr_rules{$udom}{$item} =
                   10041:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   10042:                             }
                   10043:                         }
                   10044:                     }
                   10045:                     $got_rules->{$udom} = 1;
                   10046:                 }
                   10047:             }
                   10048:             if ($checkid) {
                   10049:                 foreach my $udom (keys(%by_id)) {
                   10050:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   10051:                     if ($outcome eq 'ok') {
                   10052:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   10053:                             my $uname = $by_id{$udom}{$id};
                   10054:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10055:                         }
                   10056:                         if (ref($results) eq 'HASH') {
                   10057:                             foreach my $uname (keys(%{$results})) {
                   10058:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   10059:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   10060:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10061:                                 }
                   10062:                             }
                   10063:                         }
                   10064:                     }
1.612     raeburn  10065:                 }
1.615     raeburn  10066:             } else {
1.1075.2.99  raeburn  10067:                 foreach my $udom (keys(%by_username)) {
                   10068:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   10069:                     if ($outcome eq 'ok') {
                   10070:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   10071:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10072:                         }
                   10073:                         if (ref($results) eq 'HASH') {
                   10074:                             foreach my $uname (keys(%{$results})) {
                   10075:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10076:                             }
                   10077:                         }
                   10078:                     }
                   10079:                 }
1.612     raeburn  10080:             }
1.1075.2.99  raeburn  10081:         } elsif (keys(%{$usershash}) == 1) {
                   10082:             my $user = (keys(%{$usershash}))[0];
                   10083:             my ($uname,$udom) = split(/:/,$user);
                   10084:             if (($udom ne '') && ($uname ne '')) {
                   10085:                 if (ref($usershash->{$user}) eq 'HASH') {
                   10086:                     if (ref($checks) eq 'HASH') {
                   10087:                         if (defined($checks->{'username'})) {
                   10088:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   10089:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   10090:                         } elsif (defined($checks->{'id'})) {
                   10091:                             if ($usershash->{$user}->{'id'} ne '') {
                   10092:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10093:                                     &Apache::lonnet::get_instuser($udom,undef,
                   10094:                                                                   $usershash->{$user}->{'id'});
                   10095:                             } else {
                   10096:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10097:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   10098:                             }
                   10099:                         }
                   10100:                     } else {
                   10101:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   10102:                             &Apache::lonnet::get_instuser($udom,$uname);
                   10103:                        return;
                   10104:                     }
                   10105:                     if (!$got_rules->{$udom}) {
                   10106:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10107:                                                                  ['usercreation'],$udom);
                   10108:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10109:                             foreach my $item ('username','id') {
                   10110:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10111:                                    $$curr_rules{$udom}{$item} =
                   10112:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   10113:                                 }
                   10114:                             }
1.585     raeburn  10115:                         }
1.1075.2.99  raeburn  10116:                         $got_rules->{$udom} = 1;
1.585     raeburn  10117:                     }
                   10118:                 }
1.1075.2.99  raeburn  10119:             } else {
                   10120:                 return;
                   10121:             }
                   10122:         } else {
                   10123:             return;
                   10124:         }
                   10125:         foreach my $user (keys(%{$usershash})) {
                   10126:             my ($uname,$udom) = split(/:/,$user);
                   10127:             next if (($udom eq '') || ($uname eq ''));
                   10128:             my $id;
                   10129:             if (ref($inst_results) eq 'HASH') {
                   10130:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   10131:                     $id = $inst_results->{$user}->{'id'};
                   10132:                 }
                   10133:             }
                   10134:             if ($id eq '') {
                   10135:                 if (ref($usershash->{$user})) {
                   10136:                     $id = $usershash->{$user}->{'id'};
                   10137:                 }
1.585     raeburn  10138:             }
1.612     raeburn  10139:             foreach my $item (keys(%{$checks})) {
                   10140:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   10141:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   10142:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  10143:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   10144:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  10145:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   10146:                                 if ($rule_check{$rule}) {
                   10147:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10148:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10149:                                         if (ref($inst_results) eq 'HASH') {
                   10150:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10151:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10152:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10153:                                                 } elsif ($item eq 'id') {
                   10154:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10155:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10156:                                                     }
1.615     raeburn  10157:                                                 }
1.612     raeburn  10158:                                             }
                   10159:                                         }
1.615     raeburn  10160:                                     }
                   10161:                                     last;
1.585     raeburn  10162:                                 }
                   10163:                             }
                   10164:                         }
                   10165:                     }
                   10166:                 }
                   10167:             }
                   10168:         }
                   10169:     }
1.612     raeburn  10170:     return;
                   10171: }
                   10172: 
                   10173: sub user_rule_formats {
                   10174:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10175:     my %text = ( 
                   10176:                  'username' => 'Usernames',
                   10177:                  'id'       => 'IDs',
                   10178:                );
                   10179:     my $output;
                   10180:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10181:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10182:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10183:             $output = '<br />'.
                   10184:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10185:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10186:                       ' <ul>';
1.612     raeburn  10187:             foreach my $rule (@{$ruleorder}) {
                   10188:                 if (ref($curr_rules) eq 'ARRAY') {
                   10189:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10190:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10191:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10192:                                         $rules->{$rule}{'desc'}.'</li>';
                   10193:                         }
                   10194:                     }
                   10195:                 }
                   10196:             }
                   10197:             $output .= '</ul>';
                   10198:         }
                   10199:     }
                   10200:     return $output;
                   10201: }
                   10202: 
                   10203: sub instrule_disallow_msg {
1.615     raeburn  10204:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  10205:     my $response;
                   10206:     my %text = (
                   10207:                   item   => 'username',
                   10208:                   items  => 'usernames',
                   10209:                   match  => 'matches',
                   10210:                   do     => 'does',
                   10211:                   action => 'a username',
                   10212:                   one    => 'one',
                   10213:                );
                   10214:     if ($count > 1) {
                   10215:         $text{'item'} = 'usernames';
                   10216:         $text{'match'} ='match';
                   10217:         $text{'do'} = 'do';
                   10218:         $text{'action'} = 'usernames',
                   10219:         $text{'one'} = 'ones';
                   10220:     }
                   10221:     if ($checkitem eq 'id') {
                   10222:         $text{'items'} = 'IDs';
                   10223:         $text{'item'} = 'ID';
                   10224:         $text{'action'} = 'an ID';
1.615     raeburn  10225:         if ($count > 1) {
                   10226:             $text{'item'} = 'IDs';
                   10227:             $text{'action'} = 'IDs';
                   10228:         }
1.612     raeburn  10229:     }
1.674     bisitz   10230:     $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  10231:     if ($mode eq 'upload') {
                   10232:         if ($checkitem eq 'username') {
                   10233:             $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'}.");
                   10234:         } elsif ($checkitem eq 'id') {
1.674     bisitz   10235:             $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  10236:         }
1.669     raeburn  10237:     } elsif ($mode eq 'selfcreate') {
                   10238:         if ($checkitem eq 'id') {
                   10239:             $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.");
                   10240:         }
1.615     raeburn  10241:     } else {
                   10242:         if ($checkitem eq 'username') {
                   10243:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   10244:         } elsif ($checkitem eq 'id') {
                   10245:             $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.");
                   10246:         }
1.612     raeburn  10247:     }
                   10248:     return $response;
1.585     raeburn  10249: }
                   10250: 
1.624     raeburn  10251: sub personal_data_fieldtitles {
                   10252:     my %fieldtitles = &Apache::lonlocal::texthash (
                   10253:                         id => 'Student/Employee ID',
                   10254:                         permanentemail => 'E-mail address',
                   10255:                         lastname => 'Last Name',
                   10256:                         firstname => 'First Name',
                   10257:                         middlename => 'Middle Name',
                   10258:                         generation => 'Generation',
                   10259:                         gen => 'Generation',
1.765     raeburn  10260:                         inststatus => 'Affiliation',
1.624     raeburn  10261:                    );
                   10262:     return %fieldtitles;
                   10263: }
                   10264: 
1.642     raeburn  10265: sub sorted_inst_types {
                   10266:     my ($dom) = @_;
1.1075.2.70  raeburn  10267:     my ($usertypes,$order);
                   10268:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   10269:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   10270:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   10271:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   10272:     } else {
                   10273:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   10274:     }
1.642     raeburn  10275:     my $othertitle = &mt('All users');
                   10276:     if ($env{'request.course.id'}) {
1.668     raeburn  10277:         $othertitle  = &mt('Any users');
1.642     raeburn  10278:     }
                   10279:     my @types;
                   10280:     if (ref($order) eq 'ARRAY') {
                   10281:         @types = @{$order};
                   10282:     }
                   10283:     if (@types == 0) {
                   10284:         if (ref($usertypes) eq 'HASH') {
                   10285:             @types = sort(keys(%{$usertypes}));
                   10286:         }
                   10287:     }
                   10288:     if (keys(%{$usertypes}) > 0) {
                   10289:         $othertitle = &mt('Other users');
                   10290:     }
                   10291:     return ($othertitle,$usertypes,\@types);
                   10292: }
                   10293: 
1.645     raeburn  10294: sub get_institutional_codes {
                   10295:     my ($settings,$allcourses,$LC_code) = @_;
                   10296: # Get complete list of course sections to update
                   10297:     my @currsections = ();
                   10298:     my @currxlists = ();
                   10299:     my $coursecode = $$settings{'internal.coursecode'};
                   10300: 
                   10301:     if ($$settings{'internal.sectionnums'} ne '') {
                   10302:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   10303:     }
                   10304: 
                   10305:     if ($$settings{'internal.crosslistings'} ne '') {
                   10306:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   10307:     }
                   10308: 
                   10309:     if (@currxlists > 0) {
                   10310:         foreach (@currxlists) {
                   10311:             if (m/^([^:]+):(\w*)$/) {
                   10312:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  10313:                     push(@{$allcourses},$1);
1.645     raeburn  10314:                     $$LC_code{$1} = $2;
                   10315:                 }
                   10316:             }
                   10317:         }
                   10318:     }
                   10319:  
                   10320:     if (@currsections > 0) {
                   10321:         foreach (@currsections) {
                   10322:             if (m/^(\w+):(\w*)$/) {
                   10323:                 my $sec = $coursecode.$1;
                   10324:                 my $lc_sec = $2;
                   10325:                 unless (grep/^$sec$/,@{$allcourses}) {
1.1075.2.119  raeburn  10326:                     push(@{$allcourses},$sec);
1.645     raeburn  10327:                     $$LC_code{$sec} = $lc_sec;
                   10328:                 }
                   10329:             }
                   10330:         }
                   10331:     }
                   10332:     return;
                   10333: }
                   10334: 
1.971     raeburn  10335: sub get_standard_codeitems {
                   10336:     return ('Year','Semester','Department','Number','Section');
                   10337: }
                   10338: 
1.112     bowersj2 10339: =pod
                   10340: 
1.780     raeburn  10341: =head1 Slot Helpers
                   10342: 
                   10343: =over 4
                   10344: 
                   10345: =item * sorted_slots()
                   10346: 
1.1040    raeburn  10347: Sorts an array of slot names in order of an optional sort key,
                   10348: default sort is by slot start time (earliest first). 
1.780     raeburn  10349: 
                   10350: Inputs:
                   10351: 
                   10352: =over 4
                   10353: 
                   10354: slotsarr  - Reference to array of unsorted slot names.
                   10355: 
                   10356: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   10357: 
1.1040    raeburn  10358: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   10359: 
1.549     albertel 10360: =back
                   10361: 
1.780     raeburn  10362: Returns:
                   10363: 
                   10364: =over 4
                   10365: 
1.1040    raeburn  10366: sorted   - An array of slot names sorted by a specified sort key 
                   10367:            (default sort key is start time of the slot).
1.780     raeburn  10368: 
                   10369: =back
                   10370: 
                   10371: =cut
                   10372: 
                   10373: 
                   10374: sub sorted_slots {
1.1040    raeburn  10375:     my ($slotsarr,$slots,$sortkey) = @_;
                   10376:     if ($sortkey eq '') {
                   10377:         $sortkey = 'starttime';
                   10378:     }
1.780     raeburn  10379:     my @sorted;
                   10380:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   10381:         @sorted =
                   10382:             sort {
                   10383:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  10384:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  10385:                      }
                   10386:                      if (ref($slots->{$a})) { return -1;}
                   10387:                      if (ref($slots->{$b})) { return 1;}
                   10388:                      return 0;
                   10389:                  } @{$slotsarr};
                   10390:     }
                   10391:     return @sorted;
                   10392: }
                   10393: 
1.1040    raeburn  10394: =pod
                   10395: 
                   10396: =item * get_future_slots()
                   10397: 
                   10398: Inputs:
                   10399: 
                   10400: =over 4
                   10401: 
                   10402: cnum - course number
                   10403: 
                   10404: cdom - course domain
                   10405: 
                   10406: now - current UNIX time
                   10407: 
                   10408: symb - optional symb
                   10409: 
                   10410: =back
                   10411: 
                   10412: Returns:
                   10413: 
                   10414: =over 4
                   10415: 
                   10416: sorted_reservable - ref to array of student_schedulable slots currently 
                   10417:                     reservable, ordered by end date of reservation period.
                   10418: 
                   10419: reservable_now - ref to hash of student_schedulable slots currently
                   10420:                  reservable.
                   10421: 
                   10422:     Keys in inner hash are:
                   10423:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  10424:     (b) endreserve: end date of reservation period.
                   10425:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10426:         selected.
1.1040    raeburn  10427: 
                   10428: sorted_future - ref to array of student_schedulable slots reservable in
                   10429:                 the future, ordered by start date of reservation period.
                   10430: 
                   10431: future_reservable - ref to hash of student_schedulable slots reservable
                   10432:                     in the future.
                   10433: 
                   10434:     Keys in inner hash are:
                   10435:     (a) symb: either blank or symb to which slot use is restricted.
                   10436:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  10437:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10438:         selected.
1.1040    raeburn  10439: 
                   10440: =back
                   10441: 
                   10442: =cut
                   10443: 
                   10444: sub get_future_slots {
                   10445:     my ($cnum,$cdom,$now,$symb) = @_;
                   10446:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10447:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10448:     foreach my $slot (keys(%slots)) {
                   10449:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10450:         if ($symb) {
                   10451:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10452:                      ($slots{$slot}->{'symb'} ne $symb));
                   10453:         }
                   10454:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10455:             ($slots{$slot}->{'endtime'} > $now)) {
                   10456:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10457:                 my $userallowed = 0;
                   10458:                 if ($slots{$slot}->{'allowedsections'}) {
                   10459:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10460:                     if (!defined($env{'request.role.sec'})
                   10461:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10462:                         $userallowed=1;
                   10463:                     } else {
                   10464:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   10465:                             $userallowed=1;
                   10466:                         }
                   10467:                     }
                   10468:                     unless ($userallowed) {
                   10469:                         if (defined($env{'request.course.groups'})) {
                   10470:                             my @groups = split(/:/,$env{'request.course.groups'});
                   10471:                             foreach my $group (@groups) {
                   10472:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   10473:                                     $userallowed=1;
                   10474:                                     last;
                   10475:                                 }
                   10476:                             }
                   10477:                         }
                   10478:                     }
                   10479:                 }
                   10480:                 if ($slots{$slot}->{'allowedusers'}) {
                   10481:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   10482:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   10483:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   10484:                         $userallowed = 1;
                   10485:                     }
                   10486:                 }
                   10487:                 next unless($userallowed);
                   10488:             }
                   10489:             my $startreserve = $slots{$slot}->{'startreserve'};
                   10490:             my $endreserve = $slots{$slot}->{'endreserve'};
                   10491:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  10492:             my $uniqueperiod;
                   10493:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   10494:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   10495:             }
1.1040    raeburn  10496:             if (($startreserve < $now) &&
                   10497:                 (!$endreserve || $endreserve > $now)) {
                   10498:                 my $lastres = $endreserve;
                   10499:                 if (!$lastres) {
                   10500:                     $lastres = $slots{$slot}->{'starttime'};
                   10501:                 }
                   10502:                 $reservable_now{$slot} = {
                   10503:                                            symb       => $symb,
1.1075.2.104  raeburn  10504:                                            endreserve => $lastres,
                   10505:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  10506:                                          };
                   10507:             } elsif (($startreserve > $now) &&
                   10508:                      (!$endreserve || $endreserve > $startreserve)) {
                   10509:                 $future_reservable{$slot} = {
                   10510:                                               symb         => $symb,
1.1075.2.104  raeburn  10511:                                               startreserve => $startreserve,
                   10512:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  10513:                                             };
                   10514:             }
                   10515:         }
                   10516:     }
                   10517:     my @unsorted_reservable = keys(%reservable_now);
                   10518:     if (@unsorted_reservable > 0) {
                   10519:         @sorted_reservable = 
                   10520:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   10521:     }
                   10522:     my @unsorted_future = keys(%future_reservable);
                   10523:     if (@unsorted_future > 0) {
                   10524:         @sorted_future =
                   10525:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   10526:     }
                   10527:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   10528: }
1.780     raeburn  10529: 
                   10530: =pod
                   10531: 
1.1057    foxr     10532: =back
                   10533: 
1.549     albertel 10534: =head1 HTTP Helpers
                   10535: 
                   10536: =over 4
                   10537: 
1.648     raeburn  10538: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 10539: 
1.258     albertel 10540: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 10541: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 10542: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 10543: 
                   10544: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   10545: $possible_names is an ref to an array of form element names.  As an example:
                   10546: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 10547: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 10548: 
                   10549: =cut
1.1       albertel 10550: 
1.6       albertel 10551: sub get_unprocessed_cgi {
1.25      albertel 10552:   my ($query,$possible_names)= @_;
1.26      matthew  10553:   # $Apache::lonxml::debug=1;
1.356     albertel 10554:   foreach my $pair (split(/&/,$query)) {
                   10555:     my ($name, $value) = split(/=/,$pair);
1.369     www      10556:     $name = &unescape($name);
1.25      albertel 10557:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   10558:       $value =~ tr/+/ /;
                   10559:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 10560:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 10561:     }
1.16      harris41 10562:   }
1.6       albertel 10563: }
                   10564: 
1.112     bowersj2 10565: =pod
                   10566: 
1.648     raeburn  10567: =item * &cacheheader() 
1.112     bowersj2 10568: 
                   10569: returns cache-controlling header code
                   10570: 
                   10571: =cut
                   10572: 
1.7       albertel 10573: sub cacheheader {
1.258     albertel 10574:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 10575:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   10576:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 10577:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   10578:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 10579:     return $output;
1.7       albertel 10580: }
                   10581: 
1.112     bowersj2 10582: =pod
                   10583: 
1.648     raeburn  10584: =item * &no_cache($r) 
1.112     bowersj2 10585: 
                   10586: specifies header code to not have cache
                   10587: 
                   10588: =cut
                   10589: 
1.9       albertel 10590: sub no_cache {
1.216     albertel 10591:     my ($r) = @_;
                   10592:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 10593: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 10594:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   10595:     $r->no_cache(1);
                   10596:     $r->header_out("Expires" => $date);
                   10597:     $r->header_out("Pragma" => "no-cache");
1.123     www      10598: }
                   10599: 
                   10600: sub content_type {
1.181     albertel 10601:     my ($r,$type,$charset) = @_;
1.299     foxr     10602:     if ($r) {
                   10603: 	#  Note that printout.pl calls this with undef for $r.
                   10604: 	&no_cache($r);
                   10605:     }
1.258     albertel 10606:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 10607:     unless ($charset) {
                   10608: 	$charset=&Apache::lonlocal::current_encoding;
                   10609:     }
                   10610:     if ($charset) { $type.='; charset='.$charset; }
                   10611:     if ($r) {
                   10612: 	$r->content_type($type);
                   10613:     } else {
                   10614: 	print("Content-type: $type\n\n");
                   10615:     }
1.9       albertel 10616: }
1.25      albertel 10617: 
1.112     bowersj2 10618: =pod
                   10619: 
1.648     raeburn  10620: =item * &add_to_env($name,$value) 
1.112     bowersj2 10621: 
1.258     albertel 10622: adds $name to the %env hash with value
1.112     bowersj2 10623: $value, if $name already exists, the entry is converted to an array
                   10624: reference and $value is added to the array.
                   10625: 
                   10626: =cut
                   10627: 
1.25      albertel 10628: sub add_to_env {
                   10629:   my ($name,$value)=@_;
1.258     albertel 10630:   if (defined($env{$name})) {
                   10631:     if (ref($env{$name})) {
1.25      albertel 10632:       #already have multiple values
1.258     albertel 10633:       push(@{ $env{$name} },$value);
1.25      albertel 10634:     } else {
                   10635:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 10636:       my $first=$env{$name};
                   10637:       undef($env{$name});
                   10638:       push(@{ $env{$name} },$first,$value);
1.25      albertel 10639:     }
                   10640:   } else {
1.258     albertel 10641:     $env{$name}=$value;
1.25      albertel 10642:   }
1.31      albertel 10643: }
1.149     albertel 10644: 
                   10645: =pod
                   10646: 
1.648     raeburn  10647: =item * &get_env_multiple($name) 
1.149     albertel 10648: 
1.258     albertel 10649: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 10650: values may be defined and end up as an array ref.
                   10651: 
                   10652: returns an array of values
                   10653: 
                   10654: =cut
                   10655: 
                   10656: sub get_env_multiple {
                   10657:     my ($name) = @_;
                   10658:     my @values;
1.258     albertel 10659:     if (defined($env{$name})) {
1.149     albertel 10660:         # exists is it an array
1.258     albertel 10661:         if (ref($env{$name})) {
                   10662:             @values=@{ $env{$name} };
1.149     albertel 10663:         } else {
1.258     albertel 10664:             $values[0]=$env{$name};
1.149     albertel 10665:         }
                   10666:     }
                   10667:     return(@values);
                   10668: }
                   10669: 
1.660     raeburn  10670: sub ask_for_embedded_content {
                   10671:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  10672:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  10673:         %currsubfile,%unused,$rem);
1.1071    raeburn  10674:     my $counter = 0;
                   10675:     my $numnew = 0;
1.987     raeburn  10676:     my $numremref = 0;
                   10677:     my $numinvalid = 0;
                   10678:     my $numpathchg = 0;
                   10679:     my $numexisting = 0;
1.1071    raeburn  10680:     my $numunused = 0;
                   10681:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  10682:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  10683:     my $heading = &mt('Upload embedded files');
                   10684:     my $buttontext = &mt('Upload');
                   10685: 
1.1075.2.11  raeburn  10686:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  10687:         if ($actionurl eq '/adm/dependencies') {
                   10688:             $navmap = Apache::lonnavmaps::navmap->new();
                   10689:         }
                   10690:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10691:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  10692:     }
1.1075.2.35  raeburn  10693:     if (($actionurl eq '/adm/portfolio') ||
                   10694:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  10695:         my $current_path='/';
                   10696:         if ($env{'form.currentpath'}) {
                   10697:             $current_path = $env{'form.currentpath'};
                   10698:         }
                   10699:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  10700:             $udom = $cdom;
                   10701:             $uname = $cnum;
1.984     raeburn  10702:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   10703:         } else {
                   10704:             $udom = $env{'user.domain'};
                   10705:             $uname = $env{'user.name'};
                   10706:             $url = '/userfiles/portfolio';
                   10707:         }
1.987     raeburn  10708:         $toplevel = $url.'/';
1.984     raeburn  10709:         $url .= $current_path;
                   10710:         $getpropath = 1;
1.987     raeburn  10711:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   10712:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      10713:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  10714:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  10715:         $toplevel = $url;
1.984     raeburn  10716:         if ($rest ne '') {
1.987     raeburn  10717:             $url .= $rest;
                   10718:         }
                   10719:     } elsif ($actionurl eq '/adm/coursedocs') {
                   10720:         if (ref($args) eq 'HASH') {
1.1071    raeburn  10721:             $url = $args->{'docs_url'};
                   10722:             $toplevel = $url;
1.1075.2.11  raeburn  10723:             if ($args->{'context'} eq 'paste') {
                   10724:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   10725:                 ($path) =
                   10726:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10727:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10728:                 $fileloc =~ s{^/}{};
                   10729:             }
1.1071    raeburn  10730:         }
                   10731:     } elsif ($actionurl eq '/adm/dependencies') {
                   10732:         if ($env{'request.course.id'} ne '') {
                   10733:             if (ref($args) eq 'HASH') {
                   10734:                 $url = $args->{'docs_url'};
                   10735:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  10736:                 $toplevel = $url;
                   10737:                 unless ($toplevel =~ m{^/}) {
                   10738:                     $toplevel = "/$url";
                   10739:                 }
1.1075.2.11  raeburn  10740:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  10741:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   10742:                     $path = $1;
                   10743:                 } else {
                   10744:                     ($path) =
                   10745:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   10746:                 }
1.1075.2.79  raeburn  10747:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   10748:                     $fileloc = $toplevel;
                   10749:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   10750:                     my ($udom,$uname,$fname) =
                   10751:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   10752:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   10753:                 } else {
                   10754:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   10755:                 }
1.1071    raeburn  10756:                 $fileloc =~ s{^/}{};
                   10757:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   10758:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   10759:             }
1.987     raeburn  10760:         }
1.1075.2.35  raeburn  10761:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10762:         $udom = $cdom;
                   10763:         $uname = $cnum;
                   10764:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   10765:         $toplevel = $url;
                   10766:         $path = $url;
                   10767:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   10768:         $fileloc =~ s{^/}{};
                   10769:     }
                   10770:     foreach my $file (keys(%{$allfiles})) {
                   10771:         my $embed_file;
                   10772:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   10773:             $embed_file = $1;
                   10774:         } else {
                   10775:             $embed_file = $file;
                   10776:         }
1.1075.2.55  raeburn  10777:         my ($absolutepath,$cleaned_file);
                   10778:         if ($embed_file =~ m{^\w+://}) {
                   10779:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  10780:             $newfiles{$cleaned_file} = 1;
                   10781:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10782:         } else {
1.1075.2.55  raeburn  10783:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  10784:             if ($embed_file =~ m{^/}) {
                   10785:                 $absolutepath = $embed_file;
                   10786:             }
1.1075.2.47  raeburn  10787:             if ($cleaned_file =~ m{/}) {
                   10788:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  10789:                 $path = &check_for_traversal($path,$url,$toplevel);
                   10790:                 my $item = $fname;
                   10791:                 if ($path ne '') {
                   10792:                     $item = $path.'/'.$fname;
                   10793:                     $subdependencies{$path}{$fname} = 1;
                   10794:                 } else {
                   10795:                     $dependencies{$item} = 1;
                   10796:                 }
                   10797:                 if ($absolutepath) {
                   10798:                     $mapping{$item} = $absolutepath;
                   10799:                 } else {
                   10800:                     $mapping{$item} = $embed_file;
                   10801:                 }
                   10802:             } else {
                   10803:                 $dependencies{$embed_file} = 1;
                   10804:                 if ($absolutepath) {
1.1075.2.47  raeburn  10805:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  10806:                 } else {
1.1075.2.47  raeburn  10807:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  10808:                 }
                   10809:             }
1.984     raeburn  10810:         }
                   10811:     }
1.1071    raeburn  10812:     my $dirptr = 16384;
1.984     raeburn  10813:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  10814:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  10815:         if (($actionurl eq '/adm/portfolio') ||
                   10816:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  10817:             my ($sublistref,$listerror) =
                   10818:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   10819:             if (ref($sublistref) eq 'ARRAY') {
                   10820:                 foreach my $line (@{$sublistref}) {
                   10821:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  10822:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  10823:                 }
1.984     raeburn  10824:             }
1.987     raeburn  10825:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  10826:             if (opendir(my $dir,$url.'/'.$path)) {
                   10827:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  10828:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   10829:             }
1.1075.2.11  raeburn  10830:         } elsif (($actionurl eq '/adm/dependencies') ||
                   10831:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  10832:                   ($args->{'context'} eq 'paste')) ||
                   10833:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  10834:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  10835:                 my $dir;
                   10836:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   10837:                     $dir = $fileloc;
                   10838:                 } else {
                   10839:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   10840:                 }
1.1071    raeburn  10841:                 if ($dir ne '') {
                   10842:                     my ($sublistref,$listerror) =
                   10843:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   10844:                     if (ref($sublistref) eq 'ARRAY') {
                   10845:                         foreach my $line (@{$sublistref}) {
                   10846:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   10847:                                 undef,$mtime)=split(/\&/,$line,12);
                   10848:                             unless (($testdir&$dirptr) ||
                   10849:                                     ($file_name =~ /^\.\.?$/)) {
                   10850:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   10851:                             }
                   10852:                         }
                   10853:                     }
                   10854:                 }
1.984     raeburn  10855:             }
                   10856:         }
                   10857:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  10858:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  10859:                 my $item = $path.'/'.$file;
                   10860:                 unless ($mapping{$item} eq $item) {
                   10861:                     $pathchanges{$item} = 1;
                   10862:                 }
                   10863:                 $existing{$item} = 1;
                   10864:                 $numexisting ++;
                   10865:             } else {
                   10866:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  10867:             }
                   10868:         }
1.1071    raeburn  10869:         if ($actionurl eq '/adm/dependencies') {
                   10870:             foreach my $path (keys(%currsubfile)) {
                   10871:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   10872:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   10873:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  10874:                              next if (($rem ne '') &&
                   10875:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   10876:                                        (ref($navmap) &&
                   10877:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   10878:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   10879:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  10880:                              $unused{$path.'/'.$file} = 1; 
                   10881:                          }
                   10882:                     }
                   10883:                 }
                   10884:             }
                   10885:         }
1.984     raeburn  10886:     }
1.987     raeburn  10887:     my %currfile;
1.1075.2.35  raeburn  10888:     if (($actionurl eq '/adm/portfolio') ||
                   10889:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  10890:         my ($dirlistref,$listerror) =
                   10891:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   10892:         if (ref($dirlistref) eq 'ARRAY') {
                   10893:             foreach my $line (@{$dirlistref}) {
                   10894:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   10895:                 $currfile{$file_name} = 1;
                   10896:             }
1.984     raeburn  10897:         }
1.987     raeburn  10898:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  10899:         if (opendir(my $dir,$url)) {
1.987     raeburn  10900:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  10901:             map {$currfile{$_} = 1;} @dir_list;
                   10902:         }
1.1075.2.11  raeburn  10903:     } elsif (($actionurl eq '/adm/dependencies') ||
                   10904:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  10905:               ($args->{'context'} eq 'paste')) ||
                   10906:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  10907:         if ($env{'request.course.id'} ne '') {
                   10908:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   10909:             if ($dir ne '') {
                   10910:                 my ($dirlistref,$listerror) =
                   10911:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   10912:                 if (ref($dirlistref) eq 'ARRAY') {
                   10913:                     foreach my $line (@{$dirlistref}) {
                   10914:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   10915:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   10916:                         unless (($testdir&$dirptr) ||
                   10917:                                 ($file_name =~ /^\.\.?$/)) {
                   10918:                             $currfile{$file_name} = [$size,$mtime];
                   10919:                         }
                   10920:                     }
                   10921:                 }
                   10922:             }
                   10923:         }
1.984     raeburn  10924:     }
                   10925:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  10926:         if (exists($currfile{$file})) {
1.987     raeburn  10927:             unless ($mapping{$file} eq $file) {
                   10928:                 $pathchanges{$file} = 1;
                   10929:             }
                   10930:             $existing{$file} = 1;
                   10931:             $numexisting ++;
                   10932:         } else {
1.984     raeburn  10933:             $newfiles{$file} = 1;
                   10934:         }
                   10935:     }
1.1071    raeburn  10936:     foreach my $file (keys(%currfile)) {
                   10937:         unless (($file eq $filename) ||
                   10938:                 ($file eq $filename.'.bak') ||
                   10939:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  10940:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  10941:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   10942:                     next if (($rem ne '') &&
                   10943:                              (($env{"httpref.$rem".$file} ne '') ||
                   10944:                               (ref($navmap) &&
                   10945:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   10946:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   10947:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   10948:                 }
1.1075.2.11  raeburn  10949:             }
1.1071    raeburn  10950:             $unused{$file} = 1;
                   10951:         }
                   10952:     }
1.1075.2.11  raeburn  10953:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   10954:         ($args->{'context'} eq 'paste')) {
                   10955:         $counter = scalar(keys(%existing));
                   10956:         $numpathchg = scalar(keys(%pathchanges));
                   10957:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  10958:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   10959:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   10960:         $counter = scalar(keys(%existing));
                   10961:         $numpathchg = scalar(keys(%pathchanges));
                   10962:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  10963:     }
1.984     raeburn  10964:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  10965:         if ($actionurl eq '/adm/dependencies') {
                   10966:             next if ($embed_file =~ m{^\w+://});
                   10967:         }
1.660     raeburn  10968:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  10969:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  10970:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  10971:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  10972:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   10973:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  10974:         }
1.1075.2.35  raeburn  10975:         $upload_output .= '</td>';
1.1071    raeburn  10976:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  10977:             $upload_output.='<td align="right">'.
                   10978:                             '<span class="LC_info LC_fontsize_medium">'.
                   10979:                             &mt("URL points to web address").'</span>';
1.987     raeburn  10980:             $numremref++;
1.660     raeburn  10981:         } elsif ($args->{'error_on_invalid_names'}
                   10982:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  10983:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   10984:                             &mt('Invalid characters').'</span>';
1.987     raeburn  10985:             $numinvalid++;
1.660     raeburn  10986:         } else {
1.1075.2.35  raeburn  10987:             $upload_output .= '<td>'.
                   10988:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  10989:                                                      $embed_file,\%mapping,
1.1071    raeburn  10990:                                                      $allfiles,$codebase,'upload');
                   10991:             $counter ++;
                   10992:             $numnew ++;
1.987     raeburn  10993:         }
                   10994:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   10995:     }
                   10996:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  10997:         if ($actionurl eq '/adm/dependencies') {
                   10998:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   10999:             $modify_output .= &start_data_table_row().
                   11000:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   11001:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   11002:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   11003:                               '<td>'.$size.'</td>'.
                   11004:                               '<td>'.$mtime.'</td>'.
                   11005:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   11006:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   11007:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   11008:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   11009:                               &embedded_file_element('upload_embedded',$counter,
                   11010:                                                      $embed_file,\%mapping,
                   11011:                                                      $allfiles,$codebase,'modify').
                   11012:                               '</div></td>'.
                   11013:                               &end_data_table_row()."\n";
                   11014:             $counter ++;
                   11015:         } else {
                   11016:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11017:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   11018:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   11019:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  11020:                               &Apache::loncommon::end_data_table_row()."\n";
                   11021:         }
                   11022:     }
                   11023:     my $delidx = $counter;
                   11024:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   11025:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   11026:         $delete_output .= &start_data_table_row().
                   11027:                           '<td><img src="'.&icon($oldfile).'" />'.
                   11028:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   11029:                           '<td>'.$size.'</td>'.
                   11030:                           '<td>'.$mtime.'</td>'.
                   11031:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   11032:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   11033:                           &embedded_file_element('upload_embedded',$delidx,
                   11034:                                                  $oldfile,\%mapping,$allfiles,
                   11035:                                                  $codebase,'delete').'</td>'.
                   11036:                           &end_data_table_row()."\n"; 
                   11037:         $numunused ++;
                   11038:         $delidx ++;
1.987     raeburn  11039:     }
                   11040:     if ($upload_output) {
                   11041:         $upload_output = &start_data_table().
                   11042:                          $upload_output.
                   11043:                          &end_data_table()."\n";
                   11044:     }
1.1071    raeburn  11045:     if ($modify_output) {
                   11046:         $modify_output = &start_data_table().
                   11047:                          &start_data_table_header_row().
                   11048:                          '<th>'.&mt('File').'</th>'.
                   11049:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11050:                          '<th>'.&mt('Modified').'</th>'.
                   11051:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   11052:                          &end_data_table_header_row().
                   11053:                          $modify_output.
                   11054:                          &end_data_table()."\n";
                   11055:     }
                   11056:     if ($delete_output) {
                   11057:         $delete_output = &start_data_table().
                   11058:                          &start_data_table_header_row().
                   11059:                          '<th>'.&mt('File').'</th>'.
                   11060:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11061:                          '<th>'.&mt('Modified').'</th>'.
                   11062:                          '<th>'.&mt('Delete?').'</th>'.
                   11063:                          &end_data_table_header_row().
                   11064:                          $delete_output.
                   11065:                          &end_data_table()."\n";
                   11066:     }
1.987     raeburn  11067:     my $applies = 0;
                   11068:     if ($numremref) {
                   11069:         $applies ++;
                   11070:     }
                   11071:     if ($numinvalid) {
                   11072:         $applies ++;
                   11073:     }
                   11074:     if ($numexisting) {
                   11075:         $applies ++;
                   11076:     }
1.1071    raeburn  11077:     if ($counter || $numunused) {
1.987     raeburn  11078:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   11079:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  11080:                   $state.'<h3>'.$heading.'</h3>'; 
                   11081:         if ($actionurl eq '/adm/dependencies') {
                   11082:             if ($numnew) {
                   11083:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   11084:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   11085:                            $upload_output.'<br />'."\n";
                   11086:             }
                   11087:             if ($numexisting) {
                   11088:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   11089:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   11090:                            $modify_output.'<br />'."\n";
                   11091:                            $buttontext = &mt('Save changes');
                   11092:             }
                   11093:             if ($numunused) {
                   11094:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   11095:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   11096:                            $delete_output.'<br />'."\n";
                   11097:                            $buttontext = &mt('Save changes');
                   11098:             }
                   11099:         } else {
                   11100:             $output .= $upload_output.'<br />'."\n";
                   11101:         }
                   11102:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   11103:                    $counter.'" />'."\n";
                   11104:         if ($actionurl eq '/adm/dependencies') { 
                   11105:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   11106:                        $numnew.'" />'."\n";
                   11107:         } elsif ($actionurl eq '') {
1.987     raeburn  11108:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   11109:         }
                   11110:     } elsif ($applies) {
                   11111:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   11112:         if ($applies > 1) {
                   11113:             $output .=  
1.1075.2.35  raeburn  11114:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  11115:             if ($numremref) {
                   11116:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   11117:             }
                   11118:             if ($numinvalid) {
                   11119:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   11120:             }
                   11121:             if ($numexisting) {
                   11122:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   11123:             }
                   11124:             $output .= '</ul><br />';
                   11125:         } elsif ($numremref) {
                   11126:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   11127:         } elsif ($numinvalid) {
                   11128:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   11129:         } elsif ($numexisting) {
                   11130:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   11131:         }
                   11132:         $output .= $upload_output.'<br />';
                   11133:     }
                   11134:     my ($pathchange_output,$chgcount);
1.1071    raeburn  11135:     $chgcount = $counter;
1.987     raeburn  11136:     if (keys(%pathchanges) > 0) {
                   11137:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  11138:             if ($counter) {
1.987     raeburn  11139:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   11140:                                                   $embed_file,\%mapping,
1.1071    raeburn  11141:                                                   $allfiles,$codebase,'change');
1.987     raeburn  11142:             } else {
                   11143:                 $pathchange_output .= 
                   11144:                     &start_data_table_row().
                   11145:                     '<td><input type ="checkbox" name="namechange" value="'.
                   11146:                     $chgcount.'" checked="checked" /></td>'.
                   11147:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11148:                     '<td>'.$embed_file.
                   11149:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11150:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11151:                     '</td>'.&end_data_table_row();
1.660     raeburn  11152:             }
1.987     raeburn  11153:             $numpathchg ++;
                   11154:             $chgcount ++;
1.660     raeburn  11155:         }
                   11156:     }
1.1075.2.35  raeburn  11157:     if (($counter) || ($numunused)) {
1.987     raeburn  11158:         if ($numpathchg) {
                   11159:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11160:                        $numpathchg.'" />'."\n";
                   11161:         }
                   11162:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11163:             ($actionurl eq '/adm/imsimport')) {
                   11164:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11165:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11166:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11167:         } elsif ($actionurl eq '/adm/dependencies') {
                   11168:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11169:         }
1.1075.2.35  raeburn  11170:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11171:     } elsif ($numpathchg) {
                   11172:         my %pathchange = ();
                   11173:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11174:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11175:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  11176:         }
1.987     raeburn  11177:     }
1.1071    raeburn  11178:     return ($output,$counter,$numpathchg);
1.987     raeburn  11179: }
                   11180: 
1.1075.2.47  raeburn  11181: =pod
                   11182: 
                   11183: =item * clean_path($name)
                   11184: 
                   11185: Performs clean-up of directories, subdirectories and filename in an
                   11186: embedded object, referenced in an HTML file which is being uploaded
                   11187: to a course or portfolio, where
                   11188: "Upload embedded images/multimedia files if HTML file" checkbox was
                   11189: checked.
                   11190: 
                   11191: Clean-up is similar to replacements in lonnet::clean_filename()
                   11192: except each / between sub-directory and next level is preserved.
                   11193: 
                   11194: =cut
                   11195: 
                   11196: sub clean_path {
                   11197:     my ($embed_file) = @_;
                   11198:     $embed_file =~s{^/+}{};
                   11199:     my @contents;
                   11200:     if ($embed_file =~ m{/}) {
                   11201:         @contents = split(/\//,$embed_file);
                   11202:     } else {
                   11203:         @contents = ($embed_file);
                   11204:     }
                   11205:     my $lastidx = scalar(@contents)-1;
                   11206:     for (my $i=0; $i<=$lastidx; $i++) {
                   11207:         $contents[$i]=~s{\\}{/}g;
                   11208:         $contents[$i]=~s/\s+/\_/g;
                   11209:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   11210:         if ($i == $lastidx) {
                   11211:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   11212:         }
                   11213:     }
                   11214:     if ($lastidx > 0) {
                   11215:         return join('/',@contents);
                   11216:     } else {
                   11217:         return $contents[0];
                   11218:     }
                   11219: }
                   11220: 
1.987     raeburn  11221: sub embedded_file_element {
1.1071    raeburn  11222:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  11223:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   11224:                    (ref($codebase) eq 'HASH'));
                   11225:     my $output;
1.1071    raeburn  11226:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  11227:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   11228:     }
                   11229:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   11230:                &escape($embed_file).'" />';
                   11231:     unless (($context eq 'upload_embedded') && 
                   11232:             ($mapping->{$embed_file} eq $embed_file)) {
                   11233:         $output .='
                   11234:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   11235:     }
                   11236:     my $attrib;
                   11237:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   11238:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   11239:     }
                   11240:     $output .=
                   11241:         "\n\t\t".
                   11242:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   11243:         $attrib.'" />';
                   11244:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   11245:         $output .=
                   11246:             "\n\t\t".
                   11247:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   11248:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  11249:     }
1.987     raeburn  11250:     return $output;
1.660     raeburn  11251: }
                   11252: 
1.1071    raeburn  11253: sub get_dependency_details {
                   11254:     my ($currfile,$currsubfile,$embed_file) = @_;
                   11255:     my ($size,$mtime,$showsize,$showmtime);
                   11256:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   11257:         if ($embed_file =~ m{/}) {
                   11258:             my ($path,$fname) = split(/\//,$embed_file);
                   11259:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   11260:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   11261:             }
                   11262:         } else {
                   11263:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   11264:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   11265:             }
                   11266:         }
                   11267:         $showsize = $size/1024.0;
                   11268:         $showsize = sprintf("%.1f",$showsize);
                   11269:         if ($mtime > 0) {
                   11270:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   11271:         }
                   11272:     }
                   11273:     return ($showsize,$showmtime);
                   11274: }
                   11275: 
                   11276: sub ask_embedded_js {
                   11277:     return <<"END";
                   11278: <script type="text/javascript"">
                   11279: // <![CDATA[
                   11280: function toggleBrowse(counter) {
                   11281:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   11282:     var fileid = document.getElementById('embedded_item_'+counter);
                   11283:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   11284:     if (chkboxid.checked == true) {
                   11285:         uploaddivid.style.display='block';
                   11286:     } else {
                   11287:         uploaddivid.style.display='none';
                   11288:         fileid.value = '';
                   11289:     }
                   11290: }
                   11291: // ]]>
                   11292: </script>
                   11293: 
                   11294: END
                   11295: }
                   11296: 
1.661     raeburn  11297: sub upload_embedded {
                   11298:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  11299:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   11300:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  11301:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   11302:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   11303:         my $orig_uploaded_filename =
                   11304:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  11305:         foreach my $type ('orig','ref','attrib','codebase') {
                   11306:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   11307:                 $env{'form.embedded_'.$type.'_'.$i} =
                   11308:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   11309:             }
                   11310:         }
1.661     raeburn  11311:         my ($path,$fname) =
                   11312:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   11313:         # no path, whole string is fname
                   11314:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   11315:         $fname = &Apache::lonnet::clean_filename($fname);
                   11316:         # See if there is anything left
                   11317:         next if ($fname eq '');
                   11318: 
                   11319:         # Check if file already exists as a file or directory.
                   11320:         my ($state,$msg);
                   11321:         if ($context eq 'portfolio') {
                   11322:             my $port_path = $dirpath;
                   11323:             if ($group ne '') {
                   11324:                 $port_path = "groups/$group/$port_path";
                   11325:             }
1.987     raeburn  11326:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   11327:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  11328:                                               $dir_root,$port_path,$disk_quota,
                   11329:                                               $current_disk_usage,$uname,$udom);
                   11330:             if ($state eq 'will_exceed_quota'
1.984     raeburn  11331:                 || $state eq 'file_locked') {
1.661     raeburn  11332:                 $output .= $msg;
                   11333:                 next;
                   11334:             }
                   11335:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   11336:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   11337:             if ($state eq 'exists') {
                   11338:                 $output .= $msg;
                   11339:                 next;
                   11340:             }
                   11341:         }
                   11342:         # Check if extension is valid
                   11343:         if (($fname =~ /\.(\w+)$/) &&
                   11344:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  11345:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   11346:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  11347:             next;
                   11348:         } elsif (($fname =~ /\.(\w+)$/) &&
                   11349:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  11350:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  11351:             next;
                   11352:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  11353:             $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  11354:             next;
                   11355:         }
                   11356:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  11357:         my $subdir = $path;
                   11358:         $subdir =~ s{/+$}{};
1.661     raeburn  11359:         if ($context eq 'portfolio') {
1.984     raeburn  11360:             my $result;
                   11361:             if ($state eq 'existingfile') {
                   11362:                 $result=
                   11363:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  11364:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  11365:             } else {
1.984     raeburn  11366:                 $result=
                   11367:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  11368:                                                     $dirpath.
1.1075.2.35  raeburn  11369:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  11370:                 if ($result !~ m|^/uploaded/|) {
                   11371:                     $output .= '<span class="LC_error">'
                   11372:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11373:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11374:                                .'</span><br />';
                   11375:                     next;
                   11376:                 } else {
1.987     raeburn  11377:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11378:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  11379:                 }
1.661     raeburn  11380:             }
1.1075.2.35  raeburn  11381:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   11382:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   11383:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  11384:             my $result =
1.1075.2.35  raeburn  11385:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  11386:             if ($result !~ m|^/uploaded/|) {
                   11387:                 $output .= '<span class="LC_error">'
                   11388:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11389:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11390:                            .'</span><br />';
                   11391:                     next;
                   11392:             } else {
                   11393:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11394:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  11395:                 if ($context eq 'syllabus') {
                   11396:                     &Apache::lonnet::make_public_indefinitely($result);
                   11397:                 }
1.987     raeburn  11398:             }
1.661     raeburn  11399:         } else {
                   11400: # Save the file
                   11401:             my $target = $env{'form.embedded_item_'.$i};
                   11402:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   11403:             my $dest = $fullpath.$fname;
                   11404:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  11405:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  11406:             my $count;
                   11407:             my $filepath = $dir_root;
1.1027    raeburn  11408:             foreach my $subdir (@parts) {
                   11409:                 $filepath .= "/$subdir";
                   11410:                 if (!-e $filepath) {
1.661     raeburn  11411:                     mkdir($filepath,0770);
                   11412:                 }
                   11413:             }
                   11414:             my $fh;
                   11415:             if (!open($fh,'>'.$dest)) {
                   11416:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11417:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11418:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11419:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11420:                            '</span><br />';
                   11421:             } else {
                   11422:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11423:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11424:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11425:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11426:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11427:                               '</span><br />';
                   11428:                 } else {
1.987     raeburn  11429:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11430:                                $url.'</span>').'<br />';
                   11431:                     unless ($context eq 'testbank') {
                   11432:                         $footer .= &mt('View embedded file: [_1]',
                   11433:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11434:                     }
                   11435:                 }
                   11436:                 close($fh);
                   11437:             }
                   11438:         }
                   11439:         if ($env{'form.embedded_ref_'.$i}) {
                   11440:             $pathchange{$i} = 1;
                   11441:         }
                   11442:     }
                   11443:     if ($output) {
                   11444:         $output = '<p>'.$output.'</p>';
                   11445:     }
                   11446:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11447:     $returnflag = 'ok';
1.1071    raeburn  11448:     my $numpathchgs = scalar(keys(%pathchange));
                   11449:     if ($numpathchgs > 0) {
1.987     raeburn  11450:         if ($context eq 'portfolio') {
                   11451:             $output .= '<p>'.&mt('or').'</p>';
                   11452:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11453:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11454:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11455:             $returnflag = 'modify_orightml';
                   11456:         }
                   11457:     }
1.1071    raeburn  11458:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11459: }
                   11460: 
                   11461: sub modify_html_form {
                   11462:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11463:     my $end = 0;
                   11464:     my $modifyform;
                   11465:     if ($context eq 'upload_embedded') {
                   11466:         return unless (ref($pathchange) eq 'HASH');
                   11467:         if ($env{'form.number_embedded_items'}) {
                   11468:             $end += $env{'form.number_embedded_items'};
                   11469:         }
                   11470:         if ($env{'form.number_pathchange_items'}) {
                   11471:             $end += $env{'form.number_pathchange_items'};
                   11472:         }
                   11473:         if ($end) {
                   11474:             for (my $i=0; $i<$end; $i++) {
                   11475:                 if ($i < $env{'form.number_embedded_items'}) {
                   11476:                     next unless($pathchange->{$i});
                   11477:                 }
                   11478:                 $modifyform .=
                   11479:                     &start_data_table_row().
                   11480:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   11481:                     'checked="checked" /></td>'.
                   11482:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   11483:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   11484:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   11485:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   11486:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   11487:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   11488:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   11489:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   11490:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   11491:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   11492:                     &end_data_table_row();
1.1071    raeburn  11493:             }
1.987     raeburn  11494:         }
                   11495:     } else {
                   11496:         $modifyform = $pathchgtable;
                   11497:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   11498:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   11499:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11500:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   11501:         }
                   11502:     }
                   11503:     if ($modifyform) {
1.1071    raeburn  11504:         if ($actionurl eq '/adm/dependencies') {
                   11505:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   11506:         }
1.987     raeburn  11507:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   11508:                '<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".
                   11509:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   11510:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   11511:                '</ol></p>'."\n".'<p>'.
                   11512:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   11513:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   11514:                &start_data_table()."\n".
                   11515:                &start_data_table_header_row().
                   11516:                '<th>'.&mt('Change?').'</th>'.
                   11517:                '<th>'.&mt('Current reference').'</th>'.
                   11518:                '<th>'.&mt('Required reference').'</th>'.
                   11519:                &end_data_table_header_row()."\n".
                   11520:                $modifyform.
                   11521:                &end_data_table().'<br />'."\n".$hiddenstate.
                   11522:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   11523:                '</form>'."\n";
                   11524:     }
                   11525:     return;
                   11526: }
                   11527: 
                   11528: sub modify_html_refs {
1.1075.2.35  raeburn  11529:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  11530:     my $container;
                   11531:     if ($context eq 'portfolio') {
                   11532:         $container = $env{'form.container'};
                   11533:     } elsif ($context eq 'coursedoc') {
                   11534:         $container = $env{'form.primaryurl'};
1.1071    raeburn  11535:     } elsif ($context eq 'manage_dependencies') {
                   11536:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   11537:         $container = "/$container";
1.1075.2.35  raeburn  11538:     } elsif ($context eq 'syllabus') {
                   11539:         $container = $url;
1.987     raeburn  11540:     } else {
1.1027    raeburn  11541:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  11542:     }
                   11543:     my (%allfiles,%codebase,$output,$content);
                   11544:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  11545:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  11546:         if (wantarray) {
                   11547:             return ('',0,0); 
                   11548:         } else {
                   11549:             return;
                   11550:         }
                   11551:     }
                   11552:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11553:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  11554:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   11555:             if (wantarray) {
                   11556:                 return ('',0,0);
                   11557:             } else {
                   11558:                 return;
                   11559:             }
                   11560:         } 
1.987     raeburn  11561:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  11562:         if ($content eq '-1') {
                   11563:             if (wantarray) {
                   11564:                 return ('',0,0);
                   11565:             } else {
                   11566:                 return;
                   11567:             }
                   11568:         }
1.987     raeburn  11569:     } else {
1.1071    raeburn  11570:         unless ($container =~ /^\Q$dir_root\E/) {
                   11571:             if (wantarray) {
                   11572:                 return ('',0,0);
                   11573:             } else {
                   11574:                 return;
                   11575:             }
                   11576:         } 
1.1075.2.128  raeburn  11577:         if (open(my $fh,'<',$container)) {
1.987     raeburn  11578:             $content = join('', <$fh>);
                   11579:             close($fh);
                   11580:         } else {
1.1071    raeburn  11581:             if (wantarray) {
                   11582:                 return ('',0,0);
                   11583:             } else {
                   11584:                 return;
                   11585:             }
1.987     raeburn  11586:         }
                   11587:     }
                   11588:     my ($count,$codebasecount) = (0,0);
                   11589:     my $mm = new File::MMagic;
                   11590:     my $mime_type = $mm->checktype_contents($content);
                   11591:     if ($mime_type eq 'text/html') {
                   11592:         my $parse_result = 
                   11593:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   11594:                                                     \%codebase,\$content);
                   11595:         if ($parse_result eq 'ok') {
                   11596:             foreach my $i (@changes) {
                   11597:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   11598:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   11599:                 if ($allfiles{$ref}) {
                   11600:                     my $newname =  $orig;
                   11601:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  11602:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  11603:                     if ($attrib_regexp =~ /:/) {
                   11604:                         $attrib_regexp =~ s/\:/|/g;
                   11605:                     }
                   11606:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11607:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11608:                         $count += $numchg;
1.1075.2.35  raeburn  11609:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  11610:                         delete($allfiles{$ref});
1.987     raeburn  11611:                     }
                   11612:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  11613:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  11614:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   11615:                         $codebasecount ++;
                   11616:                     }
                   11617:                 }
                   11618:             }
1.1075.2.35  raeburn  11619:             my $skiprewrites;
1.987     raeburn  11620:             if ($count || $codebasecount) {
                   11621:                 my $saveresult;
1.1071    raeburn  11622:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11623:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  11624:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11625:                     if ($url eq $container) {
                   11626:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   11627:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11628:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  11629:                                             $fname.'</span>').'</p>';
1.987     raeburn  11630:                     } else {
                   11631:                          $output = '<p class="LC_error">'.
                   11632:                                    &mt('Error: update failed for: [_1].',
                   11633:                                    '<span class="LC_filename">'.
                   11634:                                    $container.'</span>').'</p>';
                   11635:                     }
1.1075.2.35  raeburn  11636:                     if ($context eq 'syllabus') {
                   11637:                         unless ($saveresult eq 'ok') {
                   11638:                             $skiprewrites = 1;
                   11639:                         }
                   11640:                     }
1.987     raeburn  11641:                 } else {
1.1075.2.128  raeburn  11642:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  11643:                         print $fh $content;
                   11644:                         close($fh);
                   11645:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11646:                                   $count,'<span class="LC_filename">'.
                   11647:                                   $container.'</span>').'</p>';
1.661     raeburn  11648:                     } else {
1.987     raeburn  11649:                          $output = '<p class="LC_error">'.
                   11650:                                    &mt('Error: could not update [_1].',
                   11651:                                    '<span class="LC_filename">'.
                   11652:                                    $container.'</span>').'</p>';
1.661     raeburn  11653:                     }
                   11654:                 }
                   11655:             }
1.1075.2.35  raeburn  11656:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   11657:                 my ($actionurl,$state);
                   11658:                 $actionurl = "/public/$udom/$uname/syllabus";
                   11659:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   11660:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   11661:                                               \%codebase,
                   11662:                                               {'context' => 'rewrites',
                   11663:                                                'ignore_remote_references' => 1,});
                   11664:                 if (ref($mapping) eq 'HASH') {
                   11665:                     my $rewrites = 0;
                   11666:                     foreach my $key (keys(%{$mapping})) {
                   11667:                         next if ($key =~ m{^https?://});
                   11668:                         my $ref = $mapping->{$key};
                   11669:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   11670:                         my $attrib;
                   11671:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   11672:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   11673:                         }
                   11674:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11675:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11676:                             $rewrites += $numchg;
                   11677:                         }
                   11678:                     }
                   11679:                     if ($rewrites) {
                   11680:                         my $saveresult;
                   11681:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11682:                         if ($url eq $container) {
                   11683:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   11684:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   11685:                                             $count,'<span class="LC_filename">'.
                   11686:                                             $fname.'</span>').'</p>';
                   11687:                         } else {
                   11688:                             $output .= '<p class="LC_error">'.
                   11689:                                        &mt('Error: could not update links in [_1].',
                   11690:                                        '<span class="LC_filename">'.
                   11691:                                        $container.'</span>').'</p>';
                   11692: 
                   11693:                         }
                   11694:                     }
                   11695:                 }
                   11696:             }
1.987     raeburn  11697:         } else {
                   11698:             &logthis('Failed to parse '.$container.
                   11699:                      ' to modify references: '.$parse_result);
1.661     raeburn  11700:         }
                   11701:     }
1.1071    raeburn  11702:     if (wantarray) {
                   11703:         return ($output,$count,$codebasecount);
                   11704:     } else {
                   11705:         return $output;
                   11706:     }
1.661     raeburn  11707: }
                   11708: 
                   11709: sub check_for_existing {
                   11710:     my ($path,$fname,$element) = @_;
                   11711:     my ($state,$msg);
                   11712:     if (-d $path.'/'.$fname) {
                   11713:         $state = 'exists';
                   11714:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11715:     } elsif (-e $path.'/'.$fname) {
                   11716:         $state = 'exists';
                   11717:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   11718:     }
                   11719:     if ($state eq 'exists') {
                   11720:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   11721:     }
                   11722:     return ($state,$msg);
                   11723: }
                   11724: 
                   11725: sub check_for_upload {
                   11726:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   11727:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  11728:     my $filesize = length($env{'form.'.$element});
                   11729:     if (!$filesize) {
                   11730:         my $msg = '<span class="LC_error">'.
                   11731:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   11732:                       '<span class="LC_filename">'.$fname.'</span>',
                   11733:                       $filesize).'<br />'.
1.1007    raeburn  11734:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  11735:                   '</span>';
                   11736:         return ('zero_bytes',$msg);
                   11737:     }
                   11738:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  11739:     my $getpropath = 1;
1.1021    raeburn  11740:     my ($dirlistref,$listerror) =
                   11741:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  11742:     my $found_file = 0;
                   11743:     my $locked_file = 0;
1.991     raeburn  11744:     my @lockers;
                   11745:     my $navmap;
                   11746:     if ($env{'request.course.id'}) {
                   11747:         $navmap = Apache::lonnavmaps::navmap->new();
                   11748:     }
1.1021    raeburn  11749:     if (ref($dirlistref) eq 'ARRAY') {
                   11750:         foreach my $line (@{$dirlistref}) {
                   11751:             my ($file_name,$rest)=split(/\&/,$line,2);
                   11752:             if ($file_name eq $fname){
                   11753:                 $file_name = $path.$file_name;
                   11754:                 if ($group ne '') {
                   11755:                     $file_name = $group.$file_name;
                   11756:                 }
                   11757:                 $found_file = 1;
                   11758:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   11759:                     foreach my $lock (@lockers) {
                   11760:                         if (ref($lock) eq 'ARRAY') {
                   11761:                             my ($symb,$crsid) = @{$lock};
                   11762:                             if ($crsid eq $env{'request.course.id'}) {
                   11763:                                 if (ref($navmap)) {
                   11764:                                     my $res = $navmap->getBySymb($symb);
                   11765:                                     foreach my $part (@{$res->parts()}) { 
                   11766:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   11767:                                         unless (($slot_status == $res->RESERVED) ||
                   11768:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   11769:                                             $locked_file = 1;
                   11770:                                         }
1.991     raeburn  11771:                                     }
1.1021    raeburn  11772:                                 } else {
                   11773:                                     $locked_file = 1;
1.991     raeburn  11774:                                 }
                   11775:                             } else {
                   11776:                                 $locked_file = 1;
                   11777:                             }
                   11778:                         }
1.1021    raeburn  11779:                    }
                   11780:                 } else {
                   11781:                     my @info = split(/\&/,$rest);
                   11782:                     my $currsize = $info[6]/1000;
                   11783:                     if ($currsize < $filesize) {
                   11784:                         my $extra = $filesize - $currsize;
                   11785:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  11786:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  11787:                                       &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  11788:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   11789:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   11790:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  11791:                             return ('will_exceed_quota',$msg);
                   11792:                         }
1.984     raeburn  11793:                     }
                   11794:                 }
1.661     raeburn  11795:             }
                   11796:         }
                   11797:     }
                   11798:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  11799:         my $msg = '<p class="LC_warning">'.
                   11800:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   11801:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  11802:         return ('will_exceed_quota',$msg);
                   11803:     } elsif ($found_file) {
                   11804:         if ($locked_file) {
1.1075.2.69  raeburn  11805:             my $msg = '<p class="LC_warning">';
1.661     raeburn  11806:             $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  11807:             $msg .= '</p>';
1.661     raeburn  11808:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   11809:             return ('file_locked',$msg);
                   11810:         } else {
1.1075.2.69  raeburn  11811:             my $msg = '<p class="LC_error">';
1.984     raeburn  11812:             $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  11813:             $msg .= '</p>';
1.984     raeburn  11814:             return ('existingfile',$msg);
1.661     raeburn  11815:         }
                   11816:     }
                   11817: }
                   11818: 
1.987     raeburn  11819: sub check_for_traversal {
                   11820:     my ($path,$url,$toplevel) = @_;
                   11821:     my @parts=split(/\//,$path);
                   11822:     my $cleanpath;
                   11823:     my $fullpath = $url;
                   11824:     for (my $i=0;$i<@parts;$i++) {
                   11825:         next if ($parts[$i] eq '.');
                   11826:         if ($parts[$i] eq '..') {
                   11827:             $fullpath =~ s{([^/]+/)$}{};
                   11828:         } else {
                   11829:             $fullpath .= $parts[$i].'/';
                   11830:         }
                   11831:     }
                   11832:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   11833:         $cleanpath = $1;
                   11834:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   11835:         my $curr_toprel = $1;
                   11836:         my @parts = split(/\//,$curr_toprel);
                   11837:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   11838:         my @urlparts = split(/\//,$url_toprel);
                   11839:         my $doubledots;
                   11840:         my $startdiff = -1;
                   11841:         for (my $i=0; $i<@urlparts; $i++) {
                   11842:             if ($startdiff == -1) {
                   11843:                 unless ($urlparts[$i] eq $parts[$i]) {
                   11844:                     $startdiff = $i;
                   11845:                     $doubledots .= '../';
                   11846:                 }
                   11847:             } else {
                   11848:                 $doubledots .= '../';
                   11849:             }
                   11850:         }
                   11851:         if ($startdiff > -1) {
                   11852:             $cleanpath = $doubledots;
                   11853:             for (my $i=$startdiff; $i<@parts; $i++) {
                   11854:                 $cleanpath .= $parts[$i].'/';
                   11855:             }
                   11856:         }
                   11857:     }
                   11858:     $cleanpath =~ s{(/)$}{};
                   11859:     return $cleanpath;
                   11860: }
1.31      albertel 11861: 
1.1053    raeburn  11862: sub is_archive_file {
                   11863:     my ($mimetype) = @_;
                   11864:     if (($mimetype eq 'application/octet-stream') ||
                   11865:         ($mimetype eq 'application/x-stuffit') ||
                   11866:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   11867:         return 1;
                   11868:     }
                   11869:     return;
                   11870: }
                   11871: 
                   11872: sub decompress_form {
1.1065    raeburn  11873:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  11874:     my %lt = &Apache::lonlocal::texthash (
                   11875:         this => 'This file is an archive file.',
1.1067    raeburn  11876:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  11877:         itsc => 'Its contents are as follows:',
1.1053    raeburn  11878:         youm => 'You may wish to extract its contents.',
                   11879:         extr => 'Extract contents',
1.1067    raeburn  11880:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   11881:         proa => 'Process automatically?',
1.1053    raeburn  11882:         yes  => 'Yes',
                   11883:         no   => 'No',
1.1067    raeburn  11884:         fold => 'Title for folder containing movie',
                   11885:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  11886:     );
1.1065    raeburn  11887:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  11888:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  11889:     my $info = &list_archive_contents($fileloc,\@paths);
                   11890:     if (@paths) {
                   11891:         foreach my $path (@paths) {
                   11892:             $path =~ s{^/}{};
1.1067    raeburn  11893:             if ($path =~ m{^([^/]+)/$}) {
                   11894:                 $topdir = $1;
                   11895:             }
1.1065    raeburn  11896:             if ($path =~ m{^([^/]+)/}) {
                   11897:                 $toplevel{$1} = $path;
                   11898:             } else {
                   11899:                 $toplevel{$path} = $path;
                   11900:             }
                   11901:         }
                   11902:     }
1.1067    raeburn  11903:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  11904:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  11905:                         "$topdir/media/",
                   11906:                         "$topdir/media/$topdir.mp4",
                   11907:                         "$topdir/media/FirstFrame.png",
                   11908:                         "$topdir/media/player.swf",
                   11909:                         "$topdir/media/swfobject.js",
                   11910:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  11911:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  11912:                          "$topdir/$topdir.mp4",
                   11913:                          "$topdir/$topdir\_config.xml",
                   11914:                          "$topdir/$topdir\_controller.swf",
                   11915:                          "$topdir/$topdir\_embed.css",
                   11916:                          "$topdir/$topdir\_First_Frame.png",
                   11917:                          "$topdir/$topdir\_player.html",
                   11918:                          "$topdir/$topdir\_Thumbnails.png",
                   11919:                          "$topdir/playerProductInstall.swf",
                   11920:                          "$topdir/scripts/",
                   11921:                          "$topdir/scripts/config_xml.js",
                   11922:                          "$topdir/scripts/handlebars.js",
                   11923:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   11924:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   11925:                          "$topdir/scripts/modernizr.js",
                   11926:                          "$topdir/scripts/player-min.js",
                   11927:                          "$topdir/scripts/swfobject.js",
                   11928:                          "$topdir/skins/",
                   11929:                          "$topdir/skins/configuration_express.xml",
                   11930:                          "$topdir/skins/express_show/",
                   11931:                          "$topdir/skins/express_show/player-min.css",
                   11932:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  11933:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   11934:                          "$topdir/$topdir.mp4",
                   11935:                          "$topdir/$topdir\_config.xml",
                   11936:                          "$topdir/$topdir\_controller.swf",
                   11937:                          "$topdir/$topdir\_embed.css",
                   11938:                          "$topdir/$topdir\_First_Frame.png",
                   11939:                          "$topdir/$topdir\_player.html",
                   11940:                          "$topdir/$topdir\_Thumbnails.png",
                   11941:                          "$topdir/playerProductInstall.swf",
                   11942:                          "$topdir/scripts/",
                   11943:                          "$topdir/scripts/config_xml.js",
                   11944:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   11945:                          "$topdir/skins/",
                   11946:                          "$topdir/skins/configuration_express.xml",
                   11947:                          "$topdir/skins/express_show/",
                   11948:                          "$topdir/skins/express_show/spritesheet.min.css",
                   11949:                          "$topdir/skins/express_show/spritesheet.png",
                   11950:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  11951:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  11952:         if (@diffs == 0) {
1.1075.2.59  raeburn  11953:             $is_camtasia = 6;
                   11954:         } else {
1.1075.2.81  raeburn  11955:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  11956:             if (@diffs == 0) {
                   11957:                 $is_camtasia = 8;
1.1075.2.81  raeburn  11958:             } else {
                   11959:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   11960:                 if (@diffs == 0) {
                   11961:                     $is_camtasia = 8;
                   11962:                 }
1.1075.2.59  raeburn  11963:             }
1.1067    raeburn  11964:         }
                   11965:     }
                   11966:     my $output;
                   11967:     if ($is_camtasia) {
                   11968:         $output = <<"ENDCAM";
                   11969: <script type="text/javascript" language="Javascript">
                   11970: // <![CDATA[
                   11971: 
                   11972: function camtasiaToggle() {
                   11973:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   11974:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  11975:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  11976:                 document.getElementById('camtasia_titles').style.display='block';
                   11977:             } else {
                   11978:                 document.getElementById('camtasia_titles').style.display='none';
                   11979:             }
                   11980:         }
                   11981:     }
                   11982:     return;
                   11983: }
                   11984: 
                   11985: // ]]>
                   11986: </script>
                   11987: <p>$lt{'camt'}</p>
                   11988: ENDCAM
1.1065    raeburn  11989:     } else {
1.1067    raeburn  11990:         $output = '<p>'.$lt{'this'};
                   11991:         if ($info eq '') {
                   11992:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   11993:         } else {
                   11994:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   11995:                        '<div><pre>'.$info.'</pre></div>';
                   11996:         }
1.1065    raeburn  11997:     }
1.1067    raeburn  11998:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  11999:     my $duplicates;
                   12000:     my $num = 0;
                   12001:     if (ref($dirlist) eq 'ARRAY') {
                   12002:         foreach my $item (@{$dirlist}) {
                   12003:             if (ref($item) eq 'ARRAY') {
                   12004:                 if (exists($toplevel{$item->[0]})) {
                   12005:                     $duplicates .= 
                   12006:                         &start_data_table_row().
                   12007:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12008:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   12009:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12010:                         'value="1" />'.&mt('Yes').'</label>'.
                   12011:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   12012:                         '<td>'.$item->[0].'</td>';
                   12013:                     if ($item->[2]) {
                   12014:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   12015:                     } else {
                   12016:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   12017:                     }
                   12018:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   12019:                                    '<td>'.
                   12020:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   12021:                                    '</td>'.
                   12022:                                    &end_data_table_row();
                   12023:                     $num ++;
                   12024:                 }
                   12025:             }
                   12026:         }
                   12027:     }
                   12028:     my $itemcount;
                   12029:     if (@paths > 0) {
                   12030:         $itemcount = scalar(@paths);
                   12031:     } else {
                   12032:         $itemcount = 1;
                   12033:     }
1.1067    raeburn  12034:     if ($is_camtasia) {
                   12035:         $output .= $lt{'auto'}.'<br />'.
                   12036:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  12037:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  12038:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   12039:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   12040:                    $lt{'no'}.'</label></span><br />'.
                   12041:                    '<div id="camtasia_titles" style="display:block">'.
                   12042:                    &Apache::lonhtmlcommon::start_pick_box().
                   12043:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   12044:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   12045:                    &Apache::lonhtmlcommon::row_closure().
                   12046:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   12047:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   12048:                    &Apache::lonhtmlcommon::row_closure(1).
                   12049:                    &Apache::lonhtmlcommon::end_pick_box().
                   12050:                    '</div>';
                   12051:     }
1.1065    raeburn  12052:     $output .= 
                   12053:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  12054:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   12055:         "\n";
1.1065    raeburn  12056:     if ($duplicates ne '') {
                   12057:         $output .= '<p><span class="LC_warning">'.
                   12058:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   12059:                    &start_data_table().
                   12060:                    &start_data_table_header_row().
                   12061:                    '<th>'.&mt('Overwrite?').'</th>'.
                   12062:                    '<th>'.&mt('Name').'</th>'.
                   12063:                    '<th>'.&mt('Type').'</th>'.
                   12064:                    '<th>'.&mt('Size').'</th>'.
                   12065:                    '<th>'.&mt('Last modified').'</th>'.
                   12066:                    &end_data_table_header_row().
                   12067:                    $duplicates.
                   12068:                    &end_data_table().
                   12069:                    '</p>';
                   12070:     }
1.1067    raeburn  12071:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  12072:     if (ref($hiddenelements) eq 'HASH') {
                   12073:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   12074:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   12075:         }
                   12076:     }
                   12077:     $output .= <<"END";
1.1067    raeburn  12078: <br />
1.1053    raeburn  12079: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   12080: </form>
                   12081: $noextract
                   12082: END
                   12083:     return $output;
                   12084: }
                   12085: 
1.1065    raeburn  12086: sub decompression_utility {
                   12087:     my ($program) = @_;
                   12088:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   12089:     my $location;
                   12090:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   12091:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   12092:                          '/usr/sbin/') {
                   12093:             if (-x $dir.$program) {
                   12094:                 $location = $dir.$program;
                   12095:                 last;
                   12096:             }
                   12097:         }
                   12098:     }
                   12099:     return $location;
                   12100: }
                   12101: 
                   12102: sub list_archive_contents {
                   12103:     my ($file,$pathsref) = @_;
                   12104:     my (@cmd,$output);
                   12105:     my $needsregexp;
                   12106:     if ($file =~ /\.zip$/) {
                   12107:         @cmd = (&decompression_utility('unzip'),"-l");
                   12108:         $needsregexp = 1;
                   12109:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   12110:              ($file =~ /\.tgz$/)) {
                   12111:         @cmd = (&decompression_utility('tar'),"-ztf");
                   12112:     } elsif ($file =~ /\.tar\.bz2$/) {
                   12113:         @cmd = (&decompression_utility('tar'),"-jtf");
                   12114:     } elsif ($file =~ m|\.tar$|) {
                   12115:         @cmd = (&decompression_utility('tar'),"-tf");
                   12116:     }
                   12117:     if (@cmd) {
                   12118:         undef($!);
                   12119:         undef($@);
                   12120:         if (open(my $fh,"-|", @cmd, $file)) {
                   12121:             while (my $line = <$fh>) {
                   12122:                 $output .= $line;
                   12123:                 chomp($line);
                   12124:                 my $item;
                   12125:                 if ($needsregexp) {
                   12126:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   12127:                 } else {
                   12128:                     $item = $line;
                   12129:                 }
                   12130:                 if ($item ne '') {
                   12131:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   12132:                         push(@{$pathsref},$item);
                   12133:                     } 
                   12134:                 }
                   12135:             }
                   12136:             close($fh);
                   12137:         }
                   12138:     }
                   12139:     return $output;
                   12140: }
                   12141: 
1.1053    raeburn  12142: sub decompress_uploaded_file {
                   12143:     my ($file,$dir) = @_;
                   12144:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   12145:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   12146:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   12147:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12148:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12149:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12150:     my $decompressed = $env{'cgi.decompressed'};
                   12151:     &Apache::lonnet::delenv('cgi.file');
                   12152:     &Apache::lonnet::delenv('cgi.dir');
                   12153:     &Apache::lonnet::delenv('cgi.decompressed');
                   12154:     return ($decompressed,$result);
                   12155: }
                   12156: 
1.1055    raeburn  12157: sub process_decompression {
                   12158:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12159:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12160:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12161:                &mt('Unexpected file path.').'</p>'."\n";
                   12162:     }
                   12163:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12164:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12165:                &mt('Unexpected course context.').'</p>'."\n";
                   12166:     }
                   12167:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12168:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12169:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12170:     }
1.1055    raeburn  12171:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12172:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12173:         $error = &mt('Filename not a supported archive file type.').
                   12174:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12175:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   12176:     } else {
                   12177:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12178:         if ($docuhome eq 'no_host') {
                   12179:             $error = &mt('Could not determine home server for course.');
                   12180:         } else {
                   12181:             my @ids=&Apache::lonnet::current_machine_ids();
                   12182:             my $currdir = "$dir_root/$destination";
                   12183:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12184:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   12185:                        "$dir_root/$destination";
                   12186:             } else {
                   12187:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   12188:                        "$dir_root/$docudom/$docuname/$destination";
                   12189:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   12190:                     $error = &mt('Archive file not found.');
                   12191:                 }
                   12192:             }
1.1065    raeburn  12193:             my (@to_overwrite,@to_skip);
                   12194:             if ($env{'form.archive_overwrite_total'} > 0) {
                   12195:                 my $total = $env{'form.archive_overwrite_total'};
                   12196:                 for (my $i=0; $i<$total; $i++) {
                   12197:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   12198:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   12199:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   12200:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   12201:                     }
                   12202:                 }
                   12203:             }
                   12204:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  12205:             my $numoverwrite = scalar(@to_overwrite);
                   12206:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  12207:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   12208:             } elsif ($dir eq '') {
1.1055    raeburn  12209:                 $error = &mt('Directory containing archive file unavailable.');
                   12210:             } elsif (!$error) {
1.1065    raeburn  12211:                 my ($decompressed,$display);
1.1075.2.128  raeburn  12212:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  12213:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   12214:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  12215:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   12216:                         ($decompressed,$display) =
                   12217:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   12218:                         foreach my $item (@to_skip) {
                   12219:                             if (($item ne '') && ($item !~ /\.\./)) {
                   12220:                                 if (-f "$dir/$tempdir/$item") {
                   12221:                                     unlink("$dir/$tempdir/$item");
                   12222:                                 } elsif (-d "$dir/$tempdir/$item") {
                   12223:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   12224:                                 }
                   12225:                             }
                   12226:                         }
                   12227:                         foreach my $item (@to_overwrite) {
                   12228:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   12229:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   12230:                                     if (-f "$dir/$item") {
                   12231:                                         unlink("$dir/$item");
                   12232:                                     } elsif (-d "$dir/$item") {
                   12233:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   12234:                                     }
                   12235:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   12236:                                 }
1.1065    raeburn  12237:                             }
                   12238:                         }
1.1075.2.128  raeburn  12239:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   12240:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   12241:                         }
1.1065    raeburn  12242:                     }
                   12243:                 } else {
                   12244:                     ($decompressed,$display) = 
                   12245:                         &decompress_uploaded_file($file,$dir);
                   12246:                 }
1.1055    raeburn  12247:                 if ($decompressed eq 'ok') {
1.1065    raeburn  12248:                     $output = '<p class="LC_info">'.
                   12249:                               &mt('Files extracted successfully from archive.').
                   12250:                               '</p>'."\n";
1.1055    raeburn  12251:                     my ($warning,$result,@contents);
                   12252:                     my ($newdirlistref,$newlisterror) =
                   12253:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   12254:                                                  $docuname,1);
                   12255:                     my (%is_dir,%changes,@newitems);
                   12256:                     my $dirptr = 16384;
1.1065    raeburn  12257:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  12258:                         foreach my $dir_line (@{$newdirlistref}) {
                   12259:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  12260:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  12261:                                 push(@newitems,$item);
                   12262:                                 if ($dirptr&$testdir) {
                   12263:                                     $is_dir{$item} = 1;
                   12264:                                 }
                   12265:                                 $changes{$item} = 1;
                   12266:                             }
                   12267:                         }
                   12268:                     }
                   12269:                     if (keys(%changes) > 0) {
                   12270:                         foreach my $item (sort(@newitems)) {
                   12271:                             if ($changes{$item}) {
                   12272:                                 push(@contents,$item);
                   12273:                             }
                   12274:                         }
                   12275:                     }
                   12276:                     if (@contents > 0) {
1.1067    raeburn  12277:                         my $wantform;
                   12278:                         unless ($env{'form.autoextract_camtasia'}) {
                   12279:                             $wantform = 1;
                   12280:                         }
1.1056    raeburn  12281:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  12282:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   12283:                                                                 $currdir,\%is_dir,
                   12284:                                                                 \%children,\%parent,
1.1056    raeburn  12285:                                                                 \@contents,\%dirorder,
                   12286:                                                                 \%titles,$wantform);
1.1055    raeburn  12287:                         if ($datatable ne '') {
                   12288:                             $output .= &archive_options_form('decompressed',$datatable,
                   12289:                                                              $count,$hiddenelem);
1.1065    raeburn  12290:                             my $startcount = 6;
1.1055    raeburn  12291:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  12292:                                                            \%titles,\%children);
1.1055    raeburn  12293:                         }
1.1067    raeburn  12294:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  12295:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  12296:                             my %displayed;
                   12297:                             my $total = 1;
                   12298:                             $env{'form.archive_directory'} = [];
                   12299:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   12300:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   12301:                                 $path =~ s{/$}{};
                   12302:                                 my $item;
                   12303:                                 if ($path ne '') {
                   12304:                                     $item = "$path/$titles{$i}";
                   12305:                                 } else {
                   12306:                                     $item = $titles{$i};
                   12307:                                 }
                   12308:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   12309:                                 if ($item eq $contents[0]) {
                   12310:                                     push(@{$env{'form.archive_directory'}},$i);
                   12311:                                     $env{'form.archive_'.$i} = 'display';
                   12312:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   12313:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  12314:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   12315:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  12316:                                     $env{'form.archive_'.$i} = 'display';
                   12317:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   12318:                                     $displayed{'web'} = $i;
                   12319:                                 } else {
1.1075.2.59  raeburn  12320:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   12321:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   12322:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  12323:                                         push(@{$env{'form.archive_directory'}},$i);
                   12324:                                     }
                   12325:                                     $env{'form.archive_'.$i} = 'dependency';
                   12326:                                 }
                   12327:                                 $total ++;
                   12328:                             }
                   12329:                             for (my $i=1; $i<$total; $i++) {
                   12330:                                 next if ($i == $displayed{'web'});
                   12331:                                 next if ($i == $displayed{'folder'});
                   12332:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   12333:                             }
                   12334:                             $env{'form.phase'} = 'decompress_cleanup';
                   12335:                             $env{'form.archivedelete'} = 1;
                   12336:                             $env{'form.archive_count'} = $total-1;
                   12337:                             $output .=
                   12338:                                 &process_extracted_files('coursedocs',$docudom,
                   12339:                                                          $docuname,$destination,
                   12340:                                                          $dir_root,$hiddenelem);
                   12341:                         }
1.1055    raeburn  12342:                     } else {
                   12343:                         $warning = &mt('No new items extracted from archive file.');
                   12344:                     }
                   12345:                 } else {
                   12346:                     $output = $display;
                   12347:                     $error = &mt('An error occurred during extraction from the archive file.');
                   12348:                 }
                   12349:             }
                   12350:         }
                   12351:     }
                   12352:     if ($error) {
                   12353:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12354:                    $error.'</p>'."\n";
                   12355:     }
                   12356:     if ($warning) {
                   12357:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12358:     }
                   12359:     return $output;
                   12360: }
                   12361: 
                   12362: sub get_extracted {
1.1056    raeburn  12363:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   12364:         $titles,$wantform) = @_;
1.1055    raeburn  12365:     my $count = 0;
                   12366:     my $depth = 0;
                   12367:     my $datatable;
1.1056    raeburn  12368:     my @hierarchy;
1.1055    raeburn  12369:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  12370:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   12371:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  12372:     foreach my $item (@{$contents}) {
                   12373:         $count ++;
1.1056    raeburn  12374:         @{$dirorder->{$count}} = @hierarchy;
                   12375:         $titles->{$count} = $item;
1.1055    raeburn  12376:         &archive_hierarchy($depth,$count,$parent,$children);
                   12377:         if ($wantform) {
                   12378:             $datatable .= &archive_row($is_dir->{$item},$item,
                   12379:                                        $currdir,$depth,$count);
                   12380:         }
                   12381:         if ($is_dir->{$item}) {
                   12382:             $depth ++;
1.1056    raeburn  12383:             push(@hierarchy,$count);
                   12384:             $parent->{$depth} = $count;
1.1055    raeburn  12385:             $datatable .=
                   12386:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  12387:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   12388:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  12389:             $depth --;
1.1056    raeburn  12390:             pop(@hierarchy);
1.1055    raeburn  12391:         }
                   12392:     }
                   12393:     return ($count,$datatable);
                   12394: }
                   12395: 
                   12396: sub recurse_extracted_archive {
1.1056    raeburn  12397:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   12398:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  12399:     my $result='';
1.1056    raeburn  12400:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   12401:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   12402:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  12403:         return $result;
                   12404:     }
                   12405:     my $dirptr = 16384;
                   12406:     my ($newdirlistref,$newlisterror) =
                   12407:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   12408:     if (ref($newdirlistref) eq 'ARRAY') {
                   12409:         foreach my $dir_line (@{$newdirlistref}) {
                   12410:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   12411:             unless ($item =~ /^\.+$/) {
                   12412:                 $$count ++;
1.1056    raeburn  12413:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   12414:                 $titles->{$$count} = $item;
1.1055    raeburn  12415:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  12416: 
1.1055    raeburn  12417:                 my $is_dir;
                   12418:                 if ($dirptr&$testdir) {
                   12419:                     $is_dir = 1;
                   12420:                 }
                   12421:                 if ($wantform) {
                   12422:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   12423:                 }
                   12424:                 if ($is_dir) {
                   12425:                     $$depth ++;
1.1056    raeburn  12426:                     push(@{$hierarchy},$$count);
                   12427:                     $parent->{$$depth} = $$count;
1.1055    raeburn  12428:                     $result .=
                   12429:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   12430:                                                    $docuname,$depth,$count,
1.1056    raeburn  12431:                                                    $hierarchy,$dirorder,$children,
                   12432:                                                    $parent,$titles,$wantform);
1.1055    raeburn  12433:                     $$depth --;
1.1056    raeburn  12434:                     pop(@{$hierarchy});
1.1055    raeburn  12435:                 }
                   12436:             }
                   12437:         }
                   12438:     }
                   12439:     return $result;
                   12440: }
                   12441: 
                   12442: sub archive_hierarchy {
                   12443:     my ($depth,$count,$parent,$children) =@_;
                   12444:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12445:         if (exists($parent->{$depth})) {
                   12446:              $children->{$parent->{$depth}} .= $count.':';
                   12447:         }
                   12448:     }
                   12449:     return;
                   12450: }
                   12451: 
                   12452: sub archive_row {
                   12453:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12454:     my ($name) = ($item =~ m{([^/]+)$});
                   12455:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12456:                                        'display'    => 'Add as file',
1.1055    raeburn  12457:                                        'dependency' => 'Include as dependency',
                   12458:                                        'discard'    => 'Discard',
                   12459:                                       );
                   12460:     if ($is_dir) {
1.1059    raeburn  12461:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12462:     }
1.1056    raeburn  12463:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   12464:     my $offset = 0;
1.1055    raeburn  12465:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  12466:         $offset ++;
1.1065    raeburn  12467:         if ($action ne 'display') {
                   12468:             $offset ++;
                   12469:         }  
1.1055    raeburn  12470:         $output .= '<td><span class="LC_nobreak">'.
                   12471:                    '<label><input type="radio" name="archive_'.$count.
                   12472:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   12473:         my $text = $choices{$action};
                   12474:         if ($is_dir) {
                   12475:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   12476:             if ($action eq 'display') {
1.1059    raeburn  12477:                 $text = &mt('Add as folder');
1.1055    raeburn  12478:             }
1.1056    raeburn  12479:         } else {
                   12480:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   12481: 
                   12482:         }
                   12483:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   12484:         if ($action eq 'dependency') {
                   12485:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   12486:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   12487:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   12488:                        '<option value=""></option>'."\n".
                   12489:                        '</select>'."\n".
                   12490:                        '</div>';
1.1059    raeburn  12491:         } elsif ($action eq 'display') {
                   12492:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   12493:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   12494:                        '</div>';
1.1055    raeburn  12495:         }
1.1056    raeburn  12496:         $output .= '</td>';
1.1055    raeburn  12497:     }
                   12498:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   12499:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   12500:     for (my $i=0; $i<$depth; $i++) {
                   12501:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   12502:     }
                   12503:     if ($is_dir) {
                   12504:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   12505:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   12506:     } else {
                   12507:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   12508:     }
                   12509:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   12510:                &end_data_table_row();
                   12511:     return $output;
                   12512: }
                   12513: 
                   12514: sub archive_options_form {
1.1065    raeburn  12515:     my ($form,$display,$count,$hiddenelem) = @_;
                   12516:     my %lt = &Apache::lonlocal::texthash(
                   12517:                perm => 'Permanently remove archive file?',
                   12518:                hows => 'How should each extracted item be incorporated in the course?',
                   12519:                cont => 'Content actions for all',
                   12520:                addf => 'Add as folder/file',
                   12521:                incd => 'Include as dependency for a displayed file',
                   12522:                disc => 'Discard',
                   12523:                no   => 'No',
                   12524:                yes  => 'Yes',
                   12525:                save => 'Save',
                   12526:     );
                   12527:     my $output = <<"END";
                   12528: <form name="$form" method="post" action="">
                   12529: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   12530: <label>
                   12531:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   12532: </label>
                   12533: &nbsp;
                   12534: <label>
                   12535:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   12536: </span>
                   12537: </p>
                   12538: <input type="hidden" name="phase" value="decompress_cleanup" />
                   12539: <br />$lt{'hows'}
                   12540: <div class="LC_columnSection">
                   12541:   <fieldset>
                   12542:     <legend>$lt{'cont'}</legend>
                   12543:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   12544:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   12545:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   12546:   </fieldset>
                   12547: </div>
                   12548: END
                   12549:     return $output.
1.1055    raeburn  12550:            &start_data_table()."\n".
1.1065    raeburn  12551:            $display."\n".
1.1055    raeburn  12552:            &end_data_table()."\n".
                   12553:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   12554:            $hiddenelem.
1.1065    raeburn  12555:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  12556:            '</form>';
                   12557: }
                   12558: 
                   12559: sub archive_javascript {
1.1056    raeburn  12560:     my ($startcount,$numitems,$titles,$children) = @_;
                   12561:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  12562:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  12563:     my $scripttag = <<START;
                   12564: <script type="text/javascript">
                   12565: // <![CDATA[
                   12566: 
                   12567: function checkAll(form,prefix) {
                   12568:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   12569:     for (var i=0; i < form.elements.length; i++) {
                   12570:         var id = form.elements[i].id;
                   12571:         if ((id != '') && (id != undefined)) {
                   12572:             if (idstr.test(id)) {
                   12573:                 if (form.elements[i].type == 'radio') {
                   12574:                     form.elements[i].checked = true;
1.1056    raeburn  12575:                     var nostart = i-$startcount;
1.1059    raeburn  12576:                     var offset = nostart%7;
                   12577:                     var count = (nostart-offset)/7;    
1.1056    raeburn  12578:                     dependencyCheck(form,count,offset);
1.1055    raeburn  12579:                 }
                   12580:             }
                   12581:         }
                   12582:     }
                   12583: }
                   12584: 
                   12585: function propagateCheck(form,count) {
                   12586:     if (count > 0) {
1.1059    raeburn  12587:         var startelement = $startcount + ((count-1) * 7);
                   12588:         for (var j=1; j<6; j++) {
                   12589:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  12590:                 var item = startelement + j; 
                   12591:                 if (form.elements[item].type == 'radio') {
                   12592:                     if (form.elements[item].checked) {
                   12593:                         containerCheck(form,count,j);
                   12594:                         break;
                   12595:                     }
1.1055    raeburn  12596:                 }
                   12597:             }
                   12598:         }
                   12599:     }
                   12600: }
                   12601: 
                   12602: numitems = $numitems
1.1056    raeburn  12603: var titles = new Array(numitems);
                   12604: var parents = new Array(numitems);
1.1055    raeburn  12605: for (var i=0; i<numitems; i++) {
1.1056    raeburn  12606:     parents[i] = new Array;
1.1055    raeburn  12607: }
1.1059    raeburn  12608: var maintitle = '$maintitle';
1.1055    raeburn  12609: 
                   12610: START
                   12611: 
1.1056    raeburn  12612:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   12613:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  12614:         for (my $i=0; $i<@contents; $i ++) {
                   12615:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   12616:         }
                   12617:     }
                   12618: 
1.1056    raeburn  12619:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   12620:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   12621:     }
                   12622: 
1.1055    raeburn  12623:     $scripttag .= <<END;
                   12624: 
                   12625: function containerCheck(form,count,offset) {
                   12626:     if (count > 0) {
1.1056    raeburn  12627:         dependencyCheck(form,count,offset);
1.1059    raeburn  12628:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  12629:         form.elements[item].checked = true;
                   12630:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12631:             if (parents[count].length > 0) {
                   12632:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  12633:                     containerCheck(form,parents[count][j],offset);
                   12634:                 }
                   12635:             }
                   12636:         }
                   12637:     }
                   12638: }
                   12639: 
                   12640: function dependencyCheck(form,count,offset) {
                   12641:     if (count > 0) {
1.1059    raeburn  12642:         var chosen = (offset+$startcount)+7*(count-1);
                   12643:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  12644:         var currtype = form.elements[depitem].type;
                   12645:         if (form.elements[chosen].value == 'dependency') {
                   12646:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   12647:             form.elements[depitem].options.length = 0;
                   12648:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  12649:             for (var i=1; i<=numitems; i++) {
                   12650:                 if (i == count) {
                   12651:                     continue;
                   12652:                 }
1.1059    raeburn  12653:                 var startelement = $startcount + (i-1) * 7;
                   12654:                 for (var j=1; j<6; j++) {
                   12655:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  12656:                         var item = startelement + j;
                   12657:                         if (form.elements[item].type == 'radio') {
                   12658:                             if (form.elements[item].checked) {
                   12659:                                 if (form.elements[item].value == 'display') {
                   12660:                                     var n = form.elements[depitem].options.length;
                   12661:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   12662:                                 }
                   12663:                             }
                   12664:                         }
                   12665:                     }
                   12666:                 }
                   12667:             }
                   12668:         } else {
                   12669:             document.getElementById('arc_depon_'+count).style.display='none';
                   12670:             form.elements[depitem].options.length = 0;
                   12671:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   12672:         }
1.1059    raeburn  12673:         titleCheck(form,count,offset);
1.1056    raeburn  12674:     }
                   12675: }
                   12676: 
                   12677: function propagateSelect(form,count,offset) {
                   12678:     if (count > 0) {
1.1065    raeburn  12679:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  12680:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   12681:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12682:             if (parents[count].length > 0) {
                   12683:                 for (var j=0; j<parents[count].length; j++) {
                   12684:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  12685:                 }
                   12686:             }
                   12687:         }
                   12688:     }
                   12689: }
1.1056    raeburn  12690: 
                   12691: function containerSelect(form,count,offset,picked) {
                   12692:     if (count > 0) {
1.1065    raeburn  12693:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  12694:         if (form.elements[item].type == 'radio') {
                   12695:             if (form.elements[item].value == 'dependency') {
                   12696:                 if (form.elements[item+1].type == 'select-one') {
                   12697:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   12698:                         if (form.elements[item+1].options[i].value == picked) {
                   12699:                             form.elements[item+1].selectedIndex = i;
                   12700:                             break;
                   12701:                         }
                   12702:                     }
                   12703:                 }
                   12704:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12705:                     if (parents[count].length > 0) {
                   12706:                         for (var j=0; j<parents[count].length; j++) {
                   12707:                             containerSelect(form,parents[count][j],offset,picked);
                   12708:                         }
                   12709:                     }
                   12710:                 }
                   12711:             }
                   12712:         }
                   12713:     }
                   12714: }
                   12715: 
1.1059    raeburn  12716: function titleCheck(form,count,offset) {
                   12717:     if (count > 0) {
                   12718:         var chosen = (offset+$startcount)+7*(count-1);
                   12719:         var depitem = $startcount + ((count-1) * 7) + 2;
                   12720:         var currtype = form.elements[depitem].type;
                   12721:         if (form.elements[chosen].value == 'display') {
                   12722:             document.getElementById('arc_title_'+count).style.display='block';
                   12723:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   12724:                 document.getElementById('archive_title_'+count).value=maintitle;
                   12725:             }
                   12726:         } else {
                   12727:             document.getElementById('arc_title_'+count).style.display='none';
                   12728:             if (currtype == 'text') { 
                   12729:                 document.getElementById('archive_title_'+count).value='';
                   12730:             }
                   12731:         }
                   12732:     }
                   12733:     return;
                   12734: }
                   12735: 
1.1055    raeburn  12736: // ]]>
                   12737: </script>
                   12738: END
                   12739:     return $scripttag;
                   12740: }
                   12741: 
                   12742: sub process_extracted_files {
1.1067    raeburn  12743:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  12744:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  12745:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  12746:     my @ids=&Apache::lonnet::current_machine_ids();
                   12747:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  12748:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  12749:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12750:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12751:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   12752:         $pathtocheck = "$dir_root/$destination";
                   12753:         $dir = $dir_root;
                   12754:         $ishome = 1;
                   12755:     } else {
                   12756:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   12757:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  12758:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  12759:     }
                   12760:     my $currdir = "$dir_root/$destination";
                   12761:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   12762:     if ($env{'form.folderpath'}) {
                   12763:         my @items = split('&',$env{'form.folderpath'});
                   12764:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  12765:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   12766:             $containers{'0'}='page';
                   12767:         } else {
                   12768:             $containers{'0'}='sequence';
                   12769:         }
1.1055    raeburn  12770:     }
                   12771:     my @archdirs = &get_env_multiple('form.archive_directory');
                   12772:     if ($numitems) {
                   12773:         for (my $i=1; $i<=$numitems; $i++) {
                   12774:             my $path = $env{'form.archive_content_'.$i};
                   12775:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   12776:                 my $item = $1;
                   12777:                 $toplevelitems{$item} = $i;
                   12778:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   12779:                     $is_dir{$item} = 1;
                   12780:                 }
                   12781:             }
                   12782:         }
                   12783:     }
1.1067    raeburn  12784:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  12785:     if (keys(%toplevelitems) > 0) {
                   12786:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  12787:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   12788:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  12789:     }
1.1066    raeburn  12790:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  12791:     if ($numitems) {
                   12792:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  12793:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  12794:             my $path = $env{'form.archive_content_'.$i};
                   12795:             if ($path =~ /^\Q$pathtocheck\E/) {
                   12796:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   12797:                     if ($prefix ne '' && $path ne '') {
                   12798:                         if (-e $prefix.$path) {
1.1066    raeburn  12799:                             if ((@archdirs > 0) && 
                   12800:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   12801:                                 $todeletedir{$prefix.$path} = 1;
                   12802:                             } else {
                   12803:                                 $todelete{$prefix.$path} = 1;
                   12804:                             }
1.1055    raeburn  12805:                         }
                   12806:                     }
                   12807:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  12808:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  12809:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  12810:                     $docstitle = $env{'form.archive_title_'.$i};
                   12811:                     if ($docstitle eq '') {
                   12812:                         $docstitle = $title;
                   12813:                     }
1.1055    raeburn  12814:                     $outer = 0;
1.1056    raeburn  12815:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   12816:                         if (@{$dirorder{$i}} > 0) {
                   12817:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  12818:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   12819:                                     $outer = $item;
                   12820:                                     last;
                   12821:                                 }
                   12822:                             }
                   12823:                         }
                   12824:                     }
                   12825:                     my ($errtext,$fatal) = 
                   12826:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   12827:                                                '/'.$folders{$outer}.'.'.
                   12828:                                                $containers{$outer});
                   12829:                     next if ($fatal);
                   12830:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   12831:                         if ($context eq 'coursedocs') {
1.1056    raeburn  12832:                             $mapinner{$i} = time;
1.1055    raeburn  12833:                             $folders{$i} = 'default_'.$mapinner{$i};
                   12834:                             $containers{$i} = 'sequence';
                   12835:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12836:                                       $folders{$i}.'.'.$containers{$i};
                   12837:                             my $newidx = &LONCAPA::map::getresidx();
                   12838:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  12839:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  12840:                             push(@LONCAPA::map::order,$newidx);
                   12841:                             my ($outtext,$errtext) =
                   12842:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   12843:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  12844:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  12845:                             $newseqid{$i} = $newidx;
1.1067    raeburn  12846:                             unless ($errtext) {
1.1075.2.128  raeburn  12847:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   12848:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   12849:                                             '</li>'."\n";
1.1067    raeburn  12850:                             }
1.1055    raeburn  12851:                         }
                   12852:                     } else {
                   12853:                         if ($context eq 'coursedocs') {
                   12854:                             my $newidx=&LONCAPA::map::getresidx();
                   12855:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   12856:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   12857:                                       $title;
1.1075.2.128  raeburn  12858:                             if (($outer !~ /\D/) && ($mapinner{$outer} !~ /\D/) && ($newidx !~ /\D/)) {
                   12859:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   12860:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  12861:                                 }
1.1075.2.128  raeburn  12862:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   12863:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   12864:                                 }
                   12865:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   12866:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   12867:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   12868:                                         unless ($ishome) {
                   12869:                                             my $fetch = "$newdest{$i}/$title";
                   12870:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   12871:                                             $prompttofetch{$fetch} = 1;
                   12872:                                         }
                   12873:                                    }
                   12874:                                 }
                   12875:                                 $LONCAPA::map::resources[$newidx]=
                   12876:                                     $docstitle.':'.$url.':false:normal:res';
                   12877:                                 push(@LONCAPA::map::order, $newidx);
                   12878:                                 my ($outtext,$errtext)=
                   12879:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   12880:                                                             $docuname.'/'.$folders{$outer}.
                   12881:                                                             '.'.$containers{$outer},1,1);
                   12882:                                 unless ($errtext) {
                   12883:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   12884:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   12885:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   12886:                                                    '</li>'."\n";
                   12887:                                     }
1.1067    raeburn  12888:                                 }
1.1075.2.128  raeburn  12889:                             } else {
                   12890:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   12891:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  12892:                             }
1.1055    raeburn  12893:                         }
                   12894:                     }
1.1075.2.11  raeburn  12895:                 }
                   12896:             } else {
1.1075.2.128  raeburn  12897:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   12898:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  12899:             }
                   12900:         }
                   12901:         for (my $i=1; $i<=$numitems; $i++) {
                   12902:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   12903:             my $path = $env{'form.archive_content_'.$i};
                   12904:             if ($path =~ /^\Q$pathtocheck\E/) {
                   12905:                 my ($title) = ($path =~ m{/([^/]+)$});
                   12906:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   12907:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   12908:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   12909:                         my ($itemidx,$fullpath,$relpath);
                   12910:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   12911:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  12912:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  12913:                                 if ($dirorder{$i}->[$j] eq $container) {
                   12914:                                     $itemidx = $j;
1.1056    raeburn  12915:                                 }
                   12916:                             }
1.1075.2.11  raeburn  12917:                         }
                   12918:                         if ($itemidx eq '') {
                   12919:                             $itemidx =  0;
                   12920:                         }
                   12921:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   12922:                             if ($mapinner{$referrer{$i}}) {
                   12923:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   12924:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   12925:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   12926:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   12927:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   12928:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   12929:                                             if (!-e $fullpath) {
                   12930:                                                 mkdir($fullpath,0755);
1.1056    raeburn  12931:                                             }
                   12932:                                         }
1.1075.2.11  raeburn  12933:                                     } else {
                   12934:                                         last;
1.1056    raeburn  12935:                                     }
1.1075.2.11  raeburn  12936:                                 }
                   12937:                             }
                   12938:                         } elsif ($newdest{$referrer{$i}}) {
                   12939:                             $fullpath = $newdest{$referrer{$i}};
                   12940:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   12941:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   12942:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   12943:                                     last;
                   12944:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   12945:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   12946:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   12947:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   12948:                                         if (!-e $fullpath) {
                   12949:                                             mkdir($fullpath,0755);
1.1056    raeburn  12950:                                         }
                   12951:                                     }
1.1075.2.11  raeburn  12952:                                 } else {
                   12953:                                     last;
1.1056    raeburn  12954:                                 }
1.1075.2.11  raeburn  12955:                             }
                   12956:                         }
                   12957:                         if ($fullpath ne '') {
                   12958:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  12959:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   12960:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   12961:                                 }
1.1075.2.11  raeburn  12962:                             }
                   12963:                             if (-e "$fullpath/$title") {
                   12964:                                 my $showpath;
                   12965:                                 if ($relpath ne '') {
                   12966:                                     $showpath = "$relpath/$title";
                   12967:                                 } else {
                   12968:                                     $showpath = "/$title";
1.1056    raeburn  12969:                                 }
1.1075.2.128  raeburn  12970:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   12971:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   12972:                                            '</li>'."\n";
                   12973:                                 unless ($ishome) {
                   12974:                                     my $fetch = "$fullpath/$title";
                   12975:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   12976:                                     $prompttofetch{$fetch} = 1;
                   12977:                                 }
1.1055    raeburn  12978:                             }
                   12979:                         }
                   12980:                     }
1.1075.2.11  raeburn  12981:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   12982:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  12983:                                     &HTML::Entities::encode($path,'<>&"'),
                   12984:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   12985:                                 '<br />';
1.1055    raeburn  12986:                 }
                   12987:             } else {
1.1075.2.128  raeburn  12988:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   12989:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  12990:             }
                   12991:         }
                   12992:         if (keys(%todelete)) {
                   12993:             foreach my $key (keys(%todelete)) {
                   12994:                 unlink($key);
1.1066    raeburn  12995:             }
                   12996:         }
                   12997:         if (keys(%todeletedir)) {
                   12998:             foreach my $key (keys(%todeletedir)) {
                   12999:                 rmdir($key);
                   13000:             }
                   13001:         }
                   13002:         foreach my $dir (sort(keys(%is_dir))) {
                   13003:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   13004:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  13005:             }
                   13006:         }
1.1067    raeburn  13007:         if ($result ne '') {
                   13008:             $output .= '<ul>'."\n".
                   13009:                        $result."\n".
                   13010:                        '</ul>';
                   13011:         }
                   13012:         unless ($ishome) {
                   13013:             my $replicationfail;
                   13014:             foreach my $item (keys(%prompttofetch)) {
                   13015:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   13016:                 unless ($fetchresult eq 'ok') {
                   13017:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   13018:                 }
                   13019:             }
                   13020:             if ($replicationfail) {
                   13021:                 $output .= '<p class="LC_error">'.
                   13022:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   13023:                            $replicationfail.
                   13024:                            '</ul></p>';
                   13025:             }
                   13026:         }
1.1055    raeburn  13027:     } else {
                   13028:         $warning = &mt('No items found in archive.');
                   13029:     }
                   13030:     if ($error) {
                   13031:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13032:                    $error.'</p>'."\n";
                   13033:     }
                   13034:     if ($warning) {
                   13035:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13036:     }
                   13037:     return $output;
                   13038: }
                   13039: 
1.1066    raeburn  13040: sub cleanup_empty_dirs {
                   13041:     my ($path) = @_;
                   13042:     if (($path ne '') && (-d $path)) {
                   13043:         if (opendir(my $dirh,$path)) {
                   13044:             my @dircontents = grep(!/^\./,readdir($dirh));
                   13045:             my $numitems = 0;
                   13046:             foreach my $item (@dircontents) {
                   13047:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  13048:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  13049:                     if (-e "$path/$item") {
                   13050:                         $numitems ++;
                   13051:                     }
                   13052:                 } else {
                   13053:                     $numitems ++;
                   13054:                 }
                   13055:             }
                   13056:             if ($numitems == 0) {
                   13057:                 rmdir($path);
                   13058:             }
                   13059:             closedir($dirh);
                   13060:         }
                   13061:     }
                   13062:     return;
                   13063: }
                   13064: 
1.41      ng       13065: =pod
1.45      matthew  13066: 
1.1075.2.56  raeburn  13067: =item * &get_folder_hierarchy()
1.1068    raeburn  13068: 
                   13069: Provides hierarchy of names of folders/sub-folders containing the current
                   13070: item,
                   13071: 
                   13072: Inputs: 3
                   13073:      - $navmap - navmaps object
                   13074: 
                   13075:      - $map - url for map (either the trigger itself, or map containing
                   13076:                            the resource, which is the trigger).
                   13077: 
                   13078:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   13079: 
                   13080: Outputs: 1 @pathitems - array of folder/subfolder names.
                   13081: 
                   13082: =cut
                   13083: 
                   13084: sub get_folder_hierarchy {
                   13085:     my ($navmap,$map,$showitem) = @_;
                   13086:     my @pathitems;
                   13087:     if (ref($navmap)) {
                   13088:         my $mapres = $navmap->getResourceByUrl($map);
                   13089:         if (ref($mapres)) {
                   13090:             my $pcslist = $mapres->map_hierarchy();
                   13091:             if ($pcslist ne '') {
                   13092:                 my @pcs = split(/,/,$pcslist);
                   13093:                 foreach my $pc (@pcs) {
                   13094:                     if ($pc == 1) {
1.1075.2.38  raeburn  13095:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  13096:                     } else {
                   13097:                         my $res = $navmap->getByMapPc($pc);
                   13098:                         if (ref($res)) {
                   13099:                             my $title = $res->compTitle();
                   13100:                             $title =~ s/\W+/_/g;
                   13101:                             if ($title ne '') {
                   13102:                                 push(@pathitems,$title);
                   13103:                             }
                   13104:                         }
                   13105:                     }
                   13106:                 }
                   13107:             }
1.1071    raeburn  13108:             if ($showitem) {
                   13109:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  13110:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  13111:                 } else {
                   13112:                     my $maptitle = $mapres->compTitle();
                   13113:                     $maptitle =~ s/\W+/_/g;
                   13114:                     if ($maptitle ne '') {
                   13115:                         push(@pathitems,$maptitle);
                   13116:                     }
1.1068    raeburn  13117:                 }
                   13118:             }
                   13119:         }
                   13120:     }
                   13121:     return @pathitems;
                   13122: }
                   13123: 
                   13124: =pod
                   13125: 
1.1015    raeburn  13126: =item * &get_turnedin_filepath()
                   13127: 
                   13128: Determines path in a user's portfolio file for storage of files uploaded
                   13129: to a specific essayresponse or dropbox item.
                   13130: 
                   13131: Inputs: 3 required + 1 optional.
                   13132: $symb is symb for resource, $uname and $udom are for current user (required).
                   13133: $caller is optional (can be "submission", if routine is called when storing
                   13134: an upoaded file when "Submit Answer" button was pressed).
                   13135: 
                   13136: Returns array containing $path and $multiresp. 
                   13137: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   13138: than one file upload item.  Callers of routine should append partid as a 
                   13139: subdirectory to $path in cases where $multiresp is 1.
                   13140: 
                   13141: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   13142: 
                   13143: =cut
                   13144: 
                   13145: sub get_turnedin_filepath {
                   13146:     my ($symb,$uname,$udom,$caller) = @_;
                   13147:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13148:     my $turnindir;
                   13149:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13150:     $turnindir = $userhash{'turnindir'};
                   13151:     my ($path,$multiresp);
                   13152:     if ($turnindir eq '') {
                   13153:         if ($caller eq 'submission') {
                   13154:             $turnindir = &mt('turned in');
                   13155:             $turnindir =~ s/\W+/_/g;
                   13156:             my %newhash = (
                   13157:                             'turnindir' => $turnindir,
                   13158:                           );
                   13159:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13160:         }
                   13161:     }
                   13162:     if ($turnindir ne '') {
                   13163:         $path = '/'.$turnindir.'/';
                   13164:         my ($multipart,$turnin,@pathitems);
                   13165:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13166:         if (defined($navmap)) {
                   13167:             my $mapres = $navmap->getResourceByUrl($map);
                   13168:             if (ref($mapres)) {
                   13169:                 my $pcslist = $mapres->map_hierarchy();
                   13170:                 if ($pcslist ne '') {
                   13171:                     foreach my $pc (split(/,/,$pcslist)) {
                   13172:                         my $res = $navmap->getByMapPc($pc);
                   13173:                         if (ref($res)) {
                   13174:                             my $title = $res->compTitle();
                   13175:                             $title =~ s/\W+/_/g;
                   13176:                             if ($title ne '') {
1.1075.2.48  raeburn  13177:                                 if (($pc > 1) && (length($title) > 12)) {
                   13178:                                     $title = substr($title,0,12);
                   13179:                                 }
1.1015    raeburn  13180:                                 push(@pathitems,$title);
                   13181:                             }
                   13182:                         }
                   13183:                     }
                   13184:                 }
                   13185:                 my $maptitle = $mapres->compTitle();
                   13186:                 $maptitle =~ s/\W+/_/g;
                   13187:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  13188:                     if (length($maptitle) > 12) {
                   13189:                         $maptitle = substr($maptitle,0,12);
                   13190:                     }
1.1015    raeburn  13191:                     push(@pathitems,$maptitle);
                   13192:                 }
                   13193:                 unless ($env{'request.state'} eq 'construct') {
                   13194:                     my $res = $navmap->getBySymb($symb);
                   13195:                     if (ref($res)) {
                   13196:                         my $partlist = $res->parts();
                   13197:                         my $totaluploads = 0;
                   13198:                         if (ref($partlist) eq 'ARRAY') {
                   13199:                             foreach my $part (@{$partlist}) {
                   13200:                                 my @types = $res->responseType($part);
                   13201:                                 my @ids = $res->responseIds($part);
                   13202:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   13203:                                     if ($types[$i] eq 'essay') {
                   13204:                                         my $partid = $part.'_'.$ids[$i];
                   13205:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   13206:                                             $totaluploads ++;
                   13207:                                         }
                   13208:                                     }
                   13209:                                 }
                   13210:                             }
                   13211:                             if ($totaluploads > 1) {
                   13212:                                 $multiresp = 1;
                   13213:                             }
                   13214:                         }
                   13215:                     }
                   13216:                 }
                   13217:             } else {
                   13218:                 return;
                   13219:             }
                   13220:         } else {
                   13221:             return;
                   13222:         }
                   13223:         my $restitle=&Apache::lonnet::gettitle($symb);
                   13224:         $restitle =~ s/\W+/_/g;
                   13225:         if ($restitle eq '') {
                   13226:             $restitle = ($resurl =~ m{/[^/]+$});
                   13227:             if ($restitle eq '') {
                   13228:                 $restitle = time;
                   13229:             }
                   13230:         }
1.1075.2.48  raeburn  13231:         if (length($restitle) > 12) {
                   13232:             $restitle = substr($restitle,0,12);
                   13233:         }
1.1015    raeburn  13234:         push(@pathitems,$restitle);
                   13235:         $path .= join('/',@pathitems);
                   13236:     }
                   13237:     return ($path,$multiresp);
                   13238: }
                   13239: 
                   13240: =pod
                   13241: 
1.464     albertel 13242: =back
1.41      ng       13243: 
1.112     bowersj2 13244: =head1 CSV Upload/Handling functions
1.38      albertel 13245: 
1.41      ng       13246: =over 4
                   13247: 
1.648     raeburn  13248: =item * &upfile_store($r)
1.41      ng       13249: 
                   13250: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 13251: needs $env{'form.upfile'}
1.41      ng       13252: returns $datatoken to be put into hidden field
                   13253: 
                   13254: =cut
1.31      albertel 13255: 
                   13256: sub upfile_store {
                   13257:     my $r=shift;
1.258     albertel 13258:     $env{'form.upfile'}=~s/\r/\n/gs;
                   13259:     $env{'form.upfile'}=~s/\f/\n/gs;
                   13260:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   13261:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 13262: 
1.1075.2.128  raeburn  13263:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   13264:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   13265:                                      time.'_'.$$);
                   13266:     return if ($datatoken eq '');
                   13267: 
1.31      albertel 13268:     {
1.158     raeburn  13269:         my $datafile = $r->dir_config('lonDaemons').
                   13270:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  13271:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 13272:             print $fh $env{'form.upfile'};
1.158     raeburn  13273:             close($fh);
                   13274:         }
1.31      albertel 13275:     }
                   13276:     return $datatoken;
                   13277: }
                   13278: 
1.56      matthew  13279: =pod
                   13280: 
1.1075.2.128  raeburn  13281: =item * &load_tmp_file($r,$datatoken)
1.41      ng       13282: 
                   13283: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  13284: $datatoken is the name to assign to the temporary file.
1.258     albertel 13285: sets $env{'form.upfile'} to the contents of the file
1.41      ng       13286: 
                   13287: =cut
1.31      albertel 13288: 
                   13289: sub load_tmp_file {
1.1075.2.128  raeburn  13290:     my ($r,$datatoken) = @_;
                   13291:     return if ($datatoken eq '');
1.31      albertel 13292:     my @studentdata=();
                   13293:     {
1.158     raeburn  13294:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  13295:                               '/tmp/'.$datatoken.'.tmp';
                   13296:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  13297:             @studentdata=<$fh>;
                   13298:             close($fh);
                   13299:         }
1.31      albertel 13300:     }
1.258     albertel 13301:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 13302: }
                   13303: 
1.1075.2.128  raeburn  13304: sub valid_datatoken {
                   13305:     my ($datatoken) = @_;
1.1075.2.131  raeburn  13306:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128  raeburn  13307:         return $datatoken;
                   13308:     }
                   13309:     return;
                   13310: }
                   13311: 
1.56      matthew  13312: =pod
                   13313: 
1.648     raeburn  13314: =item * &upfile_record_sep()
1.41      ng       13315: 
                   13316: Separate uploaded file into records
                   13317: returns array of records,
1.258     albertel 13318: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       13319: 
                   13320: =cut
1.31      albertel 13321: 
                   13322: sub upfile_record_sep {
1.258     albertel 13323:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 13324:     } else {
1.248     albertel 13325: 	my @records;
1.258     albertel 13326: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 13327: 	    if ($line=~/^\s*$/) { next; }
                   13328: 	    push(@records,$line);
                   13329: 	}
                   13330: 	return @records;
1.31      albertel 13331:     }
                   13332: }
                   13333: 
1.56      matthew  13334: =pod
                   13335: 
1.648     raeburn  13336: =item * &record_sep($record)
1.41      ng       13337: 
1.258     albertel 13338: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       13339: 
                   13340: =cut
                   13341: 
1.263     www      13342: sub takeleft {
                   13343:     my $index=shift;
                   13344:     return substr('0000'.$index,-4,4);
                   13345: }
                   13346: 
1.31      albertel 13347: sub record_sep {
                   13348:     my $record=shift;
                   13349:     my %components=();
1.258     albertel 13350:     if ($env{'form.upfiletype'} eq 'xml') {
                   13351:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 13352:         my $i=0;
1.356     albertel 13353:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 13354:             $field=~s/^(\"|\')//;
                   13355:             $field=~s/(\"|\')$//;
1.263     www      13356:             $components{&takeleft($i)}=$field;
1.31      albertel 13357:             $i++;
                   13358:         }
1.258     albertel 13359:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 13360:         my $i=0;
1.356     albertel 13361:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 13362:             $field=~s/^(\"|\')//;
                   13363:             $field=~s/(\"|\')$//;
1.263     www      13364:             $components{&takeleft($i)}=$field;
1.31      albertel 13365:             $i++;
                   13366:         }
                   13367:     } else {
1.561     www      13368:         my $separator=',';
1.480     banghart 13369:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      13370:             $separator=';';
1.480     banghart 13371:         }
1.31      albertel 13372:         my $i=0;
1.561     www      13373: # the character we are looking for to indicate the end of a quote or a record 
                   13374:         my $looking_for=$separator;
                   13375: # do not add the characters to the fields
                   13376:         my $ignore=0;
                   13377: # we just encountered a separator (or the beginning of the record)
                   13378:         my $just_found_separator=1;
                   13379: # store the field we are working on here
                   13380:         my $field='';
                   13381: # work our way through all characters in record
                   13382:         foreach my $character ($record=~/(.)/g) {
                   13383:             if ($character eq $looking_for) {
                   13384:                if ($character ne $separator) {
                   13385: # Found the end of a quote, again looking for separator
                   13386:                   $looking_for=$separator;
                   13387:                   $ignore=1;
                   13388:                } else {
                   13389: # Found a separator, store away what we got
                   13390:                   $components{&takeleft($i)}=$field;
                   13391: 	          $i++;
                   13392:                   $just_found_separator=1;
                   13393:                   $ignore=0;
                   13394:                   $field='';
                   13395:                }
                   13396:                next;
                   13397:             }
                   13398: # single or double quotation marks after a separator indicate beginning of a quote
                   13399: # we are now looking for the end of the quote and need to ignore separators
                   13400:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   13401:                $looking_for=$character;
                   13402:                next;
                   13403:             }
                   13404: # ignore would be true after we reached the end of a quote
                   13405:             if ($ignore) { next; }
                   13406:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   13407:             $field.=$character;
                   13408:             $just_found_separator=0; 
1.31      albertel 13409:         }
1.561     www      13410: # catch the very last entry, since we never encountered the separator
                   13411:         $components{&takeleft($i)}=$field;
1.31      albertel 13412:     }
                   13413:     return %components;
                   13414: }
                   13415: 
1.144     matthew  13416: ######################################################
                   13417: ######################################################
                   13418: 
1.56      matthew  13419: =pod
                   13420: 
1.648     raeburn  13421: =item * &upfile_select_html()
1.41      ng       13422: 
1.144     matthew  13423: Return HTML code to select a file from the users machine and specify 
                   13424: the file type.
1.41      ng       13425: 
                   13426: =cut
                   13427: 
1.144     matthew  13428: ######################################################
                   13429: ######################################################
1.31      albertel 13430: sub upfile_select_html {
1.144     matthew  13431:     my %Types = (
                   13432:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 13433:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  13434:                  space => &mt('Space separated'),
                   13435:                  tab   => &mt('Tabulator separated'),
                   13436: #                 xml   => &mt('HTML/XML'),
                   13437:                  );
                   13438:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  13439:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  13440:     foreach my $type (sort(keys(%Types))) {
                   13441:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   13442:     }
                   13443:     $Str .= "</select>\n";
                   13444:     return $Str;
1.31      albertel 13445: }
                   13446: 
1.301     albertel 13447: sub get_samples {
                   13448:     my ($records,$toget) = @_;
                   13449:     my @samples=({});
                   13450:     my $got=0;
                   13451:     foreach my $rec (@$records) {
                   13452: 	my %temp = &record_sep($rec);
                   13453: 	if (! grep(/\S/, values(%temp))) { next; }
                   13454: 	if (%temp) {
                   13455: 	    $samples[$got]=\%temp;
                   13456: 	    $got++;
                   13457: 	    if ($got == $toget) { last; }
                   13458: 	}
                   13459:     }
                   13460:     return \@samples;
                   13461: }
                   13462: 
1.144     matthew  13463: ######################################################
                   13464: ######################################################
                   13465: 
1.56      matthew  13466: =pod
                   13467: 
1.648     raeburn  13468: =item * &csv_print_samples($r,$records)
1.41      ng       13469: 
                   13470: Prints a table of sample values from each column uploaded $r is an
                   13471: Apache Request ref, $records is an arrayref from
                   13472: &Apache::loncommon::upfile_record_sep
                   13473: 
                   13474: =cut
                   13475: 
1.144     matthew  13476: ######################################################
                   13477: ######################################################
1.31      albertel 13478: sub csv_print_samples {
                   13479:     my ($r,$records) = @_;
1.662     bisitz   13480:     my $samples = &get_samples($records,5);
1.301     albertel 13481: 
1.594     raeburn  13482:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   13483:               &start_data_table_header_row());
1.356     albertel 13484:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   13485:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  13486:     $r->print(&end_data_table_header_row());
1.301     albertel 13487:     foreach my $hash (@$samples) {
1.594     raeburn  13488: 	$r->print(&start_data_table_row());
1.356     albertel 13489: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 13490: 	    $r->print('<td>');
1.356     albertel 13491: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 13492: 	    $r->print('</td>');
                   13493: 	}
1.594     raeburn  13494: 	$r->print(&end_data_table_row());
1.31      albertel 13495:     }
1.594     raeburn  13496:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 13497: }
                   13498: 
1.144     matthew  13499: ######################################################
                   13500: ######################################################
                   13501: 
1.56      matthew  13502: =pod
                   13503: 
1.648     raeburn  13504: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       13505: 
                   13506: Prints a table to create associations between values and table columns.
1.144     matthew  13507: 
1.41      ng       13508: $r is an Apache Request ref,
                   13509: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  13510: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       13511: 
                   13512: =cut
                   13513: 
1.144     matthew  13514: ######################################################
                   13515: ######################################################
1.31      albertel 13516: sub csv_print_select_table {
                   13517:     my ($r,$records,$d) = @_;
1.301     albertel 13518:     my $i=0;
                   13519:     my $samples = &get_samples($records,1);
1.144     matthew  13520:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  13521: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  13522:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  13523:               '<th>'.&mt('Column').'</th>'.
                   13524:               &end_data_table_header_row()."\n");
1.356     albertel 13525:     foreach my $array_ref (@$d) {
                   13526: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  13527: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 13528: 
1.875     bisitz   13529: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  13530: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 13531: 	$r->print('<option value="none"></option>');
1.356     albertel 13532: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   13533: 	    $r->print('<option value="'.$sample.'"'.
                   13534:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   13535:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 13536: 	}
1.594     raeburn  13537: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 13538: 	$i++;
                   13539:     }
1.594     raeburn  13540:     $r->print(&end_data_table());
1.31      albertel 13541:     $i--;
                   13542:     return $i;
                   13543: }
1.56      matthew  13544: 
1.144     matthew  13545: ######################################################
                   13546: ######################################################
                   13547: 
1.56      matthew  13548: =pod
1.31      albertel 13549: 
1.648     raeburn  13550: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       13551: 
                   13552: Prints a table of sample values from the upload and can make associate samples to internal names.
                   13553: 
                   13554: $r is an Apache Request ref,
                   13555: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   13556: $d is an array of 2 element arrays (internal name, displayed name)
                   13557: 
                   13558: =cut
                   13559: 
1.144     matthew  13560: ######################################################
                   13561: ######################################################
1.31      albertel 13562: sub csv_samples_select_table {
                   13563:     my ($r,$records,$d) = @_;
                   13564:     my $i=0;
1.144     matthew  13565:     #
1.662     bisitz   13566:     my $max_samples = 5;
                   13567:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  13568:     $r->print(&start_data_table().
                   13569:               &start_data_table_header_row().'<th>'.
                   13570:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   13571:               &end_data_table_header_row());
1.301     albertel 13572: 
                   13573:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  13574: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  13575: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 13576: 	foreach my $option (@$d) {
                   13577: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  13578: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 13579:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  13580:                       $display.'</option>');
1.31      albertel 13581: 	}
                   13582: 	$r->print('</select></td><td>');
1.662     bisitz   13583: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 13584: 	    if (defined($samples->[$line]{$key})) { 
                   13585: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   13586: 	    }
                   13587: 	}
1.594     raeburn  13588: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 13589: 	$i++;
                   13590:     }
1.594     raeburn  13591:     $r->print(&end_data_table());
1.31      albertel 13592:     $i--;
                   13593:     return($i);
1.115     matthew  13594: }
                   13595: 
1.144     matthew  13596: ######################################################
                   13597: ######################################################
                   13598: 
1.115     matthew  13599: =pod
                   13600: 
1.648     raeburn  13601: =item * &clean_excel_name($name)
1.115     matthew  13602: 
                   13603: Returns a replacement for $name which does not contain any illegal characters.
                   13604: 
                   13605: =cut
                   13606: 
1.144     matthew  13607: ######################################################
                   13608: ######################################################
1.115     matthew  13609: sub clean_excel_name {
                   13610:     my ($name) = @_;
                   13611:     $name =~ s/[:\*\?\/\\]//g;
                   13612:     if (length($name) > 31) {
                   13613:         $name = substr($name,0,31);
                   13614:     }
                   13615:     return $name;
1.25      albertel 13616: }
1.84      albertel 13617: 
1.85      albertel 13618: =pod
                   13619: 
1.648     raeburn  13620: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 13621: 
                   13622: Returns either 1 or undef
                   13623: 
                   13624: 1 if the part is to be hidden, undef if it is to be shown
                   13625: 
                   13626: Arguments are:
                   13627: 
                   13628: $id the id of the part to be checked
                   13629: $symb, optional the symb of the resource to check
                   13630: $udom, optional the domain of the user to check for
                   13631: $uname, optional the username of the user to check for
                   13632: 
                   13633: =cut
1.84      albertel 13634: 
                   13635: sub check_if_partid_hidden {
                   13636:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 13637:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 13638: 					 $symb,$udom,$uname);
1.141     albertel 13639:     my $truth=1;
                   13640:     #if the string starts with !, then the list is the list to show not hide
                   13641:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 13642:     my @hiddenlist=split(/,/,$hiddenparts);
                   13643:     foreach my $checkid (@hiddenlist) {
1.141     albertel 13644: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 13645:     }
1.141     albertel 13646:     return !$truth;
1.84      albertel 13647: }
1.127     matthew  13648: 
1.138     matthew  13649: 
                   13650: ############################################################
                   13651: ############################################################
                   13652: 
                   13653: =pod
                   13654: 
1.157     matthew  13655: =back 
                   13656: 
1.138     matthew  13657: =head1 cgi-bin script and graphing routines
                   13658: 
1.157     matthew  13659: =over 4
                   13660: 
1.648     raeburn  13661: =item * &get_cgi_id()
1.138     matthew  13662: 
                   13663: Inputs: none
                   13664: 
                   13665: Returns an id which can be used to pass environment variables
                   13666: to various cgi-bin scripts.  These environment variables will
                   13667: be removed from the users environment after a given time by
                   13668: the routine &Apache::lonnet::transfer_profile_to_env.
                   13669: 
                   13670: =cut
                   13671: 
                   13672: ############################################################
                   13673: ############################################################
1.152     albertel 13674: my $uniq=0;
1.136     matthew  13675: sub get_cgi_id {
1.154     albertel 13676:     $uniq=($uniq+1)%100000;
1.280     albertel 13677:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  13678: }
                   13679: 
1.127     matthew  13680: ############################################################
                   13681: ############################################################
                   13682: 
                   13683: =pod
                   13684: 
1.648     raeburn  13685: =item * &DrawBarGraph()
1.127     matthew  13686: 
1.138     matthew  13687: Facilitates the plotting of data in a (stacked) bar graph.
                   13688: Puts plot definition data into the users environment in order for 
                   13689: graph.png to plot it.  Returns an <img> tag for the plot.
                   13690: The bars on the plot are labeled '1','2',...,'n'.
                   13691: 
                   13692: Inputs:
                   13693: 
                   13694: =over 4
                   13695: 
                   13696: =item $Title: string, the title of the plot
                   13697: 
                   13698: =item $xlabel: string, text describing the X-axis of the plot
                   13699: 
                   13700: =item $ylabel: string, text describing the Y-axis of the plot
                   13701: 
                   13702: =item $Max: scalar, the maximum Y value to use in the plot
                   13703: If $Max is < any data point, the graph will not be rendered.
                   13704: 
1.140     matthew  13705: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  13706: they are plotted.  If undefined, default values will be used.
                   13707: 
1.178     matthew  13708: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   13709: 
1.138     matthew  13710: =item @Values: An array of array references.  Each array reference holds data
                   13711: to be plotted in a stacked bar chart.
                   13712: 
1.239     matthew  13713: =item If the final element of @Values is a hash reference the key/value
                   13714: pairs will be added to the graph definition.
                   13715: 
1.138     matthew  13716: =back
                   13717: 
                   13718: Returns:
                   13719: 
                   13720: An <img> tag which references graph.png and the appropriate identifying
                   13721: information for the plot.
                   13722: 
1.127     matthew  13723: =cut
                   13724: 
                   13725: ############################################################
                   13726: ############################################################
1.134     matthew  13727: sub DrawBarGraph {
1.178     matthew  13728:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  13729:     #
                   13730:     if (! defined($colors)) {
                   13731:         $colors = ['#33ff00', 
                   13732:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   13733:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   13734:                   ]; 
                   13735:     }
1.228     matthew  13736:     my $extra_settings = {};
                   13737:     if (ref($Values[-1]) eq 'HASH') {
                   13738:         $extra_settings = pop(@Values);
                   13739:     }
1.127     matthew  13740:     #
1.136     matthew  13741:     my $identifier = &get_cgi_id();
                   13742:     my $id = 'cgi.'.$identifier;        
1.129     matthew  13743:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  13744:         return '';
                   13745:     }
1.225     matthew  13746:     #
                   13747:     my @Labels;
                   13748:     if (defined($labels)) {
                   13749:         @Labels = @$labels;
                   13750:     } else {
                   13751:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  13752:             push(@Labels,$i+1);
1.225     matthew  13753:         }
                   13754:     }
                   13755:     #
1.129     matthew  13756:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  13757:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  13758:     my %ValuesHash;
                   13759:     my $NumSets=1;
                   13760:     foreach my $array (@Values) {
                   13761:         next if (! ref($array));
1.136     matthew  13762:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  13763:             join(',',@$array);
1.129     matthew  13764:     }
1.127     matthew  13765:     #
1.136     matthew  13766:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  13767:     if ($NumBars < 3) {
                   13768:         $width = 120+$NumBars*32;
1.220     matthew  13769:         $xskip = 1;
1.225     matthew  13770:         $bar_width = 30;
                   13771:     } elsif ($NumBars < 5) {
                   13772:         $width = 120+$NumBars*20;
                   13773:         $xskip = 1;
                   13774:         $bar_width = 20;
1.220     matthew  13775:     } elsif ($NumBars < 10) {
1.136     matthew  13776:         $width = 120+$NumBars*15;
                   13777:         $xskip = 1;
                   13778:         $bar_width = 15;
                   13779:     } elsif ($NumBars <= 25) {
                   13780:         $width = 120+$NumBars*11;
                   13781:         $xskip = 5;
                   13782:         $bar_width = 8;
                   13783:     } elsif ($NumBars <= 50) {
                   13784:         $width = 120+$NumBars*8;
                   13785:         $xskip = 5;
                   13786:         $bar_width = 4;
                   13787:     } else {
                   13788:         $width = 120+$NumBars*8;
                   13789:         $xskip = 5;
                   13790:         $bar_width = 4;
                   13791:     }
                   13792:     #
1.137     matthew  13793:     $Max = 1 if ($Max < 1);
                   13794:     if ( int($Max) < $Max ) {
                   13795:         $Max++;
                   13796:         $Max = int($Max);
                   13797:     }
1.127     matthew  13798:     $Title  = '' if (! defined($Title));
                   13799:     $xlabel = '' if (! defined($xlabel));
                   13800:     $ylabel = '' if (! defined($ylabel));
1.369     www      13801:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   13802:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   13803:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  13804:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  13805:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   13806:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   13807:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   13808:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13809:     $ValuesHash{$id.'.height'}   = $height;
                   13810:     $ValuesHash{$id.'.width'}    = $width;
                   13811:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   13812:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   13813:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  13814:     #
1.228     matthew  13815:     # Deal with other parameters
                   13816:     while (my ($key,$value) = each(%$extra_settings)) {
                   13817:         $ValuesHash{$id.'.'.$key} = $value;
                   13818:     }
                   13819:     #
1.646     raeburn  13820:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  13821:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   13822: }
                   13823: 
                   13824: ############################################################
                   13825: ############################################################
                   13826: 
                   13827: =pod
                   13828: 
1.648     raeburn  13829: =item * &DrawXYGraph()
1.137     matthew  13830: 
1.138     matthew  13831: Facilitates the plotting of data in an XY graph.
                   13832: Puts plot definition data into the users environment in order for 
                   13833: graph.png to plot it.  Returns an <img> tag for the plot.
                   13834: 
                   13835: Inputs:
                   13836: 
                   13837: =over 4
                   13838: 
                   13839: =item $Title: string, the title of the plot
                   13840: 
                   13841: =item $xlabel: string, text describing the X-axis of the plot
                   13842: 
                   13843: =item $ylabel: string, text describing the Y-axis of the plot
                   13844: 
                   13845: =item $Max: scalar, the maximum Y value to use in the plot
                   13846: If $Max is < any data point, the graph will not be rendered.
                   13847: 
                   13848: =item $colors: Array ref containing the hex color codes for the data to be 
                   13849: plotted in.  If undefined, default values will be used.
                   13850: 
                   13851: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   13852: 
                   13853: =item $Ydata: Array ref containing Array refs.  
1.185     www      13854: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  13855: 
                   13856: =item %Values: hash indicating or overriding any default values which are 
                   13857: passed to graph.png.  
                   13858: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   13859: 
                   13860: =back
                   13861: 
                   13862: Returns:
                   13863: 
                   13864: An <img> tag which references graph.png and the appropriate identifying
                   13865: information for the plot.
                   13866: 
1.137     matthew  13867: =cut
                   13868: 
                   13869: ############################################################
                   13870: ############################################################
                   13871: sub DrawXYGraph {
                   13872:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   13873:     #
                   13874:     # Create the identifier for the graph
                   13875:     my $identifier = &get_cgi_id();
                   13876:     my $id = 'cgi.'.$identifier;
                   13877:     #
                   13878:     $Title  = '' if (! defined($Title));
                   13879:     $xlabel = '' if (! defined($xlabel));
                   13880:     $ylabel = '' if (! defined($ylabel));
                   13881:     my %ValuesHash = 
                   13882:         (
1.369     www      13883:          $id.'.title'  => &escape($Title),
                   13884:          $id.'.xlabel' => &escape($xlabel),
                   13885:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  13886:          $id.'.y_max_value'=> $Max,
                   13887:          $id.'.labels'     => join(',',@$Xlabels),
                   13888:          $id.'.PlotType'   => 'XY',
                   13889:          );
                   13890:     #
                   13891:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   13892:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13893:     }
                   13894:     #
                   13895:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   13896:         return '';
                   13897:     }
                   13898:     my $NumSets=1;
1.138     matthew  13899:     foreach my $array (@{$Ydata}){
1.137     matthew  13900:         next if (! ref($array));
                   13901:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   13902:     }
1.138     matthew  13903:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  13904:     #
                   13905:     # Deal with other parameters
                   13906:     while (my ($key,$value) = each(%Values)) {
                   13907:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  13908:     }
                   13909:     #
1.646     raeburn  13910:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  13911:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   13912: }
                   13913: 
                   13914: ############################################################
                   13915: ############################################################
                   13916: 
                   13917: =pod
                   13918: 
1.648     raeburn  13919: =item * &DrawXYYGraph()
1.138     matthew  13920: 
                   13921: Facilitates the plotting of data in an XY graph with two Y axes.
                   13922: Puts plot definition data into the users environment in order for 
                   13923: graph.png to plot it.  Returns an <img> tag for the plot.
                   13924: 
                   13925: Inputs:
                   13926: 
                   13927: =over 4
                   13928: 
                   13929: =item $Title: string, the title of the plot
                   13930: 
                   13931: =item $xlabel: string, text describing the X-axis of the plot
                   13932: 
                   13933: =item $ylabel: string, text describing the Y-axis of the plot
                   13934: 
                   13935: =item $colors: Array ref containing the hex color codes for the data to be 
                   13936: plotted in.  If undefined, default values will be used.
                   13937: 
                   13938: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   13939: 
                   13940: =item $Ydata1: The first data set
                   13941: 
                   13942: =item $Min1: The minimum value of the left Y-axis
                   13943: 
                   13944: =item $Max1: The maximum value of the left Y-axis
                   13945: 
                   13946: =item $Ydata2: The second data set
                   13947: 
                   13948: =item $Min2: The minimum value of the right Y-axis
                   13949: 
                   13950: =item $Max2: The maximum value of the left Y-axis
                   13951: 
                   13952: =item %Values: hash indicating or overriding any default values which are 
                   13953: passed to graph.png.  
                   13954: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   13955: 
                   13956: =back
                   13957: 
                   13958: Returns:
                   13959: 
                   13960: An <img> tag which references graph.png and the appropriate identifying
                   13961: information for the plot.
1.136     matthew  13962: 
                   13963: =cut
                   13964: 
                   13965: ############################################################
                   13966: ############################################################
1.137     matthew  13967: sub DrawXYYGraph {
                   13968:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   13969:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  13970:     #
                   13971:     # Create the identifier for the graph
                   13972:     my $identifier = &get_cgi_id();
                   13973:     my $id = 'cgi.'.$identifier;
                   13974:     #
                   13975:     $Title  = '' if (! defined($Title));
                   13976:     $xlabel = '' if (! defined($xlabel));
                   13977:     $ylabel = '' if (! defined($ylabel));
                   13978:     my %ValuesHash = 
                   13979:         (
1.369     www      13980:          $id.'.title'  => &escape($Title),
                   13981:          $id.'.xlabel' => &escape($xlabel),
                   13982:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  13983:          $id.'.labels' => join(',',@$Xlabels),
                   13984:          $id.'.PlotType' => 'XY',
                   13985:          $id.'.NumSets' => 2,
1.137     matthew  13986:          $id.'.two_axes' => 1,
                   13987:          $id.'.y1_max_value' => $Max1,
                   13988:          $id.'.y1_min_value' => $Min1,
                   13989:          $id.'.y2_max_value' => $Max2,
                   13990:          $id.'.y2_min_value' => $Min2,
1.136     matthew  13991:          );
                   13992:     #
1.137     matthew  13993:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   13994:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   13995:     }
                   13996:     #
                   13997:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   13998:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  13999:         return '';
                   14000:     }
                   14001:     my $NumSets=1;
1.137     matthew  14002:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  14003:         next if (! ref($array));
                   14004:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  14005:     }
                   14006:     #
                   14007:     # Deal with other parameters
                   14008:     while (my ($key,$value) = each(%Values)) {
                   14009:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  14010:     }
                   14011:     #
1.646     raeburn  14012:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 14013:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  14014: }
                   14015: 
                   14016: ############################################################
                   14017: ############################################################
                   14018: 
                   14019: =pod
                   14020: 
1.157     matthew  14021: =back 
                   14022: 
1.139     matthew  14023: =head1 Statistics helper routines?  
                   14024: 
                   14025: Bad place for them but what the hell.
                   14026: 
1.157     matthew  14027: =over 4
                   14028: 
1.648     raeburn  14029: =item * &chartlink()
1.139     matthew  14030: 
                   14031: Returns a link to the chart for a specific student.  
                   14032: 
                   14033: Inputs:
                   14034: 
                   14035: =over 4
                   14036: 
                   14037: =item $linktext: The text of the link
                   14038: 
                   14039: =item $sname: The students username
                   14040: 
                   14041: =item $sdomain: The students domain
                   14042: 
                   14043: =back
                   14044: 
1.157     matthew  14045: =back
                   14046: 
1.139     matthew  14047: =cut
                   14048: 
                   14049: ############################################################
                   14050: ############################################################
                   14051: sub chartlink {
                   14052:     my ($linktext, $sname, $sdomain) = @_;
                   14053:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      14054:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 14055:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  14056:        '">'.$linktext.'</a>';
1.153     matthew  14057: }
                   14058: 
                   14059: #######################################################
                   14060: #######################################################
                   14061: 
                   14062: =pod
                   14063: 
                   14064: =head1 Course Environment Routines
1.157     matthew  14065: 
                   14066: =over 4
1.153     matthew  14067: 
1.648     raeburn  14068: =item * &restore_course_settings()
1.153     matthew  14069: 
1.648     raeburn  14070: =item * &store_course_settings()
1.153     matthew  14071: 
                   14072: Restores/Store indicated form parameters from the course environment.
                   14073: Will not overwrite existing values of the form parameters.
                   14074: 
                   14075: Inputs: 
                   14076: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   14077: 
                   14078: a hash ref describing the data to be stored.  For example:
                   14079:    
                   14080: %Save_Parameters = ('Status' => 'scalar',
                   14081:     'chartoutputmode' => 'scalar',
                   14082:     'chartoutputdata' => 'scalar',
                   14083:     'Section' => 'array',
1.373     raeburn  14084:     'Group' => 'array',
1.153     matthew  14085:     'StudentData' => 'array',
                   14086:     'Maps' => 'array');
                   14087: 
                   14088: Returns: both routines return nothing
                   14089: 
1.631     raeburn  14090: =back
                   14091: 
1.153     matthew  14092: =cut
                   14093: 
                   14094: #######################################################
                   14095: #######################################################
                   14096: sub store_course_settings {
1.496     albertel 14097:     return &store_settings($env{'request.course.id'},@_);
                   14098: }
                   14099: 
                   14100: sub store_settings {
1.153     matthew  14101:     # save to the environment
                   14102:     # appenv the same items, just to be safe
1.300     albertel 14103:     my $udom  = $env{'user.domain'};
                   14104:     my $uname = $env{'user.name'};
1.496     albertel 14105:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14106:     my %SaveHash;
                   14107:     my %AppHash;
                   14108:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 14109:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 14110:         my $envname = 'environment.'.$basename;
1.258     albertel 14111:         if (exists($env{'form.'.$setting})) {
1.153     matthew  14112:             # Save this value away
                   14113:             if ($type eq 'scalar' &&
1.258     albertel 14114:                 (! exists($env{$envname}) || 
                   14115:                  $env{$envname} ne $env{'form.'.$setting})) {
                   14116:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   14117:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  14118:             } elsif ($type eq 'array') {
                   14119:                 my $stored_form;
1.258     albertel 14120:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  14121:                     $stored_form = join(',',
                   14122:                                         map {
1.369     www      14123:                                             &escape($_);
1.258     albertel 14124:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  14125:                 } else {
                   14126:                     $stored_form = 
1.369     www      14127:                         &escape($env{'form.'.$setting});
1.153     matthew  14128:                 }
                   14129:                 # Determine if the array contents are the same.
1.258     albertel 14130:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  14131:                     $SaveHash{$basename} = $stored_form;
                   14132:                     $AppHash{$envname}   = $stored_form;
                   14133:                 }
                   14134:             }
                   14135:         }
                   14136:     }
                   14137:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 14138:                                           $udom,$uname);
1.153     matthew  14139:     if ($put_result !~ /^(ok|delayed)/) {
                   14140:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   14141:                                  'got error:'.$put_result);
                   14142:     }
                   14143:     # Make sure these settings stick around in this session, too
1.646     raeburn  14144:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  14145:     return;
                   14146: }
                   14147: 
                   14148: sub restore_course_settings {
1.499     albertel 14149:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14150: }
                   14151: 
                   14152: sub restore_settings {
                   14153:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14154:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14155:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14156:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14157:             '.'.$setting;
1.258     albertel 14158:         if (exists($env{$envname})) {
1.153     matthew  14159:             if ($type eq 'scalar') {
1.258     albertel 14160:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14161:             } elsif ($type eq 'array') {
1.258     albertel 14162:                 $env{'form.'.$setting} = [ 
1.153     matthew  14163:                                            map { 
1.369     www      14164:                                                &unescape($_); 
1.258     albertel 14165:                                            } split(',',$env{$envname})
1.153     matthew  14166:                                            ];
                   14167:             }
                   14168:         }
                   14169:     }
1.127     matthew  14170: }
                   14171: 
1.618     raeburn  14172: #######################################################
                   14173: #######################################################
                   14174: 
                   14175: =pod
                   14176: 
                   14177: =head1 Domain E-mail Routines  
                   14178: 
                   14179: =over 4
                   14180: 
1.648     raeburn  14181: =item * &build_recipient_list()
1.618     raeburn  14182: 
1.1075.2.44  raeburn  14183: Build recipient lists for following types of e-mail:
1.766     raeburn  14184: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  14185: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   14186: module change checking, student/employee ID conflict checks, as
                   14187: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   14188: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  14189: 
                   14190: Inputs:
1.1075.2.44  raeburn  14191: defmail (scalar - email address of default recipient),
                   14192: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   14193: requestsmail, updatesmail, or idconflictsmail).
                   14194: 
1.619     raeburn  14195: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  14196: 
                   14197: origmail (scalar - email address of recipient from loncapa.conf,
                   14198: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  14199: 
1.1075.2.139  raeburn  14200: $requname username of requester (if mailing type is helpdeskmail)
                   14201: 
                   14202: $requdom domain of requester (if mailing type is helpdeskmail)
                   14203: 
                   14204: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   14205: 
1.655     raeburn  14206: Returns: comma separated list of addresses to which to send e-mail.
                   14207: 
                   14208: =back
1.618     raeburn  14209: 
                   14210: =cut
                   14211: 
                   14212: ############################################################
                   14213: ############################################################
                   14214: sub build_recipient_list {
1.1075.2.139  raeburn  14215:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  14216:     my @recipients;
1.1075.2.122  raeburn  14217:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  14218:     my %domconfig =
1.1075.2.122  raeburn  14219:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  14220:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  14221:         if (exists($domconfig{'contacts'}{$mailing})) {
                   14222:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   14223:                 my @contacts = ('adminemail','supportemail');
                   14224:                 foreach my $item (@contacts) {
                   14225:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   14226:                         my $addr = $domconfig{'contacts'}{$item}; 
                   14227:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14228:                             push(@recipients,$addr);
                   14229:                         }
1.619     raeburn  14230:                     }
1.1075.2.122  raeburn  14231:                 }
                   14232:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   14233:                 if ($mailing eq 'helpdeskmail') {
                   14234:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   14235:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   14236:                         my @ok_bccs;
                   14237:                         foreach my $bcc (@bccs) {
                   14238:                             $bcc =~ s/^\s+//g;
                   14239:                             $bcc =~ s/\s+$//g;
                   14240:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14241:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14242:                                     push(@ok_bccs,$bcc);
                   14243:                                 }
                   14244:                             }
                   14245:                         }
                   14246:                         if (@ok_bccs > 0) {
                   14247:                             $allbcc = join(', ',@ok_bccs);
                   14248:                         }
                   14249:                     }
                   14250:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  14251:                 }
                   14252:             }
1.766     raeburn  14253:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14254:             $lastresort = $origmail;
1.618     raeburn  14255:         }
1.1075.2.139  raeburn  14256:         if ($mailing eq 'helpdeskmail') {
                   14257:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   14258:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   14259:                 my ($inststatus,$inststatus_checked);
                   14260:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   14261:                     ($env{'user.domain'} ne 'public')) {
                   14262:                     $inststatus_checked = 1;
                   14263:                     $inststatus = $env{'environment.inststatus'};
                   14264:                 }
                   14265:                 unless ($inststatus_checked) {
                   14266:                     if (($requname ne '') && ($requdom ne '')) {
                   14267:                         if (($requname =~ /^$match_username$/) &&
                   14268:                             ($requdom =~ /^$match_domain$/) &&
                   14269:                             (&Apache::lonnet::domain($requdom))) {
                   14270:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   14271:                                                                       $requdom);
                   14272:                             unless ($requhome eq 'no_host') {
                   14273:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   14274:                                 $inststatus = $userenv{'inststatus'};
                   14275:                                 $inststatus_checked = 1;
                   14276:                             }
                   14277:                         }
                   14278:                     }
                   14279:                 }
                   14280:                 unless ($inststatus_checked) {
                   14281:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   14282:                         my %srch = (srchby     => 'email',
                   14283:                                     srchdomain => $defdom,
                   14284:                                     srchterm   => $reqemail,
                   14285:                                     srchtype   => 'exact');
                   14286:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   14287:                         foreach my $uname (keys(%srch_results)) {
                   14288:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14289:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14290:                                 $inststatus_checked = 1;
                   14291:                                 last;
                   14292:                             }
                   14293:                         }
                   14294:                         unless ($inststatus_checked) {
                   14295:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   14296:                             if ($dirsrchres eq 'ok') {
                   14297:                                 foreach my $uname (keys(%srch_results)) {
                   14298:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14299:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14300:                                         $inststatus_checked = 1;
                   14301:                                         last;
                   14302:                                     }
                   14303:                                 }
                   14304:                             }
                   14305:                         }
                   14306:                     }
                   14307:                 }
                   14308:                 if ($inststatus ne '') {
                   14309:                     foreach my $status (split(/\:/,$inststatus)) {
                   14310:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   14311:                             my @contacts = ('adminemail','supportemail');
                   14312:                             foreach my $item (@contacts) {
                   14313:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   14314:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   14315:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14316:                                         push(@recipients,$addr);
                   14317:                                     }
                   14318:                                 }
                   14319:                             }
                   14320:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   14321:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   14322:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   14323:                                 my @ok_bccs;
                   14324:                                 foreach my $bcc (@bccs) {
                   14325:                                     $bcc =~ s/^\s+//g;
                   14326:                                     $bcc =~ s/\s+$//g;
                   14327:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14328:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14329:                                             push(@ok_bccs,$bcc);
                   14330:                                         }
                   14331:                                     }
                   14332:                                 }
                   14333:                                 if (@ok_bccs > 0) {
                   14334:                                     $allbcc = join(', ',@ok_bccs);
                   14335:                                 }
                   14336:                             }
                   14337:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   14338:                             last;
                   14339:                         }
                   14340:                     }
                   14341:                 }
                   14342:             }
                   14343:         }
1.619     raeburn  14344:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14345:         $lastresort = $origmail;
                   14346:     }
1.1075.2.128  raeburn  14347:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  14348:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   14349:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   14350:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   14351:             my %what = (
                   14352:                           perlvar => 1,
                   14353:                        );
                   14354:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   14355:             if ($primary) {
                   14356:                 my $gotaddr;
                   14357:                 my ($result,$returnhash) =
                   14358:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   14359:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   14360:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   14361:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   14362:                         $gotaddr = 1;
                   14363:                     }
                   14364:                 }
                   14365:                 unless ($gotaddr) {
                   14366:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   14367:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   14368:                     unless ($uintdom eq $intdom) {
                   14369:                         my %domconfig =
                   14370:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   14371:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   14372:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   14373:                                 my @contacts = ('adminemail','supportemail');
                   14374:                                 foreach my $item (@contacts) {
                   14375:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   14376:                                         my $addr = $domconfig{'contacts'}{$item};
                   14377:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14378:                                             push(@recipients,$addr);
                   14379:                                         }
                   14380:                                     }
                   14381:                                 }
                   14382:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   14383:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   14384:                                 }
                   14385:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   14386:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   14387:                                     my @ok_bccs;
                   14388:                                     foreach my $bcc (@bccs) {
                   14389:                                         $bcc =~ s/^\s+//g;
                   14390:                                         $bcc =~ s/\s+$//g;
                   14391:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14392:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14393:                                                 push(@ok_bccs,$bcc);
                   14394:                                             }
                   14395:                                         }
                   14396:                                     }
                   14397:                                     if (@ok_bccs > 0) {
                   14398:                                         $allbcc = join(', ',@ok_bccs);
                   14399:                                     }
                   14400:                                 }
                   14401:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   14402:                             }
                   14403:                         }
                   14404:                     }
                   14405:                 }
                   14406:             }
                   14407:         }
1.618     raeburn  14408:     }
1.688     raeburn  14409:     if (defined($defmail)) {
                   14410:         if ($defmail ne '') {
                   14411:             push(@recipients,$defmail);
                   14412:         }
1.618     raeburn  14413:     }
                   14414:     if ($otheremails) {
1.619     raeburn  14415:         my @others;
                   14416:         if ($otheremails =~ /,/) {
                   14417:             @others = split(/,/,$otheremails);
1.618     raeburn  14418:         } else {
1.619     raeburn  14419:             push(@others,$otheremails);
                   14420:         }
                   14421:         foreach my $addr (@others) {
                   14422:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14423:                 push(@recipients,$addr);
                   14424:             }
1.618     raeburn  14425:         }
                   14426:     }
1.1075.2.128  raeburn  14427:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  14428:         if ((!@recipients) && ($lastresort ne '')) {
                   14429:             push(@recipients,$lastresort);
                   14430:         }
                   14431:     } elsif ($lastresort ne '') {
                   14432:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   14433:             push(@recipients,$lastresort);
                   14434:         }
                   14435:     }
                   14436:     my $recipientlist = join(',',@recipients);
                   14437:     if (wantarray) {
                   14438:         return ($recipientlist,$allbcc,$addtext);
                   14439:     } else {
                   14440:         return $recipientlist;
                   14441:     }
1.618     raeburn  14442: }
                   14443: 
1.127     matthew  14444: ############################################################
                   14445: ############################################################
1.154     albertel 14446: 
1.655     raeburn  14447: =pod
                   14448: 
                   14449: =head1 Course Catalog Routines
                   14450: 
                   14451: =over 4
                   14452: 
                   14453: =item * &gather_categories()
                   14454: 
                   14455: Converts category definitions - keys of categories hash stored in  
                   14456: coursecategories in configuration.db on the primary library server in a 
                   14457: domain - to an array.  Also generates javascript and idx hash used to 
                   14458: generate Domain Coordinator interface for editing Course Categories.
                   14459: 
                   14460: Inputs:
1.663     raeburn  14461: 
1.655     raeburn  14462: categories (reference to hash of category definitions).
1.663     raeburn  14463: 
1.655     raeburn  14464: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14465:       categories and subcategories).
1.663     raeburn  14466: 
1.655     raeburn  14467: idx (reference to hash of counters used in Domain Coordinator interface for 
                   14468:       editing Course Categories).
1.663     raeburn  14469: 
1.655     raeburn  14470: jsarray (reference to array of categories used to create Javascript arrays for
                   14471:          Domain Coordinator interface for editing Course Categories).
                   14472: 
                   14473: Returns: nothing
                   14474: 
                   14475: Side effects: populates cats, idx and jsarray. 
                   14476: 
                   14477: =cut
                   14478: 
                   14479: sub gather_categories {
                   14480:     my ($categories,$cats,$idx,$jsarray) = @_;
                   14481:     my %counters;
                   14482:     my $num = 0;
                   14483:     foreach my $item (keys(%{$categories})) {
                   14484:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   14485:         if ($container eq '' && $depth == 0) {
                   14486:             $cats->[$depth][$categories->{$item}] = $cat;
                   14487:         } else {
                   14488:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   14489:         }
                   14490:         my ($escitem,$tail) = split(/:/,$item,2);
                   14491:         if ($counters{$tail} eq '') {
                   14492:             $counters{$tail} = $num;
                   14493:             $num ++;
                   14494:         }
                   14495:         if (ref($idx) eq 'HASH') {
                   14496:             $idx->{$item} = $counters{$tail};
                   14497:         }
                   14498:         if (ref($jsarray) eq 'ARRAY') {
                   14499:             push(@{$jsarray->[$counters{$tail}]},$item);
                   14500:         }
                   14501:     }
                   14502:     return;
                   14503: }
                   14504: 
                   14505: =pod
                   14506: 
                   14507: =item * &extract_categories()
                   14508: 
                   14509: Used to generate breadcrumb trails for course categories.
                   14510: 
                   14511: Inputs:
1.663     raeburn  14512: 
1.655     raeburn  14513: categories (reference to hash of category definitions).
1.663     raeburn  14514: 
1.655     raeburn  14515: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14516:       categories and subcategories).
1.663     raeburn  14517: 
1.655     raeburn  14518: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  14519: 
1.655     raeburn  14520: allitems (reference to hash - key is category key 
                   14521:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14522: 
1.655     raeburn  14523: idx (reference to hash of counters used in Domain Coordinator interface for
                   14524:       editing Course Categories).
1.663     raeburn  14525: 
1.655     raeburn  14526: jsarray (reference to array of categories used to create Javascript arrays for
                   14527:          Domain Coordinator interface for editing Course Categories).
                   14528: 
1.665     raeburn  14529: subcats (reference to hash of arrays containing all subcategories within each 
                   14530:          category, -recursive)
                   14531: 
1.1075.2.132  raeburn  14532: maxd (reference to hash used to hold max depth for all top-level categories).
                   14533: 
1.655     raeburn  14534: Returns: nothing
                   14535: 
                   14536: Side effects: populates trails and allitems hash references.
                   14537: 
                   14538: =cut
                   14539: 
                   14540: sub extract_categories {
1.1075.2.132  raeburn  14541:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  14542:     if (ref($categories) eq 'HASH') {
                   14543:         &gather_categories($categories,$cats,$idx,$jsarray);
                   14544:         if (ref($cats->[0]) eq 'ARRAY') {
                   14545:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   14546:                 my $name = $cats->[0][$i];
                   14547:                 my $item = &escape($name).'::0';
                   14548:                 my $trailstr;
                   14549:                 if ($name eq 'instcode') {
                   14550:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  14551:                 } elsif ($name eq 'communities') {
                   14552:                     $trailstr = &mt('Communities');
1.655     raeburn  14553:                 } else {
                   14554:                     $trailstr = $name;
                   14555:                 }
                   14556:                 if ($allitems->{$item} eq '') {
                   14557:                     push(@{$trails},$trailstr);
                   14558:                     $allitems->{$item} = scalar(@{$trails})-1;
                   14559:                 }
                   14560:                 my @parents = ($name);
                   14561:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   14562:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   14563:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  14564:                         if (ref($subcats) eq 'HASH') {
                   14565:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   14566:                         }
1.1075.2.132  raeburn  14567:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  14568:                     }
                   14569:                 } else {
                   14570:                     if (ref($subcats) eq 'HASH') {
                   14571:                         $subcats->{$item} = [];
1.655     raeburn  14572:                     }
1.1075.2.132  raeburn  14573:                     if (ref($maxd) eq 'HASH') {
                   14574:                         $maxd->{$name} = 1;
                   14575:                     }
1.655     raeburn  14576:                 }
                   14577:             }
                   14578:         }
                   14579:     }
                   14580:     return;
                   14581: }
                   14582: 
                   14583: =pod
                   14584: 
1.1075.2.56  raeburn  14585: =item * &recurse_categories()
1.655     raeburn  14586: 
                   14587: Recursively used to generate breadcrumb trails for course categories.
                   14588: 
                   14589: Inputs:
1.663     raeburn  14590: 
1.655     raeburn  14591: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14592:       categories and subcategories).
1.663     raeburn  14593: 
1.655     raeburn  14594: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  14595: 
                   14596: category (current course category, for which breadcrumb trail is being generated).
                   14597: 
                   14598: trails (reference to array of breadcrumb trails for each category).
                   14599: 
1.655     raeburn  14600: allitems (reference to hash - key is category key
                   14601:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14602: 
1.655     raeburn  14603: parents (array containing containers directories for current category, 
                   14604:          back to top level). 
                   14605: 
                   14606: Returns: nothing
                   14607: 
                   14608: Side effects: populates trails and allitems hash references
                   14609: 
                   14610: =cut
                   14611: 
                   14612: sub recurse_categories {
1.1075.2.132  raeburn  14613:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  14614:     my $shallower = $depth - 1;
                   14615:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   14616:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   14617:             my $name = $cats->[$depth]{$category}[$k];
                   14618:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   14619:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   14620:             if ($allitems->{$item} eq '') {
                   14621:                 push(@{$trails},$trailstr);
                   14622:                 $allitems->{$item} = scalar(@{$trails})-1;
                   14623:             }
                   14624:             my $deeper = $depth+1;
                   14625:             push(@{$parents},$category);
1.665     raeburn  14626:             if (ref($subcats) eq 'HASH') {
                   14627:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   14628:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   14629:                     my $higher;
                   14630:                     if ($j > 0) {
                   14631:                         $higher = &escape($parents->[$j]).':'.
                   14632:                                   &escape($parents->[$j-1]).':'.$j;
                   14633:                     } else {
                   14634:                         $higher = &escape($parents->[$j]).'::'.$j;
                   14635:                     }
                   14636:                     push(@{$subcats->{$higher}},$subcat);
                   14637:                 }
                   14638:             }
                   14639:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132  raeburn  14640:                                 $subcats,$maxd);
1.655     raeburn  14641:             pop(@{$parents});
                   14642:         }
                   14643:     } else {
                   14644:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132  raeburn  14645:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  14646:         if ($allitems->{$item} eq '') {
                   14647:             push(@{$trails},$trailstr);
                   14648:             $allitems->{$item} = scalar(@{$trails})-1;
                   14649:         }
1.1075.2.132  raeburn  14650:         if (ref($maxd) eq 'HASH') {
                   14651:             if ($depth > $maxd->{$parents->[0]}) {
                   14652:                 $maxd->{$parents->[0]} = $depth;
                   14653:             }
                   14654:         }
1.655     raeburn  14655:     }
                   14656:     return;
                   14657: }
                   14658: 
1.663     raeburn  14659: =pod
                   14660: 
1.1075.2.56  raeburn  14661: =item * &assign_categories_table()
1.663     raeburn  14662: 
                   14663: Create a datatable for display of hierarchical categories in a domain,
                   14664: with checkboxes to allow a course to be categorized. 
                   14665: 
                   14666: Inputs:
                   14667: 
                   14668: cathash - reference to hash of categories defined for the domain (from
                   14669:           configuration.db)
                   14670: 
                   14671: currcat - scalar with an & separated list of categories assigned to a course. 
                   14672: 
1.919     raeburn  14673: type    - scalar contains course type (Course or Community).
                   14674: 
1.1075.2.117  raeburn  14675: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14676:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14677: 
1.663     raeburn  14678: Returns: $output (markup to be displayed) 
                   14679: 
                   14680: =cut
                   14681: 
                   14682: sub assign_categories_table {
1.1075.2.117  raeburn  14683:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  14684:     my $output;
                   14685:     if (ref($cathash) eq 'HASH') {
1.1075.2.132  raeburn  14686:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   14687:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  14688:         $maxdepth = scalar(@cats);
                   14689:         if (@cats > 0) {
                   14690:             my $itemcount = 0;
                   14691:             if (ref($cats[0]) eq 'ARRAY') {
                   14692:                 my @currcategories;
                   14693:                 if ($currcat ne '') {
                   14694:                     @currcategories = split('&',$currcat);
                   14695:                 }
1.919     raeburn  14696:                 my $table;
1.663     raeburn  14697:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   14698:                     my $parent = $cats[0][$i];
1.919     raeburn  14699:                     next if ($parent eq 'instcode');
                   14700:                     if ($type eq 'Community') {
                   14701:                         next unless ($parent eq 'communities');
                   14702:                     } else {
                   14703:                         next if ($parent eq 'communities');
                   14704:                     }
1.663     raeburn  14705:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   14706:                     my $item = &escape($parent).'::0';
                   14707:                     my $checked = '';
                   14708:                     if (@currcategories > 0) {
                   14709:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   14710:                             $checked = ' checked="checked"';
1.663     raeburn  14711:                         }
                   14712:                     }
1.919     raeburn  14713:                     my $parent_title = $parent;
                   14714:                     if ($parent eq 'communities') {
                   14715:                         $parent_title = &mt('Communities');
                   14716:                     }
                   14717:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   14718:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  14719:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  14720:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  14721:                     my $depth = 1;
                   14722:                     push(@path,$parent);
1.1075.2.117  raeburn  14723:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  14724:                     pop(@path);
1.919     raeburn  14725:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  14726:                     $itemcount ++;
                   14727:                 }
1.919     raeburn  14728:                 if ($itemcount) {
                   14729:                     $output = &Apache::loncommon::start_data_table().
                   14730:                               $table.
                   14731:                               &Apache::loncommon::end_data_table();
                   14732:                 }
1.663     raeburn  14733:             }
                   14734:         }
                   14735:     }
                   14736:     return $output;
                   14737: }
                   14738: 
                   14739: =pod
                   14740: 
1.1075.2.56  raeburn  14741: =item * &assign_category_rows()
1.663     raeburn  14742: 
                   14743: Create a datatable row for display of nested categories in a domain,
                   14744: with checkboxes to allow a course to be categorized,called recursively.
                   14745: 
                   14746: Inputs:
                   14747: 
                   14748: itemcount - track row number for alternating colors
                   14749: 
                   14750: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   14751:       categories and subcategories.
                   14752: 
                   14753: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   14754: 
                   14755: parent - parent of current category item
                   14756: 
                   14757: path - Array containing all categories back up through the hierarchy from the
                   14758:        current category to the top level.
                   14759: 
                   14760: currcategories - reference to array of current categories assigned to the course
                   14761: 
1.1075.2.117  raeburn  14762: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14763:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14764: 
1.663     raeburn  14765: Returns: $output (markup to be displayed).
                   14766: 
                   14767: =cut
                   14768: 
                   14769: sub assign_category_rows {
1.1075.2.117  raeburn  14770:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  14771:     my ($text,$name,$item,$chgstr);
                   14772:     if (ref($cats) eq 'ARRAY') {
                   14773:         my $maxdepth = scalar(@{$cats});
                   14774:         if (ref($cats->[$depth]) eq 'HASH') {
                   14775:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   14776:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   14777:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  14778:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  14779:                 for (my $j=0; $j<$numchildren; $j++) {
                   14780:                     $name = $cats->[$depth]{$parent}[$j];
                   14781:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   14782:                     my $deeper = $depth+1;
                   14783:                     my $checked = '';
                   14784:                     if (ref($currcategories) eq 'ARRAY') {
                   14785:                         if (@{$currcategories} > 0) {
                   14786:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   14787:                                 $checked = ' checked="checked"';
1.663     raeburn  14788:                             }
                   14789:                         }
                   14790:                     }
1.664     raeburn  14791:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   14792:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  14793:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  14794:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   14795:                              '</td><td>';
1.663     raeburn  14796:                     if (ref($path) eq 'ARRAY') {
                   14797:                         push(@{$path},$name);
1.1075.2.117  raeburn  14798:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  14799:                         pop(@{$path});
                   14800:                     }
                   14801:                     $text .= '</td></tr>';
                   14802:                 }
                   14803:                 $text .= '</table></td>';
                   14804:             }
                   14805:         }
                   14806:     }
                   14807:     return $text;
                   14808: }
                   14809: 
1.1075.2.69  raeburn  14810: =pod
                   14811: 
                   14812: =back
                   14813: 
                   14814: =cut
                   14815: 
1.655     raeburn  14816: ############################################################
                   14817: ############################################################
                   14818: 
                   14819: 
1.443     albertel 14820: sub commit_customrole {
1.664     raeburn  14821:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  14822:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 14823:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   14824:                          ($end?', ending '.localtime($end):'').': <b>'.
                   14825:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  14826:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 14827:                  '</b><br />';
                   14828:     return $output;
                   14829: }
                   14830: 
                   14831: sub commit_standardrole {
1.1075.2.31  raeburn  14832:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  14833:     my ($output,$logmsg,$linefeed);
                   14834:     if ($context eq 'auto') {
                   14835:         $linefeed = "\n";
                   14836:     } else {
                   14837:         $linefeed = "<br />\n";
                   14838:     }  
1.443     albertel 14839:     if ($three eq 'st') {
1.541     raeburn  14840:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  14841:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  14842:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  14843:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   14844:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 14845:         } else {
1.541     raeburn  14846:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 14847:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14848:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   14849:             if ($context eq 'auto') {
                   14850:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   14851:             } else {
                   14852:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   14853:                &mt('Add to classlist').': <b>ok</b>';
                   14854:             }
                   14855:             $output .= $linefeed;
1.443     albertel 14856:         }
                   14857:     } else {
                   14858:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   14859:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  14860:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  14861:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  14862:         if ($context eq 'auto') {
                   14863:             $output .= $result.$linefeed;
                   14864:         } else {
                   14865:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   14866:         }
1.443     albertel 14867:     }
                   14868:     return $output;
                   14869: }
                   14870: 
                   14871: sub commit_studentrole {
1.1075.2.31  raeburn  14872:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   14873:         $credits) = @_;
1.626     raeburn  14874:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  14875:     if ($context eq 'auto') {
                   14876:         $linefeed = "\n";
                   14877:     } else {
                   14878:         $linefeed = '<br />'."\n";
                   14879:     }
1.443     albertel 14880:     if (defined($one) && defined($two)) {
                   14881:         my $cid=$one.'_'.$two;
                   14882:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   14883:         my $secchange = 0;
                   14884:         my $expire_role_result;
                   14885:         my $modify_section_result;
1.628     raeburn  14886:         if ($oldsec ne '-1') { 
                   14887:             if ($oldsec ne $sec) {
1.443     albertel 14888:                 $secchange = 1;
1.628     raeburn  14889:                 my $now = time;
1.443     albertel 14890:                 my $uurl='/'.$cid;
                   14891:                 $uurl=~s/\_/\//g;
                   14892:                 if ($oldsec) {
                   14893:                     $uurl.='/'.$oldsec;
                   14894:                 }
1.626     raeburn  14895:                 $oldsecurl = $uurl;
1.628     raeburn  14896:                 $expire_role_result = 
1.652     raeburn  14897:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  14898:                 if ($env{'request.course.sec'} ne '') { 
                   14899:                     if ($expire_role_result eq 'refused') {
                   14900:                         my @roles = ('st');
                   14901:                         my @statuses = ('previous');
                   14902:                         my @roledoms = ($one);
                   14903:                         my $withsec = 1;
                   14904:                         my %roleshash = 
                   14905:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   14906:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   14907:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   14908:                             my ($oldstart,$oldend) = 
                   14909:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   14910:                             if ($oldend > 0 && $oldend <= $now) {
                   14911:                                 $expire_role_result = 'ok';
                   14912:                             }
                   14913:                         }
                   14914:                     }
                   14915:                 }
1.443     albertel 14916:                 $result = $expire_role_result;
                   14917:             }
                   14918:         }
                   14919:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  14920:             $modify_section_result = 
                   14921:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   14922:                                                            undef,undef,undef,$sec,
                   14923:                                                            $end,$start,'','',$cid,
                   14924:                                                            '',$context,$credits);
1.443     albertel 14925:             if ($modify_section_result =~ /^ok/) {
                   14926:                 if ($secchange == 1) {
1.628     raeburn  14927:                     if ($sec eq '') {
                   14928:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   14929:                     } else {
                   14930:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   14931:                     }
1.443     albertel 14932:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  14933:                     if ($sec eq '') {
                   14934:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   14935:                     } else {
                   14936:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   14937:                     }
1.443     albertel 14938:                 } else {
1.628     raeburn  14939:                     if ($sec eq '') {
                   14940:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   14941:                     } else {
                   14942:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   14943:                     }
1.443     albertel 14944:                 }
                   14945:             } else {
1.628     raeburn  14946:                 if ($secchange) {       
                   14947:                     $$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;
                   14948:                 } else {
                   14949:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   14950:                 }
1.443     albertel 14951:             }
                   14952:             $result = $modify_section_result;
                   14953:         } elsif ($secchange == 1) {
1.628     raeburn  14954:             if ($oldsec eq '') {
1.1075.2.20  raeburn  14955:                 $$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  14956:             } else {
                   14957:                 $$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;
                   14958:             }
1.626     raeburn  14959:             if ($expire_role_result eq 'refused') {
                   14960:                 my $newsecurl = '/'.$cid;
                   14961:                 $newsecurl =~ s/\_/\//g;
                   14962:                 if ($sec ne '') {
                   14963:                     $newsecurl.='/'.$sec;
                   14964:                 }
                   14965:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   14966:                     if ($sec eq '') {
                   14967:                         $$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;
                   14968:                     } else {
                   14969:                         $$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;
                   14970:                     }
                   14971:                 }
                   14972:             }
1.443     albertel 14973:         }
                   14974:     } else {
1.626     raeburn  14975:         $$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 14976:         $result = "error: incomplete course id\n";
                   14977:     }
                   14978:     return $result;
                   14979: }
                   14980: 
1.1075.2.25  raeburn  14981: sub show_role_extent {
                   14982:     my ($scope,$context,$role) = @_;
                   14983:     $scope =~ s{^/}{};
                   14984:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   14985:     push(@courseroles,'co');
                   14986:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   14987:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   14988:         $scope =~ s{/}{_};
                   14989:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   14990:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   14991:         my ($audom,$auname) = split(/\//,$scope);
                   14992:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   14993:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   14994:     } else {
                   14995:         $scope =~ s{/$}{};
                   14996:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   14997:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   14998:     }
                   14999: }
                   15000: 
1.443     albertel 15001: ############################################################
                   15002: ############################################################
                   15003: 
1.566     albertel 15004: sub check_clone {
1.578     raeburn  15005:     my ($args,$linefeed) = @_;
1.566     albertel 15006:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   15007:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   15008:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   15009:     my $clonemsg;
                   15010:     my $can_clone = 0;
1.944     raeburn  15011:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  15012:     if ($lctype ne 'community') {
                   15013:         $lctype = 'course';
                   15014:     }
1.566     albertel 15015:     if ($clonehome eq 'no_host') {
1.944     raeburn  15016:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15017:             $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'});
                   15018:         } else {
                   15019:             $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'});
                   15020:         }     
1.566     albertel 15021:     } else {
                   15022: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  15023:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15024:             if ($clonedesc{'type'} ne 'Community') {
                   15025:                  $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'});
                   15026:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15027:             }
                   15028:         }
1.1075.2.119  raeburn  15029: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  15030:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 15031: 	    $can_clone = 1;
                   15032: 	} else {
1.1075.2.95  raeburn  15033: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 15034: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  15035:             if ($clonehash{'cloners'} eq '') {
                   15036:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   15037:                 if ($domdefs{'canclone'}) {
                   15038:                     unless ($domdefs{'canclone'} eq 'none') {
                   15039:                         if ($domdefs{'canclone'} eq 'domain') {
                   15040:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   15041:                                 $can_clone = 1;
                   15042:                             }
                   15043:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15044:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   15045:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   15046:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   15047:                                 $can_clone = 1;
                   15048:                             }
                   15049:                         }
                   15050:                     }
1.908     raeburn  15051:                 }
1.1075.2.95  raeburn  15052:             } else {
                   15053: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   15054:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  15055:                     $can_clone = 1;
1.1075.2.95  raeburn  15056:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  15057:                     $can_clone = 1;
1.1075.2.96  raeburn  15058:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   15059:                     $can_clone = 1;
1.1075.2.95  raeburn  15060:                 }
                   15061:                 unless ($can_clone) {
1.1075.2.96  raeburn  15062:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15063:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  15064:                         my (%gotdomdefaults,%gotcodedefaults);
                   15065:                         foreach my $cloner (@cloners) {
                   15066:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   15067:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   15068:                                 my (%codedefaults,@code_order);
                   15069:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   15070:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   15071:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   15072:                                     }
                   15073:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   15074:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   15075:                                     }
                   15076:                                 } else {
                   15077:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   15078:                                                                             \%codedefaults,
                   15079:                                                                             \@code_order);
                   15080:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   15081:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   15082:                                 }
                   15083:                                 if (@code_order > 0) {
                   15084:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   15085:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   15086:                                                                                 $args->{'crscode'})) {
                   15087:                                         $can_clone = 1;
                   15088:                                         last;
                   15089:                                     }
                   15090:                                 }
                   15091:                             }
                   15092:                         }
                   15093:                     }
1.1075.2.96  raeburn  15094:                 }
                   15095:             }
                   15096:             unless ($can_clone) {
                   15097:                 my $ccrole = 'cc';
                   15098:                 if ($args->{'crstype'} eq 'Community') {
                   15099:                     $ccrole = 'co';
                   15100:                 }
                   15101:                 my %roleshash =
                   15102:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   15103:                                                   $args->{'ccdomain'},
                   15104:                                                   'userroles',['active'],[$ccrole],
                   15105:                                                   [$args->{'clonedomain'}]);
                   15106:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   15107:                     $can_clone = 1;
                   15108:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   15109:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   15110:                     $can_clone = 1;
1.1075.2.95  raeburn  15111:                 }
                   15112:             }
                   15113:             unless ($can_clone) {
                   15114:                 if ($args->{'crstype'} eq 'Community') {
                   15115:                     $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'});
                   15116:                 } else {
                   15117:                     $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  15118: 	        }
1.566     albertel 15119: 	    }
1.578     raeburn  15120:         }
1.566     albertel 15121:     }
                   15122:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15123: }
                   15124: 
1.444     albertel 15125: sub construct_course {
1.1075.2.119  raeburn  15126:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
                   15127:         $cnum,$category,$coderef) = @_;
1.444     albertel 15128:     my $outcome;
1.541     raeburn  15129:     my $linefeed =  '<br />'."\n";
                   15130:     if ($context eq 'auto') {
                   15131:         $linefeed = "\n";
                   15132:     }
1.566     albertel 15133: 
                   15134: #
                   15135: # Are we cloning?
                   15136: #
                   15137:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15138:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  15139: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 15140: 	if ($context ne 'auto') {
1.578     raeburn  15141:             if ($clonemsg ne '') {
                   15142: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   15143:             }
1.566     albertel 15144: 	}
                   15145: 	$outcome .= $clonemsg.$linefeed;
                   15146: 
                   15147:         if (!$can_clone) {
                   15148: 	    return (0,$outcome);
                   15149: 	}
                   15150:     }
                   15151: 
1.444     albertel 15152: #
                   15153: # Open course
                   15154: #
                   15155:     my $crstype = lc($args->{'crstype'});
                   15156:     my %cenv=();
                   15157:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   15158:                                              $args->{'cdescr'},
                   15159:                                              $args->{'curl'},
                   15160:                                              $args->{'course_home'},
                   15161:                                              $args->{'nonstandard'},
                   15162:                                              $args->{'crscode'},
                   15163:                                              $args->{'ccuname'}.':'.
                   15164:                                              $args->{'ccdomain'},
1.882     raeburn  15165:                                              $args->{'crstype'},
1.885     raeburn  15166:                                              $cnum,$context,$category);
1.444     albertel 15167: 
                   15168:     # Note: The testing routines depend on this being output; see 
                   15169:     # Utils::Course. This needs to at least be output as a comment
                   15170:     # if anyone ever decides to not show this, and Utils::Course::new
                   15171:     # will need to be suitably modified.
1.541     raeburn  15172:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  15173:     if ($$courseid =~ /^error:/) {
                   15174:         return (0,$outcome);
                   15175:     }
                   15176: 
1.444     albertel 15177: #
                   15178: # Check if created correctly
                   15179: #
1.479     albertel 15180:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 15181:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  15182:     if ($crsuhome eq 'no_host') {
                   15183:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   15184:         return (0,$outcome);
                   15185:     }
1.541     raeburn  15186:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 15187: 
1.444     albertel 15188: #
1.566     albertel 15189: # Do the cloning
                   15190: #   
                   15191:     if ($can_clone && $cloneid) {
                   15192: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   15193: 	if ($context ne 'auto') {
                   15194: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   15195: 	}
                   15196: 	$outcome .= $clonemsg.$linefeed;
                   15197: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 15198: # Copy all files
1.637     www      15199: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 15200: # Restore URL
1.566     albertel 15201: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 15202: # Restore title
1.566     albertel 15203: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  15204: # Restore creation date, creator and creation context.
                   15205:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   15206:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   15207:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 15208: # Mark as cloned
1.566     albertel 15209: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      15210: # Need to clone grading mode
                   15211:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   15212:         $cenv{'grading'}=$newenv{'grading'};
                   15213: # Do not clone these environment entries
                   15214:         &Apache::lonnet::del('environment',
                   15215:                   ['default_enrollment_start_date',
                   15216:                    'default_enrollment_end_date',
                   15217:                    'question.email',
                   15218:                    'policy.email',
                   15219:                    'comment.email',
                   15220:                    'pch.users.denied',
1.725     raeburn  15221:                    'plc.users.denied',
                   15222:                    'hidefromcat',
1.1075.2.36  raeburn  15223:                    'checkforpriv',
1.1075.2.59  raeburn  15224:                    'categories',
                   15225:                    'internal.uniquecode'],
1.638     www      15226:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  15227:         if ($args->{'textbook'}) {
                   15228:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   15229:         }
1.444     albertel 15230:     }
1.566     albertel 15231: 
1.444     albertel 15232: #
                   15233: # Set environment (will override cloned, if existing)
                   15234: #
                   15235:     my @sections = ();
                   15236:     my @xlists = ();
                   15237:     if ($args->{'crstype'}) {
                   15238:         $cenv{'type'}=$args->{'crstype'};
                   15239:     }
                   15240:     if ($args->{'crsid'}) {
                   15241:         $cenv{'courseid'}=$args->{'crsid'};
                   15242:     }
                   15243:     if ($args->{'crscode'}) {
                   15244:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   15245:     }
                   15246:     if ($args->{'crsquota'} ne '') {
                   15247:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   15248:     } else {
                   15249:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   15250:     }
                   15251:     if ($args->{'ccuname'}) {
                   15252:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   15253:                                         ':'.$args->{'ccdomain'};
                   15254:     } else {
                   15255:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   15256:     }
1.1075.2.31  raeburn  15257:     if ($args->{'defaultcredits'}) {
                   15258:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   15259:     }
1.444     albertel 15260:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   15261:     if ($args->{'crssections'}) {
                   15262:         $cenv{'internal.sectionnums'} = '';
                   15263:         if ($args->{'crssections'} =~ m/,/) {
                   15264:             @sections = split/,/,$args->{'crssections'};
                   15265:         } else {
                   15266:             $sections[0] = $args->{'crssections'};
                   15267:         }
                   15268:         if (@sections > 0) {
                   15269:             foreach my $item (@sections) {
                   15270:                 my ($sec,$gp) = split/:/,$item;
                   15271:                 my $class = $args->{'crscode'}.$sec;
                   15272:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   15273:                 $cenv{'internal.sectionnums'} .= $item.',';
                   15274:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15275:                     push(@badclasses,$class);
1.444     albertel 15276:                 }
                   15277:             }
                   15278:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   15279:         }
                   15280:     }
                   15281: # do not hide course coordinator from staff listing, 
                   15282: # even if privileged
                   15283:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  15284: # add course coordinator's domain to domains to check for privileged users
                   15285: # if different to course domain
                   15286:     if ($$crsudom ne $args->{'ccdomain'}) {
                   15287:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   15288:     }
1.444     albertel 15289: # add crosslistings
                   15290:     if ($args->{'crsxlist'}) {
                   15291:         $cenv{'internal.crosslistings'}='';
                   15292:         if ($args->{'crsxlist'} =~ m/,/) {
                   15293:             @xlists = split/,/,$args->{'crsxlist'};
                   15294:         } else {
                   15295:             $xlists[0] = $args->{'crsxlist'};
                   15296:         }
                   15297:         if (@xlists > 0) {
                   15298:             foreach my $item (@xlists) {
                   15299:                 my ($xl,$gp) = split/:/,$item;
                   15300:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   15301:                 $cenv{'internal.crosslistings'} .= $item.',';
                   15302:                 unless ($addcheck eq 'ok') {
1.1075.2.119  raeburn  15303:                     push(@badclasses,$xl);
1.444     albertel 15304:                 }
                   15305:             }
                   15306:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   15307:         }
                   15308:     }
                   15309:     if ($args->{'autoadds'}) {
                   15310:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   15311:     }
                   15312:     if ($args->{'autodrops'}) {
                   15313:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   15314:     }
                   15315: # check for notification of enrollment changes
                   15316:     my @notified = ();
                   15317:     if ($args->{'notify_owner'}) {
                   15318:         if ($args->{'ccuname'} ne '') {
                   15319:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   15320:         }
                   15321:     }
                   15322:     if ($args->{'notify_dc'}) {
                   15323:         if ($uname ne '') { 
1.630     raeburn  15324:             push(@notified,$uname.':'.$udom);
1.444     albertel 15325:         }
                   15326:     }
                   15327:     if (@notified > 0) {
                   15328:         my $notifylist;
                   15329:         if (@notified > 1) {
                   15330:             $notifylist = join(',',@notified);
                   15331:         } else {
                   15332:             $notifylist = $notified[0];
                   15333:         }
                   15334:         $cenv{'internal.notifylist'} = $notifylist;
                   15335:     }
                   15336:     if (@badclasses > 0) {
                   15337:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  15338:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   15339:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   15340:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 15341:         );
1.1075.2.119  raeburn  15342:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   15343:                            &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  15344:         if ($context eq 'auto') {
                   15345:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  15346:         } else {
1.566     albertel 15347:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  15348:         }
                   15349:         foreach my $item (@badclasses) {
1.541     raeburn  15350:             if ($context eq 'auto') {
1.1075.2.119  raeburn  15351:                 $outcome .= " - $item\n";
1.541     raeburn  15352:             } else {
1.1075.2.119  raeburn  15353:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  15354:             }
1.1075.2.119  raeburn  15355:         }
                   15356:         if ($context eq 'auto') {
                   15357:             $outcome .= $linefeed;
                   15358:         } else {
                   15359:             $outcome .= "</ul><br /><br /></div>\n";
                   15360:         }
1.444     albertel 15361:     }
                   15362:     if ($args->{'no_end_date'}) {
                   15363:         $args->{'endaccess'} = 0;
                   15364:     }
                   15365:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   15366:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   15367:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   15368:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   15369:     if ($args->{'showphotos'}) {
                   15370:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   15371:     }
                   15372:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   15373:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   15374:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   15375:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  15376:             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'); 
                   15377:             if ($context eq 'auto') {
                   15378:                 $outcome .= $krb_msg;
                   15379:             } else {
1.566     albertel 15380:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  15381:             }
                   15382:             $outcome .= $linefeed;
1.444     albertel 15383:         }
                   15384:     }
                   15385:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   15386:        if ($args->{'setpolicy'}) {
                   15387:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15388:        }
                   15389:        if ($args->{'setcontent'}) {
                   15390:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15391:        }
1.1075.2.110  raeburn  15392:        if ($args->{'setcomment'}) {
                   15393:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15394:        }
1.444     albertel 15395:     }
                   15396:     if ($args->{'reshome'}) {
                   15397: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   15398: 	$cenv{'reshome'}=~s/\/+$/\//;
                   15399:     }
                   15400: #
                   15401: # course has keyed access
                   15402: #
                   15403:     if ($args->{'setkeys'}) {
                   15404:        $cenv{'keyaccess'}='yes';
                   15405:     }
                   15406: # if specified, key authority is not course, but user
                   15407: # only active if keyaccess is yes
                   15408:     if ($args->{'keyauth'}) {
1.487     albertel 15409: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   15410: 	$user = &LONCAPA::clean_username($user);
                   15411: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     15412: 	if ($user ne '' && $domain ne '') {
1.487     albertel 15413: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 15414: 	}
                   15415:     }
                   15416: 
1.1075.2.59  raeburn  15417: #
                   15418: #  generate and store uniquecode (available to course requester), if course should have one.
                   15419: #
                   15420:     if ($args->{'uniquecode'}) {
                   15421:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   15422:         if ($code) {
                   15423:             $cenv{'internal.uniquecode'} = $code;
                   15424:             my %crsinfo =
                   15425:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   15426:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   15427:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   15428:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   15429:             }
                   15430:             if (ref($coderef)) {
                   15431:                 $$coderef = $code;
                   15432:             }
                   15433:         }
                   15434:     }
                   15435: 
1.444     albertel 15436:     if ($args->{'disresdis'}) {
                   15437:         $cenv{'pch.roles.denied'}='st';
                   15438:     }
                   15439:     if ($args->{'disablechat'}) {
                   15440:         $cenv{'plc.roles.denied'}='st';
                   15441:     }
                   15442: 
                   15443:     # Record we've not yet viewed the Course Initialization Helper for this 
                   15444:     # course
                   15445:     $cenv{'course.helper.not.run'} = 1;
                   15446:     #
                   15447:     # Use new Randomseed
                   15448:     #
                   15449:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   15450:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   15451:     #
                   15452:     # The encryption code and receipt prefix for this course
                   15453:     #
                   15454:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   15455:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   15456:     #
                   15457:     # By default, use standard grading
                   15458:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   15459: 
1.541     raeburn  15460:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   15461:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15462: #
                   15463: # Open all assignments
                   15464: #
                   15465:     if ($args->{'openall'}) {
                   15466:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   15467:        my %storecontent = ($storeunder         => time,
                   15468:                            $storeunder.'.type' => 'date_start');
                   15469:        
                   15470:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  15471:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15472:    }
                   15473: #
                   15474: # Set first page
                   15475: #
                   15476:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   15477: 	    || ($cloneid)) {
1.445     albertel 15478: 	use LONCAPA::map;
1.444     albertel 15479: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 15480: 
                   15481: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   15482:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   15483: 
1.444     albertel 15484:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   15485:         my $title; my $url;
                   15486:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   15487: 	    $title=&mt('Syllabus');
1.444     albertel 15488:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   15489:         } else {
1.963     raeburn  15490:             $title=&mt('Table of Contents');
1.444     albertel 15491:             $url='/adm/navmaps';
                   15492:         }
1.445     albertel 15493: 
                   15494:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   15495: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   15496: 
                   15497: 	if ($errtext) { $fatal=2; }
1.541     raeburn  15498:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 15499:     }
1.566     albertel 15500: 
                   15501:     return (1,$outcome);
1.444     albertel 15502: }
                   15503: 
1.1075.2.59  raeburn  15504: sub make_unique_code {
                   15505:     my ($cdom,$cnum) = @_;
                   15506:     # get lock on uniquecodes db
                   15507:     my $lockhash = {
                   15508:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   15509:                                                   ':'.$env{'user.domain'},
                   15510:                    };
                   15511:     my $tries = 0;
                   15512:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15513:     my ($code,$error);
                   15514: 
                   15515:     while (($gotlock ne 'ok') && ($tries<3)) {
                   15516:         $tries ++;
                   15517:         sleep 1;
                   15518:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15519:     }
                   15520:     if ($gotlock eq 'ok') {
                   15521:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   15522:         my $gotcode;
                   15523:         my $attempts = 0;
                   15524:         while ((!$gotcode) && ($attempts < 100)) {
                   15525:             $code = &generate_code();
                   15526:             if (!exists($currcodes{$code})) {
                   15527:                 $gotcode = 1;
                   15528:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   15529:                     $error = 'nostore';
                   15530:                 }
                   15531:             }
                   15532:             $attempts ++;
                   15533:         }
                   15534:         my @del_lock = ($cnum."\0".'uniquecodes');
                   15535:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   15536:     } else {
                   15537:         $error = 'nolock';
                   15538:     }
                   15539:     return ($code,$error);
                   15540: }
                   15541: 
                   15542: sub generate_code {
                   15543:     my $code;
                   15544:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   15545:     for (my $i=0; $i<6; $i++) {
                   15546:         my $lettnum = int (rand 2);
                   15547:         my $item = '';
                   15548:         if ($lettnum) {
                   15549:             $item = $letts[int( rand(18) )];
                   15550:         } else {
                   15551:             $item = 1+int( rand(8) );
                   15552:         }
                   15553:         $code .= $item;
                   15554:     }
                   15555:     return $code;
                   15556: }
                   15557: 
1.444     albertel 15558: ############################################################
                   15559: ############################################################
                   15560: 
1.953     droeschl 15561: #SD
                   15562: # only Community and Course, or anything else?
1.378     raeburn  15563: sub course_type {
                   15564:     my ($cid) = @_;
                   15565:     if (!defined($cid)) {
                   15566:         $cid = $env{'request.course.id'};
                   15567:     }
1.404     albertel 15568:     if (defined($env{'course.'.$cid.'.type'})) {
                   15569:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  15570:     } else {
                   15571:         return 'Course';
1.377     raeburn  15572:     }
                   15573: }
1.156     albertel 15574: 
1.406     raeburn  15575: sub group_term {
                   15576:     my $crstype = &course_type();
                   15577:     my %names = (
                   15578:                   'Course' => 'group',
1.865     raeburn  15579:                   'Community' => 'group',
1.406     raeburn  15580:                 );
                   15581:     return $names{$crstype};
                   15582: }
                   15583: 
1.902     raeburn  15584: sub course_types {
1.1075.2.59  raeburn  15585:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  15586:     my %typename = (
                   15587:                          official   => 'Official course',
                   15588:                          unofficial => 'Unofficial course',
                   15589:                          community  => 'Community',
1.1075.2.59  raeburn  15590:                          textbook   => 'Textbook course',
1.902     raeburn  15591:                    );
                   15592:     return (\@types,\%typename);
                   15593: }
                   15594: 
1.156     albertel 15595: sub icon {
                   15596:     my ($file)=@_;
1.505     albertel 15597:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 15598:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 15599:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 15600:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   15601: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   15602: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15603: 	            $curfext.".gif") {
                   15604: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15605: 		$curfext.".gif";
                   15606: 	}
                   15607:     }
1.249     albertel 15608:     return &lonhttpdurl($iconname);
1.154     albertel 15609: } 
1.84      albertel 15610: 
1.575     albertel 15611: sub lonhttpdurl {
1.692     www      15612: #
                   15613: # Had been used for "small fry" static images on separate port 8080.
                   15614: # Modify here if lightweight http functionality desired again.
                   15615: # Currently eliminated due to increasing firewall issues.
                   15616: #
1.575     albertel 15617:     my ($url)=@_;
1.692     www      15618:     return $url;
1.215     albertel 15619: }
                   15620: 
1.213     albertel 15621: sub connection_aborted {
                   15622:     my ($r)=@_;
                   15623:     $r->print(" ");$r->rflush();
                   15624:     my $c = $r->connection;
                   15625:     return $c->aborted();
                   15626: }
                   15627: 
1.221     foxr     15628: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     15629: #    strings as 'strings'.
                   15630: sub escape_single {
1.221     foxr     15631:     my ($input) = @_;
1.223     albertel 15632:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     15633:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   15634:     return $input;
                   15635: }
1.223     albertel 15636: 
1.222     foxr     15637: #  Same as escape_single, but escape's "'s  This 
                   15638: #  can be used for  "strings"
                   15639: sub escape_double {
                   15640:     my ($input) = @_;
                   15641:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   15642:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   15643:     return $input;
                   15644: }
1.223     albertel 15645:  
1.222     foxr     15646: #   Escapes the last element of a full URL.
                   15647: sub escape_url {
                   15648:     my ($url)   = @_;
1.238     raeburn  15649:     my @urlslices = split(/\//, $url,-1);
1.369     www      15650:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  15651:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     15652: }
1.462     albertel 15653: 
1.820     raeburn  15654: sub compare_arrays {
                   15655:     my ($arrayref1,$arrayref2) = @_;
                   15656:     my (@difference,%count);
                   15657:     @difference = ();
                   15658:     %count = ();
                   15659:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   15660:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   15661:         foreach my $element (keys(%count)) {
                   15662:             if ($count{$element} == 1) {
                   15663:                 push(@difference,$element);
                   15664:             }
                   15665:         }
                   15666:     }
                   15667:     return @difference;
                   15668: }
                   15669: 
1.817     bisitz   15670: # -------------------------------------------------------- Initialize user login
1.462     albertel 15671: sub init_user_environment {
1.463     albertel 15672:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 15673:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   15674: 
                   15675:     my $public=($username eq 'public' && $domain eq 'public');
                   15676: 
                   15677: # See if old ID present, if so, remove
                   15678: 
1.1062    raeburn  15679:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 15680:     my $now=time;
                   15681: 
                   15682:     if ($public) {
                   15683: 	my $max_public=100;
                   15684: 	my $oldest;
                   15685: 	my $oldest_time=0;
                   15686: 	for(my $next=1;$next<=$max_public;$next++) {
                   15687: 	    if (-e $lonids."/publicuser_$next.id") {
                   15688: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   15689: 		if ($mtime<$oldest_time || !$oldest_time) {
                   15690: 		    $oldest_time=$mtime;
                   15691: 		    $oldest=$next;
                   15692: 		}
                   15693: 	    } else {
                   15694: 		$cookie="publicuser_$next";
                   15695: 		last;
                   15696: 	    }
                   15697: 	}
                   15698: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   15699:     } else {
1.463     albertel 15700: 	# if this isn't a robot, kill any existing non-robot sessions
                   15701: 	if (!$args->{'robot'}) {
                   15702: 	    opendir(DIR,$lonids);
                   15703: 	    while ($filename=readdir(DIR)) {
                   15704: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136  raeburn  15705:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   15706:                             &GDBM_READER(),0640)) {
                   15707:                         my $linkedfile;
                   15708:                         if (exists($oldenv{'user.linkedenv'})) {
                   15709:                             $linkedfile = $oldenv{'user.linkedenv'};
                   15710:                         }
                   15711:                         untie(%oldenv);
                   15712:                         if (unlink("$lonids/$filename")) {
                   15713:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   15714:                                 if (-l "$lonids/$linkedfile.id") {
                   15715:                                     unlink("$lonids/$linkedfile.id");
                   15716:                                 }
                   15717:                             }
                   15718:                         }
                   15719:                     } else {
                   15720:                         unlink($lonids.'/'.$filename);
                   15721:                     }
1.463     albertel 15722: 		}
1.462     albertel 15723: 	    }
1.463     albertel 15724: 	    closedir(DIR);
1.1075.2.84  raeburn  15725: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   15726:             my $namespace = 'nohist_courseeditor';
                   15727:             my $lockingkey = 'paste'."\0".'locked_num';
                   15728:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   15729:                                                 $domain,$username);
                   15730:             if (exists($lockhash{$lockingkey})) {
                   15731:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   15732:                 unless ($delresult eq 'ok') {
                   15733:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   15734:                 }
                   15735:             }
1.462     albertel 15736: 	}
                   15737: # Give them a new cookie
1.463     albertel 15738: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      15739: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 15740: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 15741:     
                   15742: # Initialize roles
                   15743: 
1.1062    raeburn  15744: 	($userroles,$firstaccenv,$timerintenv) = 
                   15745:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 15746:     }
                   15747: # ------------------------------------ Check browser type and MathML capability
                   15748: 
1.1075.2.77  raeburn  15749:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   15750:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 15751: 
                   15752: # ------------------------------------------------------------- Get environment
                   15753: 
                   15754:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   15755:     my ($tmp) = keys(%userenv);
                   15756:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   15757:     } else {
                   15758: 	undef(%userenv);
                   15759:     }
                   15760:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   15761: 	$form->{'interface'}=$userenv{'interface'};
                   15762:     }
                   15763:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   15764: 
                   15765: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   15766:     foreach my $option ('interface','localpath','localres') {
                   15767:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 15768:     }
                   15769: # --------------------------------------------------------- Write first profile
                   15770: 
                   15771:     {
                   15772: 	my %initial_env = 
                   15773: 	    ("user.name"          => $username,
                   15774: 	     "user.domain"        => $domain,
                   15775: 	     "user.home"          => $authhost,
                   15776: 	     "browser.type"       => $clientbrowser,
                   15777: 	     "browser.version"    => $clientversion,
                   15778: 	     "browser.mathml"     => $clientmathml,
                   15779: 	     "browser.unicode"    => $clientunicode,
                   15780: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  15781:              "browser.mobile"     => $clientmobile,
                   15782:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  15783:              "browser.osversion"  => $clientosversion,
1.462     albertel 15784: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   15785: 	     "request.course.fn"  => '',
                   15786: 	     "request.course.uri" => '',
                   15787: 	     "request.course.sec" => '',
                   15788: 	     "request.role"       => 'cm',
                   15789: 	     "request.role.adv"   => $env{'user.adv'},
                   15790: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   15791: 
                   15792:         if ($form->{'localpath'}) {
                   15793: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   15794: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   15795:         }
                   15796: 	
                   15797: 	if ($form->{'interface'}) {
                   15798: 	    $form->{'interface'}=~s/\W//gs;
                   15799: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   15800: 	    $env{'browser.interface'}=$form->{'interface'};
                   15801: 	}
                   15802: 
1.1075.2.54  raeburn  15803:         if ($form->{'iptoken'}) {
                   15804:             my $lonhost = $r->dir_config('lonHostID');
                   15805:             $initial_env{"user.noloadbalance"} = $lonhost;
                   15806:             $env{'user.noloadbalance'} = $lonhost;
                   15807:         }
                   15808: 
1.1075.2.120  raeburn  15809:         if ($form->{'noloadbalance'}) {
                   15810:             my @hosts = &Apache::lonnet::current_machine_ids();
                   15811:             my $hosthere = $form->{'noloadbalance'};
                   15812:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   15813:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   15814:                 $env{'user.noloadbalance'} = $hosthere;
                   15815:             }
                   15816:         }
                   15817: 
1.1016    raeburn  15818:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  15819:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   15820:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  15821: 
1.1075.2.125  raeburn  15822:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   15823:                 $userenv{'availabletools.'.$tool} = 
                   15824:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   15825:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   15826:             }
1.724     raeburn  15827: 
1.1075.2.125  raeburn  15828:             foreach my $crstype ('official','unofficial','community','textbook') {
                   15829:                 $userenv{'canrequest.'.$crstype} =
                   15830:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   15831:                                                       'reload','requestcourses',
                   15832:                                                       \%userenv,\%domdef,\%is_adv);
                   15833:             }
1.765     raeburn  15834: 
1.1075.2.125  raeburn  15835:             $userenv{'canrequest.author'} =
                   15836:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   15837:                                                   'reload','requestauthor',
                   15838:                                                   \%userenv,\%domdef,\%is_adv);
                   15839:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   15840:                                                  $domain,$username);
                   15841:             my $reqstatus = $reqauthor{'author_status'};
                   15842:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   15843:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   15844:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   15845:                                                       $reqauthor{'author'}{'timestamp'};
                   15846:                 }
1.1075.2.14  raeburn  15847:             }
                   15848:         }
                   15849: 
1.462     albertel 15850: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  15851: 
1.462     albertel 15852: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   15853: 		 &GDBM_WRCREAT(),0640)) {
                   15854: 	    &_add_to_env(\%disk_env,\%initial_env);
                   15855: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   15856: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  15857:             if (ref($firstaccenv) eq 'HASH') {
                   15858:                 &_add_to_env(\%disk_env,$firstaccenv);
                   15859:             }
                   15860:             if (ref($timerintenv) eq 'HASH') {
                   15861:                 &_add_to_env(\%disk_env,$timerintenv);
                   15862:             }
1.463     albertel 15863: 	    if (ref($args->{'extra_env'})) {
                   15864: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   15865: 	    }
1.462     albertel 15866: 	    untie(%disk_env);
                   15867: 	} else {
1.705     tempelho 15868: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   15869: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 15870: 	    return 'error: '.$!;
                   15871: 	}
                   15872:     }
                   15873:     $env{'request.role'}='cm';
                   15874:     $env{'request.role.adv'}=$env{'user.adv'};
                   15875:     $env{'browser.type'}=$clientbrowser;
                   15876: 
                   15877:     return $cookie;
                   15878: 
                   15879: }
                   15880: 
                   15881: sub _add_to_env {
                   15882:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  15883:     if (ref($env_data) eq 'HASH') {
                   15884:         while (my ($key,$value) = each(%$env_data)) {
                   15885: 	    $idf->{$prefix.$key} = $value;
                   15886: 	    $env{$prefix.$key}   = $value;
                   15887:         }
1.462     albertel 15888:     }
                   15889: }
                   15890: 
1.685     tempelho 15891: # --- Get the symbolic name of a problem and the url
                   15892: sub get_symb {
                   15893:     my ($request,$silent) = @_;
1.726     raeburn  15894:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 15895:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   15896:     if ($symb eq '') {
                   15897:         if (!$silent) {
1.1071    raeburn  15898:             if (ref($request)) { 
                   15899:                 $request->print("Unable to handle ambiguous references:$url:.");
                   15900:             }
1.685     tempelho 15901:             return ();
                   15902:         }
                   15903:     }
                   15904:     &Apache::lonenc::check_decrypt(\$symb);
                   15905:     return ($symb);
                   15906: }
                   15907: 
                   15908: # --------------------------------------------------------------Get annotation
                   15909: 
                   15910: sub get_annotation {
                   15911:     my ($symb,$enc) = @_;
                   15912: 
                   15913:     my $key = $symb;
                   15914:     if (!$enc) {
                   15915:         $key =
                   15916:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   15917:     }
                   15918:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   15919:     return $annotation{$key};
                   15920: }
                   15921: 
                   15922: sub clean_symb {
1.731     raeburn  15923:     my ($symb,$delete_enc) = @_;
1.685     tempelho 15924: 
                   15925:     &Apache::lonenc::check_decrypt(\$symb);
                   15926:     my $enc = $env{'request.enc'};
1.731     raeburn  15927:     if ($delete_enc) {
1.730     raeburn  15928:         delete($env{'request.enc'});
                   15929:     }
1.685     tempelho 15930: 
                   15931:     return ($symb,$enc);
                   15932: }
1.462     albertel 15933: 
1.1075.2.69  raeburn  15934: ############################################################
                   15935: ############################################################
                   15936: 
                   15937: =pod
                   15938: 
                   15939: =head1 Routines for building display used to search for courses
                   15940: 
                   15941: 
                   15942: =over 4
                   15943: 
                   15944: =item * &build_filters()
                   15945: 
                   15946: Create markup for a table used to set filters to use when selecting
                   15947: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   15948: and quotacheck.pl
                   15949: 
                   15950: 
                   15951: Inputs:
                   15952: 
                   15953: filterlist - anonymous array of fields to include as potential filters
                   15954: 
                   15955: crstype - course type
                   15956: 
                   15957: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   15958:               to pop-open a course selector (will contain "extra element").
                   15959: 
                   15960: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   15961: 
                   15962: filter - anonymous hash of criteria and their values
                   15963: 
                   15964: action - form action
                   15965: 
                   15966: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   15967: 
                   15968: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   15969: 
                   15970: cloneruname - username of owner of new course who wants to clone
                   15971: 
                   15972: clonerudom - domain of owner of new course who wants to clone
                   15973: 
                   15974: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   15975: 
                   15976: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   15977: 
                   15978: codedom - domain
                   15979: 
                   15980: formname - value of form element named "form".
                   15981: 
                   15982: fixeddom - domain, if fixed.
                   15983: 
                   15984: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   15985: 
                   15986: cnameelement - name of form element in form on opener page which will receive title of selected course
                   15987: 
                   15988: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   15989: 
                   15990: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   15991: 
                   15992: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   15993: 
                   15994: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   15995: 
                   15996: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   15997: 
                   15998: 
                   15999: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   16000: 
                   16001: 
                   16002: Side Effects: None
                   16003: 
                   16004: =cut
                   16005: 
                   16006: # ---------------------------------------------- search for courses based on last activity etc.
                   16007: 
                   16008: sub build_filters {
                   16009:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   16010:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   16011:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   16012:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   16013:         $clonetext,$clonewarning) = @_;
                   16014:     my ($list,$jscript);
                   16015:     my $onchange = 'javascript:updateFilters(this)';
                   16016:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   16017:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   16018:         $typeselectform,$instcodetitle);
                   16019:     if ($formname eq '') {
                   16020:         $formname = $caller;
                   16021:     }
                   16022:     foreach my $item (@{$filterlist}) {
                   16023:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   16024:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   16025:             if ($item eq 'domainfilter') {
                   16026:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   16027:             } elsif ($item eq 'coursefilter') {
                   16028:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   16029:             } elsif ($item eq 'ownerfilter') {
                   16030:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16031:             } elsif ($item eq 'ownerdomfilter') {
                   16032:                 $filter->{'ownerdomfilter'} =
                   16033:                     &LONCAPA::clean_domain($filter->{$item});
                   16034:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   16035:                                                        'ownerdomfilter',1);
                   16036:             } elsif ($item eq 'personfilter') {
                   16037:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16038:             } elsif ($item eq 'persondomfilter') {
                   16039:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   16040:                                                         'persondomfilter',1);
                   16041:             } else {
                   16042:                 $filter->{$item} =~ s/\W//g;
                   16043:             }
                   16044:             if (!$filter->{$item}) {
                   16045:                 $filter->{$item} = '';
                   16046:             }
                   16047:         }
                   16048:         if ($item eq 'domainfilter') {
                   16049:             my $allow_blank = 1;
                   16050:             if ($formname eq 'portform') {
                   16051:                 $allow_blank=0;
                   16052:             } elsif ($formname eq 'studentform') {
                   16053:                 $allow_blank=0;
                   16054:             }
                   16055:             if ($fixeddom) {
                   16056:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   16057:                                     ' value="'.$codedom.'" />'.
                   16058:                                     &Apache::lonnet::domain($codedom,'description');
                   16059:             } else {
                   16060:                 $domainselectform = &select_dom_form($filter->{$item},
                   16061:                                                      'domainfilter',
                   16062:                                                       $allow_blank,'',$onchange);
                   16063:             }
                   16064:         } else {
                   16065:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   16066:         }
                   16067:     }
                   16068: 
                   16069:     # last course activity filter and selection
                   16070:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   16071: 
                   16072:     # course created filter and selection
                   16073:     if (exists($filter->{'createdfilter'})) {
                   16074:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   16075:     }
                   16076: 
                   16077:     my %lt = &Apache::lonlocal::texthash(
                   16078:                 'cac' => "$crstype Activity",
                   16079:                 'ccr' => "$crstype Created",
                   16080:                 'cde' => "$crstype Title",
                   16081:                 'cdo' => "$crstype Domain",
                   16082:                 'ins' => 'Institutional Code',
                   16083:                 'inc' => 'Institutional Categorization',
                   16084:                 'cow' => "$crstype Owner/Co-owner",
                   16085:                 'cop' => "$crstype Personnel Includes",
                   16086:                 'cog' => 'Type',
                   16087:              );
                   16088: 
                   16089:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16090:         my $typeval = 'Course';
                   16091:         if ($crstype eq 'Community') {
                   16092:             $typeval = 'Community';
                   16093:         }
                   16094:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   16095:     } else {
                   16096:         $typeselectform =  '<select name="type" size="1"';
                   16097:         if ($onchange) {
                   16098:             $typeselectform .= ' onchange="'.$onchange.'"';
                   16099:         }
                   16100:         $typeselectform .= '>'."\n";
                   16101:         foreach my $posstype ('Course','Community') {
                   16102:             $typeselectform.='<option value="'.$posstype.'"'.
                   16103:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   16104:         }
                   16105:         $typeselectform.="</select>";
                   16106:     }
                   16107: 
                   16108:     my ($cloneableonlyform,$cloneabletitle);
                   16109:     if (exists($filter->{'cloneableonly'})) {
                   16110:         my $cloneableon = '';
                   16111:         my $cloneableoff = ' checked="checked"';
                   16112:         if ($filter->{'cloneableonly'}) {
                   16113:             $cloneableon = $cloneableoff;
                   16114:             $cloneableoff = '';
                   16115:         }
                   16116:         $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>';
                   16117:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  16118:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  16119:         } else {
                   16120:             $cloneabletitle = &mt('Cloneable by you');
                   16121:         }
                   16122:     }
                   16123:     my $officialjs;
                   16124:     if ($crstype eq 'Course') {
                   16125:         if (exists($filter->{'instcodefilter'})) {
                   16126: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   16127: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   16128:             if ($codedom) {
                   16129:                 $officialjs = 1;
                   16130:                 ($instcodeform,$jscript,$$numtitlesref) =
                   16131:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   16132:                                                                   $officialjs,$codetitlesref);
                   16133:                 if ($jscript) {
                   16134:                     $jscript = '<script type="text/javascript">'."\n".
                   16135:                                '// <![CDATA['."\n".
                   16136:                                $jscript."\n".
                   16137:                                '// ]]>'."\n".
                   16138:                                '</script>'."\n";
                   16139:                 }
                   16140:             }
                   16141:             if ($instcodeform eq '') {
                   16142:                 $instcodeform =
                   16143:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   16144:                     $list->{'instcodefilter'}.'" />';
                   16145:                 $instcodetitle = $lt{'ins'};
                   16146:             } else {
                   16147:                 $instcodetitle = $lt{'inc'};
                   16148:             }
                   16149:             if ($fixeddom) {
                   16150:                 $instcodetitle .= '<br />('.$codedom.')';
                   16151:             }
                   16152:         }
                   16153:     }
                   16154:     my $output = qq|
                   16155: <form method="post" name="filterpicker" action="$action">
                   16156: <input type="hidden" name="form" value="$formname" />
                   16157: |;
                   16158:     if ($formname eq 'modifycourse') {
                   16159:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   16160:                    '<input type="hidden" name="prevphase" value="'.
                   16161:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  16162:     } elsif ($formname eq 'quotacheck') {
                   16163:         $output .= qq|
                   16164: <input type="hidden" name="sortby" value="" />
                   16165: <input type="hidden" name="sortorder" value="" />
                   16166: |;
                   16167:     } else {
1.1075.2.69  raeburn  16168:         my $name_input;
                   16169:         if ($cnameelement ne '') {
                   16170:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   16171:                           $cnameelement.'" />';
                   16172:         }
                   16173:         $output .= qq|
                   16174: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   16175: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   16176: $name_input
                   16177: $roleelement
                   16178: $multelement
                   16179: $typeelement
                   16180: |;
                   16181:         if ($formname eq 'portform') {
                   16182:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   16183:         }
                   16184:     }
                   16185:     if ($fixeddom) {
                   16186:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   16187:     }
                   16188:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   16189:     if ($sincefilterform) {
                   16190:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   16191:                   .$sincefilterform
                   16192:                   .&Apache::lonhtmlcommon::row_closure();
                   16193:     }
                   16194:     if ($createdfilterform) {
                   16195:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   16196:                   .$createdfilterform
                   16197:                   .&Apache::lonhtmlcommon::row_closure();
                   16198:     }
                   16199:     if ($domainselectform) {
                   16200:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   16201:                   .$domainselectform
                   16202:                   .&Apache::lonhtmlcommon::row_closure();
                   16203:     }
                   16204:     if ($typeselectform) {
                   16205:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16206:             $output .= $typeselectform;
                   16207:         } else {
                   16208:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   16209:                       .$typeselectform
                   16210:                       .&Apache::lonhtmlcommon::row_closure();
                   16211:         }
                   16212:     }
                   16213:     if ($instcodeform) {
                   16214:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   16215:                   .$instcodeform
                   16216:                   .&Apache::lonhtmlcommon::row_closure();
                   16217:     }
                   16218:     if (exists($filter->{'ownerfilter'})) {
                   16219:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   16220:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16221:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   16222:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16223:                    $ownerdomselectform.'</td></tr></table>'.
                   16224:                    &Apache::lonhtmlcommon::row_closure();
                   16225:     }
                   16226:     if (exists($filter->{'personfilter'})) {
                   16227:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   16228:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16229:                    '<input type="text" name="personfilter" size="20" value="'.
                   16230:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16231:                    $persondomselectform.'</td></tr></table>'.
                   16232:                    &Apache::lonhtmlcommon::row_closure();
                   16233:     }
                   16234:     if (exists($filter->{'coursefilter'})) {
                   16235:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   16236:                   .'<input type="text" name="coursefilter" size="25" value="'
                   16237:                   .$list->{'coursefilter'}.'" />'
                   16238:                   .&Apache::lonhtmlcommon::row_closure();
                   16239:     }
                   16240:     if ($cloneableonlyform) {
                   16241:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   16242:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   16243:     }
                   16244:     if (exists($filter->{'descriptfilter'})) {
                   16245:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   16246:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   16247:                   .$list->{'descriptfilter'}.'" />'
                   16248:                   .&Apache::lonhtmlcommon::row_closure(1);
                   16249:     }
                   16250:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   16251:                '<input type="hidden" name="updater" value="" />'."\n".
                   16252:                '<input type="submit" name="gosearch" value="'.
                   16253:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   16254:     return $jscript.$clonewarning.$output;
                   16255: }
                   16256: 
                   16257: =pod
                   16258: 
                   16259: =item * &timebased_select_form()
                   16260: 
                   16261: Create markup for a dropdown list used to select a time-based
                   16262: filter e.g., Course Activity, Course Created, when searching for courses
                   16263: or communities
                   16264: 
                   16265: Inputs:
                   16266: 
                   16267: item - name of form element (sincefilter or createdfilter)
                   16268: 
                   16269: filter - anonymous hash of criteria and their values
                   16270: 
                   16271: Returns: HTML for a select box contained a blank, then six time selections,
                   16272:          with value set in incoming form variables currently selected.
                   16273: 
                   16274: Side Effects: None
                   16275: 
                   16276: =cut
                   16277: 
                   16278: sub timebased_select_form {
                   16279:     my ($item,$filter) = @_;
                   16280:     if (ref($filter) eq 'HASH') {
                   16281:         $filter->{$item} =~ s/[^\d-]//g;
                   16282:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   16283:         return &select_form(
                   16284:                             $filter->{$item},
                   16285:                             $item,
                   16286:                             {      '-1' => '',
                   16287:                                 '86400' => &mt('today'),
                   16288:                                '604800' => &mt('last week'),
                   16289:                               '2592000' => &mt('last month'),
                   16290:                               '7776000' => &mt('last three months'),
                   16291:                              '15552000' => &mt('last six months'),
                   16292:                              '31104000' => &mt('last year'),
                   16293:                     'select_form_order' =>
                   16294:                            ['-1','86400','604800','2592000','7776000',
                   16295:                             '15552000','31104000']});
                   16296:     }
                   16297: }
                   16298: 
                   16299: =pod
                   16300: 
                   16301: =item * &js_changer()
                   16302: 
                   16303: Create script tag containing Javascript used to submit course search form
                   16304: when course type or domain is changed, and also to hide 'Searching ...' on
                   16305: page load completion for page showing search result.
                   16306: 
                   16307: Inputs: None
                   16308: 
                   16309: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   16310: 
                   16311: Side Effects: None
                   16312: 
                   16313: =cut
                   16314: 
                   16315: sub js_changer {
                   16316:     return <<ENDJS;
                   16317: <script type="text/javascript">
                   16318: // <![CDATA[
                   16319: function updateFilters(caller) {
                   16320:     if (typeof(caller) != "undefined") {
                   16321:         document.filterpicker.updater.value = caller.name;
                   16322:     }
                   16323:     document.filterpicker.submit();
                   16324: }
                   16325: 
                   16326: function hideSearching() {
                   16327:     if (document.getElementById('searching')) {
                   16328:         document.getElementById('searching').style.display = 'none';
                   16329:     }
                   16330:     return;
                   16331: }
                   16332: 
                   16333: // ]]>
                   16334: </script>
                   16335: 
                   16336: ENDJS
                   16337: }
                   16338: 
                   16339: =pod
                   16340: 
                   16341: =item * &search_courses()
                   16342: 
                   16343: Process selected filters form course search form and pass to lonnet::courseiddump
                   16344: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   16345: 
                   16346: Inputs:
                   16347: 
                   16348: dom - domain being searched
                   16349: 
                   16350: type - course type ('Course' or 'Community' or '.' if any).
                   16351: 
                   16352: filter - anonymous hash of criteria and their values
                   16353: 
                   16354: numtitles - for institutional codes - number of categories
                   16355: 
                   16356: cloneruname - optional username of new course owner
                   16357: 
                   16358: clonerudom - optional domain of new course owner
                   16359: 
1.1075.2.95  raeburn  16360: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  16361:             (used when DC is using course creation form)
                   16362: 
                   16363: codetitles - reference to array of titles of components in institutional codes (official courses).
                   16364: 
1.1075.2.95  raeburn  16365: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   16366:            (and so can clone automatically)
                   16367: 
                   16368: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   16369: 
                   16370: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   16371:               courses to clone
1.1075.2.69  raeburn  16372: 
                   16373: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   16374: 
                   16375: 
                   16376: Side Effects: None
                   16377: 
                   16378: =cut
                   16379: 
                   16380: 
                   16381: sub search_courses {
1.1075.2.95  raeburn  16382:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   16383:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  16384:     my (%courses,%showcourses,$cloner);
                   16385:     if (($filter->{'ownerfilter'} ne '') ||
                   16386:         ($filter->{'ownerdomfilter'} ne '')) {
                   16387:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   16388:                                        $filter->{'ownerdomfilter'};
                   16389:     }
                   16390:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   16391:         if (!$filter->{$item}) {
                   16392:             $filter->{$item}='.';
                   16393:         }
                   16394:     }
                   16395:     my $now = time;
                   16396:     my $timefilter =
                   16397:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   16398:     my ($createdbefore,$createdafter);
                   16399:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   16400:         $createdbefore = $now;
                   16401:         $createdafter = $now-$filter->{'createdfilter'};
                   16402:     }
                   16403:     my ($instcodefilter,$regexpok);
                   16404:     if ($numtitles) {
                   16405:         if ($env{'form.official'} eq 'on') {
                   16406:             $instcodefilter =
                   16407:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16408:             $regexpok = 1;
                   16409:         } elsif ($env{'form.official'} eq 'off') {
                   16410:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16411:             unless ($instcodefilter eq '') {
                   16412:                 $regexpok = -1;
                   16413:             }
                   16414:         }
                   16415:     } else {
                   16416:         $instcodefilter = $filter->{'instcodefilter'};
                   16417:     }
                   16418:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   16419:     if ($type eq '') { $type = '.'; }
                   16420: 
                   16421:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   16422:         $cloner = $cloneruname.':'.$clonerudom;
                   16423:     }
                   16424:     %courses = &Apache::lonnet::courseiddump($dom,
                   16425:                                              $filter->{'descriptfilter'},
                   16426:                                              $timefilter,
                   16427:                                              $instcodefilter,
                   16428:                                              $filter->{'combownerfilter'},
                   16429:                                              $filter->{'coursefilter'},
                   16430:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  16431:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  16432:                                              $filter->{'cloneableonly'},
                   16433:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  16434:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  16435:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   16436:         my $ccrole;
                   16437:         if ($type eq 'Community') {
                   16438:             $ccrole = 'co';
                   16439:         } else {
                   16440:             $ccrole = 'cc';
                   16441:         }
                   16442:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   16443:                                                      $filter->{'persondomfilter'},
                   16444:                                                      'userroles',undef,
                   16445:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   16446:                                                      $dom);
                   16447:         foreach my $role (keys(%rolehash)) {
                   16448:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   16449:             my $cid = $cdom.'_'.$cnum;
                   16450:             if (exists($courses{$cid})) {
                   16451:                 if (ref($courses{$cid}) eq 'HASH') {
                   16452:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   16453:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  16454:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  16455:                         }
                   16456:                     } else {
                   16457:                         $courses{$cid}{roles} = [$courserole];
                   16458:                     }
                   16459:                     $showcourses{$cid} = $courses{$cid};
                   16460:                 }
                   16461:             }
                   16462:         }
                   16463:         %courses = %showcourses;
                   16464:     }
                   16465:     return %courses;
                   16466: }
                   16467: 
                   16468: =pod
                   16469: 
                   16470: =back
                   16471: 
1.1075.2.88  raeburn  16472: =head1 Routines for version requirements for current course.
                   16473: 
                   16474: =over 4
                   16475: 
                   16476: =item * &check_release_required()
                   16477: 
                   16478: Compares required LON-CAPA version with version on server, and
                   16479: if required version is newer looks for a server with the required version.
                   16480: 
                   16481: Looks first at servers in user's owen domain; if none suitable, looks at
                   16482: servers in course's domain are permitted to host sessions for user's domain.
                   16483: 
                   16484: Inputs:
                   16485: 
                   16486: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16487: 
                   16488: $courseid - Course ID of current course
                   16489: 
                   16490: $rolecode - User's current role in course (for switchserver query string).
                   16491: 
                   16492: $required - LON-CAPA version needed by course (format: Major.Minor).
                   16493: 
                   16494: 
                   16495: Returns:
                   16496: 
                   16497: $switchserver - query string tp append to /adm/switchserver call (if
                   16498:                 current server's LON-CAPA version is too old.
                   16499: 
                   16500: $warning - Message is displayed if no suitable server could be found.
                   16501: 
                   16502: =cut
                   16503: 
                   16504: sub check_release_required {
                   16505:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   16506:     my ($switchserver,$warning);
                   16507:     if ($required ne '') {
                   16508:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   16509:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16510:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   16511:             my $otherserver;
                   16512:             if (($major eq '' && $minor eq '') ||
                   16513:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   16514:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   16515:                 my $switchlcrev =
                   16516:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   16517:                                                            $userdomserver);
                   16518:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16519:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   16520:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   16521:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   16522:                     if ($cdom ne $env{'user.domain'}) {
                   16523:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   16524:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   16525:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   16526:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   16527:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   16528:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   16529:                         my $canhost =
                   16530:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   16531:                                                               $coursedomserver,
                   16532:                                                               $remoterev,
                   16533:                                                               $udomdefaults{'remotesessions'},
                   16534:                                                               $defdomdefaults{'hostedsessions'});
                   16535: 
                   16536:                         if ($canhost) {
                   16537:                             $otherserver = $coursedomserver;
                   16538:                         } else {
                   16539:                             $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.");
                   16540:                         }
                   16541:                     } else {
                   16542:                         $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).");
                   16543:                     }
                   16544:                 } else {
                   16545:                     $otherserver = $userdomserver;
                   16546:                 }
                   16547:             }
                   16548:             if ($otherserver ne '') {
                   16549:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   16550:             }
                   16551:         }
                   16552:     }
                   16553:     return ($switchserver,$warning);
                   16554: }
                   16555: 
                   16556: =pod
                   16557: 
                   16558: =item * &check_release_result()
                   16559: 
                   16560: Inputs:
                   16561: 
                   16562: $switchwarning - Warning message if no suitable server found to host session.
                   16563: 
                   16564: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16565:                 and current role.
                   16566: 
                   16567: Returns: HTML to display with information about requirement to switch server.
                   16568:          Either displaying warning with link to Roles/Courses screen or
                   16569:          display link to switchserver.
                   16570: 
1.1075.2.69  raeburn  16571: =cut
                   16572: 
1.1075.2.88  raeburn  16573: sub check_release_result {
                   16574:     my ($switchwarning,$switchserver) = @_;
                   16575:     my $output = &start_page('Selected course unavailable on this server').
                   16576:                  '<p class="LC_warning">';
                   16577:     if ($switchwarning) {
                   16578:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   16579:         if (&show_course()) {
                   16580:             $output .= &mt('Display courses');
                   16581:         } else {
                   16582:             $output .= &mt('Display roles');
                   16583:         }
                   16584:         $output .= '</a>';
                   16585:     } elsif ($switchserver) {
                   16586:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   16587:                    '<br />'.
                   16588:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   16589:                    &mt('Switch Server').
                   16590:                    '</a>';
                   16591:     }
                   16592:     $output .= '</p>'.&end_page();
                   16593:     return $output;
                   16594: }
                   16595: 
                   16596: =pod
                   16597: 
                   16598: =item * &needs_coursereinit()
                   16599: 
                   16600: Determine if course contents stored for user's session needs to be
                   16601: refreshed, because content has changed since "Big Hash" last tied.
                   16602: 
                   16603: Check for change is made if time last checked is more than 10 minutes ago
                   16604: (by default).
                   16605: 
                   16606: Inputs:
                   16607: 
                   16608: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16609: 
                   16610: $interval (optional) - Time which may elapse (in s) between last check for content
                   16611:                        change in current course. (default: 600 s).
                   16612: 
                   16613: Returns: an array; first element is:
                   16614: 
                   16615: =over 4
                   16616: 
                   16617: 'switch' - if content updates mean user's session
                   16618:            needs to be switched to a server running a newer LON-CAPA version
                   16619: 
                   16620: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   16621:            on current server hosting user's session
                   16622: 
                   16623: ''       - if no action required.
                   16624: 
                   16625: =back
                   16626: 
                   16627: If first item element is 'switch':
                   16628: 
                   16629: second item is $switchwarning - Warning message if no suitable server found to host session.
                   16630: 
                   16631: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16632:                               and current role.
                   16633: 
                   16634: otherwise: no other elements returned.
                   16635: 
                   16636: =back
                   16637: 
                   16638: =cut
                   16639: 
                   16640: sub needs_coursereinit {
                   16641:     my ($loncaparev,$interval) = @_;
                   16642:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   16643:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   16644:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   16645:     my $now = time;
                   16646:     if ($interval eq '') {
                   16647:         $interval = 600;
                   16648:     }
                   16649:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   16650:         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   16651:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
                   16652:         if ($lastchange > $env{'request.course.tied'}) {
                   16653:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   16654:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   16655:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   16656:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   16657:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   16658:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   16659:                     my ($switchserver,$switchwarning) =
                   16660:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   16661:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   16662:                     if ($switchwarning ne '' || $switchserver ne '') {
                   16663:                         return ('switch',$switchwarning,$switchserver);
                   16664:                     }
                   16665:                 }
                   16666:             }
                   16667:             return ('update');
                   16668:         }
                   16669:     }
                   16670:     return ();
                   16671: }
1.1075.2.69  raeburn  16672: 
1.1075.2.11  raeburn  16673: sub update_content_constraints {
                   16674:     my ($cdom,$cnum,$chome,$cid) = @_;
                   16675:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   16676:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   16677:     my %checkresponsetypes;
                   16678:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   16679:         my ($item,$name,$value) = split(/:/,$key);
                   16680:         if ($item eq 'resourcetag') {
                   16681:             if ($name eq 'responsetype') {
                   16682:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   16683:             }
                   16684:         }
                   16685:     }
                   16686:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16687:     if (defined($navmap)) {
                   16688:         my %allresponses;
                   16689:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   16690:             my %responses = $res->responseTypes();
                   16691:             foreach my $key (keys(%responses)) {
                   16692:                 next unless(exists($checkresponsetypes{$key}));
                   16693:                 $allresponses{$key} += $responses{$key};
                   16694:             }
                   16695:         }
                   16696:         foreach my $key (keys(%allresponses)) {
                   16697:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   16698:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   16699:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   16700:             }
                   16701:         }
                   16702:         undef($navmap);
                   16703:     }
                   16704:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   16705:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   16706:     }
                   16707:     return;
                   16708: }
                   16709: 
1.1075.2.27  raeburn  16710: sub allmaps_incourse {
                   16711:     my ($cdom,$cnum,$chome,$cid) = @_;
                   16712:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   16713:         $cid = $env{'request.course.id'};
                   16714:         $cdom = $env{'course.'.$cid.'.domain'};
                   16715:         $cnum = $env{'course.'.$cid.'.num'};
                   16716:         $chome = $env{'course.'.$cid.'.home'};
                   16717:     }
                   16718:     my %allmaps = ();
                   16719:     my $lastchange =
                   16720:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   16721:     if ($lastchange > $env{'request.course.tied'}) {
                   16722:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   16723:         unless ($ferr) {
                   16724:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   16725:         }
                   16726:     }
                   16727:     my $navmap = Apache::lonnavmaps::navmap->new();
                   16728:     if (defined($navmap)) {
                   16729:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   16730:             $allmaps{$res->src()} = 1;
                   16731:         }
                   16732:     }
                   16733:     return \%allmaps;
                   16734: }
                   16735: 
1.1075.2.11  raeburn  16736: sub parse_supplemental_title {
                   16737:     my ($title) = @_;
                   16738: 
                   16739:     my ($foldertitle,$renametitle);
                   16740:     if ($title =~ /&amp;&amp;&amp;/) {
                   16741:         $title = &HTML::Entites::decode($title);
                   16742:     }
                   16743:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   16744:         $renametitle=$4;
                   16745:         my ($time,$uname,$udom) = ($1,$2,$3);
                   16746:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   16747:         my $name =  &plainname($uname,$udom);
                   16748:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   16749:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   16750:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   16751:             $name.': <br />'.$foldertitle;
                   16752:     }
                   16753:     if (wantarray) {
                   16754:         return ($title,$foldertitle,$renametitle);
                   16755:     }
                   16756:     return $title;
                   16757: }
                   16758: 
1.1075.2.43  raeburn  16759: sub recurse_supplemental {
                   16760:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   16761:     if ($suppmap) {
                   16762:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   16763:         if ($fatal) {
                   16764:             $errors ++;
                   16765:         } else {
                   16766:             if ($#LONCAPA::map::resources > 0) {
                   16767:                 foreach my $res (@LONCAPA::map::resources) {
                   16768:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$res);
                   16769:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  16770:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   16771:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  16772:                         } else {
                   16773:                             $numfiles ++;
                   16774:                         }
                   16775:                     }
                   16776:                 }
                   16777:             }
                   16778:         }
                   16779:     }
                   16780:     return ($numfiles,$errors);
                   16781: }
                   16782: 
1.1075.2.18  raeburn  16783: sub symb_to_docspath {
1.1075.2.119  raeburn  16784:     my ($symb,$navmapref) = @_;
                   16785:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  16786:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   16787:     if ($resurl=~/\.(sequence|page)$/) {
                   16788:         $mapurl=$resurl;
                   16789:     } elsif ($resurl eq 'adm/navmaps') {
                   16790:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   16791:     }
                   16792:     my $mapresobj;
1.1075.2.119  raeburn  16793:     unless (ref($$navmapref)) {
                   16794:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   16795:     }
                   16796:     if (ref($$navmapref)) {
                   16797:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  16798:     }
                   16799:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   16800:     my $type=$2;
                   16801:     my $path;
                   16802:     if (ref($mapresobj)) {
                   16803:         my $pcslist = $mapresobj->map_hierarchy();
                   16804:         if ($pcslist ne '') {
                   16805:             foreach my $pc (split(/,/,$pcslist)) {
                   16806:                 next if ($pc <= 1);
1.1075.2.119  raeburn  16807:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  16808:                 if (ref($res)) {
                   16809:                     my $thisurl = $res->src();
                   16810:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   16811:                     my $thistitle = $res->title();
                   16812:                     $path .= '&'.
                   16813:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  16814:                              &escape($thistitle).
1.1075.2.18  raeburn  16815:                              ':'.$res->randompick().
                   16816:                              ':'.$res->randomout().
                   16817:                              ':'.$res->encrypted().
                   16818:                              ':'.$res->randomorder().
                   16819:                              ':'.$res->is_page();
                   16820:                 }
                   16821:             }
                   16822:         }
                   16823:         $path =~ s/^\&//;
                   16824:         my $maptitle = $mapresobj->title();
                   16825:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  16826:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  16827:         }
                   16828:         $path .= (($path ne '')? '&' : '').
                   16829:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  16830:                  &escape($maptitle).
1.1075.2.18  raeburn  16831:                  ':'.$mapresobj->randompick().
                   16832:                  ':'.$mapresobj->randomout().
                   16833:                  ':'.$mapresobj->encrypted().
                   16834:                  ':'.$mapresobj->randomorder().
                   16835:                  ':'.$mapresobj->is_page();
                   16836:     } else {
                   16837:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   16838:         my $ispage = (($type eq 'page')? 1 : '');
                   16839:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  16840:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  16841:         }
                   16842:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  16843:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  16844:     }
                   16845:     unless ($mapurl eq 'default') {
                   16846:         $path = 'default&'.
1.1075.2.46  raeburn  16847:                 &escape('Main Content').
1.1075.2.18  raeburn  16848:                 ':::::&'.$path;
                   16849:     }
                   16850:     return $path;
                   16851: }
                   16852: 
1.1075.2.14  raeburn  16853: sub captcha_display {
1.1075.2.137  raeburn  16854:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  16855:     my ($output,$error);
1.1075.2.107  raeburn  16856:     my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137  raeburn  16857:         &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  16858:     if ($captcha eq 'original') {
                   16859:         $output = &create_captcha();
                   16860:         unless ($output) {
                   16861:             $error = 'captcha';
                   16862:         }
                   16863:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  16864:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  16865:         unless ($output) {
                   16866:             $error = 'recaptcha';
                   16867:         }
                   16868:     }
1.1075.2.107  raeburn  16869:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  16870: }
                   16871: 
                   16872: sub captcha_response {
1.1075.2.137  raeburn  16873:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  16874:     my ($captcha_chk,$captcha_error);
1.1075.2.137  raeburn  16875:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  16876:     if ($captcha eq 'original') {
                   16877:         ($captcha_chk,$captcha_error) = &check_captcha();
                   16878:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  16879:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  16880:     } else {
                   16881:         $captcha_chk = 1;
                   16882:     }
                   16883:     return ($captcha_chk,$captcha_error);
                   16884: }
                   16885: 
                   16886: sub get_captcha_config {
1.1075.2.137  raeburn  16887:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107  raeburn  16888:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  16889:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   16890:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   16891:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   16892:     if ($context eq 'usercreation') {
                   16893:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   16894:         if (ref($domconfig{$context}) eq 'HASH') {
                   16895:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   16896:             if (ref($hashtocheck) eq 'HASH') {
                   16897:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   16898:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   16899:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   16900:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   16901:                     }
                   16902:                     if ($privkey && $pubkey) {
                   16903:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  16904:                         $version = $hashtocheck->{'recaptchaversion'};
                   16905:                         if ($version ne '2') {
                   16906:                             $version = 1;
                   16907:                         }
1.1075.2.14  raeburn  16908:                     } else {
                   16909:                         $captcha = 'original';
                   16910:                     }
                   16911:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   16912:                     $captcha = 'original';
                   16913:                 }
                   16914:             }
                   16915:         } else {
                   16916:             $captcha = 'captcha';
                   16917:         }
                   16918:     } elsif ($context eq 'login') {
                   16919:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   16920:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   16921:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   16922:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   16923:             if ($privkey && $pubkey) {
                   16924:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  16925:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   16926:                 if ($version ne '2') {
                   16927:                     $version = 1;
                   16928:                 }
1.1075.2.14  raeburn  16929:             } else {
                   16930:                 $captcha = 'original';
                   16931:             }
                   16932:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   16933:             $captcha = 'original';
                   16934:         }
1.1075.2.137  raeburn  16935:     } elsif ($context eq 'passwords') {
                   16936:         if ($dom_in_effect) {
                   16937:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   16938:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   16939:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   16940:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   16941:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   16942:                 }
                   16943:                 if ($privkey && $pubkey) {
                   16944:                     $captcha = 'recaptcha';
                   16945:                     $version = $passwdconf{'recaptchaversion'};
                   16946:                     if ($version ne '2') {
                   16947:                         $version = 1;
                   16948:                     }
                   16949:                 } else {
                   16950:                     $captcha = 'original';
                   16951:                 }
                   16952:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   16953:                 $captcha = 'original';
                   16954:             }
                   16955:         }
1.1075.2.14  raeburn  16956:     }
1.1075.2.107  raeburn  16957:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  16958: }
                   16959: 
                   16960: sub create_captcha {
                   16961:     my %captcha_params = &captcha_settings();
                   16962:     my ($output,$maxtries,$tries) = ('',10,0);
                   16963:     while ($tries < $maxtries) {
                   16964:         $tries ++;
                   16965:         my $captcha = Authen::Captcha->new (
                   16966:                                            output_folder => $captcha_params{'output_dir'},
                   16967:                                            data_folder   => $captcha_params{'db_dir'},
                   16968:                                           );
                   16969:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   16970: 
                   16971:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   16972:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
                   16973:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.66  raeburn  16974:                       '<input type="text" size="5" name="code" value="" autocomplete="off" />'.
                   16975:                       '<br />'.
                   16976:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  16977:             last;
                   16978:         }
                   16979:     }
                   16980:     return $output;
                   16981: }
                   16982: 
                   16983: sub captcha_settings {
                   16984:     my %captcha_params = (
                   16985:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   16986:                            www_output_dir => "/captchaspool",
                   16987:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   16988:                            numchars       => '5',
                   16989:                          );
                   16990:     return %captcha_params;
                   16991: }
                   16992: 
                   16993: sub check_captcha {
                   16994:     my ($captcha_chk,$captcha_error);
                   16995:     my $code = $env{'form.code'};
                   16996:     my $md5sum = $env{'form.crypt'};
                   16997:     my %captcha_params = &captcha_settings();
                   16998:     my $captcha = Authen::Captcha->new(
                   16999:                       output_folder => $captcha_params{'output_dir'},
                   17000:                       data_folder   => $captcha_params{'db_dir'},
                   17001:                   );
1.1075.2.26  raeburn  17002:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  17003:     my %captcha_hash = (
                   17004:                         0       => 'Code not checked (file error)',
                   17005:                        -1      => 'Failed: code expired',
                   17006:                        -2      => 'Failed: invalid code (not in database)',
                   17007:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   17008:     );
                   17009:     if ($captcha_chk != 1) {
                   17010:         $captcha_error = $captcha_hash{$captcha_chk}
                   17011:     }
                   17012:     return ($captcha_chk,$captcha_error);
                   17013: }
                   17014: 
                   17015: sub create_recaptcha {
1.1075.2.107  raeburn  17016:     my ($pubkey,$version) = @_;
                   17017:     if ($version >= 2) {
                   17018:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>';
                   17019:     } else {
                   17020:         my $use_ssl;
                   17021:         if ($ENV{'SERVER_PORT'} == 443) {
                   17022:             $use_ssl = 1;
                   17023:         }
                   17024:         my $captcha = Captcha::reCAPTCHA->new;
                   17025:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   17026:                $captcha->get_html($pubkey,undef,$use_ssl).
                   17027:                &mt('If the text is hard to read, [_1] will replace them.',
                   17028:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   17029:                '<br /><br />';
                   17030:      }
1.1075.2.14  raeburn  17031: }
                   17032: 
                   17033: sub check_recaptcha {
1.1075.2.107  raeburn  17034:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  17035:     my $captcha_chk;
1.1075.2.107  raeburn  17036:     if ($version >= 2) {
                   17037:         my $ua = LWP::UserAgent->new;
                   17038:         $ua->timeout(10);
                   17039:         my %info = (
                   17040:                      secret   => $privkey,
                   17041:                      response => $env{'form.g-recaptcha-response'},
                   17042:                      remoteip => $ENV{'REMOTE_ADDR'},
                   17043:                    );
                   17044:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   17045:         if ($response->is_success)  {
                   17046:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   17047:             if (ref($data) eq 'HASH') {
                   17048:                 if ($data->{'success'}) {
                   17049:                     $captcha_chk = 1;
                   17050:                 }
                   17051:             }
                   17052:         }
                   17053:     } else {
                   17054:         my $captcha = Captcha::reCAPTCHA->new;
                   17055:         my $captcha_result =
                   17056:             $captcha->check_answer(
                   17057:                                     $privkey,
                   17058:                                     $ENV{'REMOTE_ADDR'},
                   17059:                                     $env{'form.recaptcha_challenge_field'},
                   17060:                                     $env{'form.recaptcha_response_field'},
                   17061:                                   );
                   17062:         if ($captcha_result->{is_valid}) {
                   17063:             $captcha_chk = 1;
                   17064:         }
1.1075.2.14  raeburn  17065:     }
                   17066:     return $captcha_chk;
                   17067: }
                   17068: 
1.1075.2.64  raeburn  17069: sub emailusername_info {
1.1075.2.103  raeburn  17070:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  17071:     my %titles = &Apache::lonlocal::texthash (
                   17072:                      lastname      => 'Last Name',
                   17073:                      firstname     => 'First Name',
                   17074:                      institution   => 'School/college/university',
                   17075:                      location      => "School's city, state/province, country",
                   17076:                      web           => "School's web address",
                   17077:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  17078:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  17079:                  );
                   17080:     return (\@fields,\%titles);
                   17081: }
                   17082: 
1.1075.2.56  raeburn  17083: sub cleanup_html {
                   17084:     my ($incoming) = @_;
                   17085:     my $outgoing;
                   17086:     if ($incoming ne '') {
                   17087:         $outgoing = $incoming;
                   17088:         $outgoing =~ s/;/&#059;/g;
                   17089:         $outgoing =~ s/\#/&#035;/g;
                   17090:         $outgoing =~ s/\&/&#038;/g;
                   17091:         $outgoing =~ s/</&#060;/g;
                   17092:         $outgoing =~ s/>/&#062;/g;
                   17093:         $outgoing =~ s/\(/&#040/g;
                   17094:         $outgoing =~ s/\)/&#041;/g;
                   17095:         $outgoing =~ s/"/&#034;/g;
                   17096:         $outgoing =~ s/'/&#039;/g;
                   17097:         $outgoing =~ s/\$/&#036;/g;
                   17098:         $outgoing =~ s{/}{&#047;}g;
                   17099:         $outgoing =~ s/=/&#061;/g;
                   17100:         $outgoing =~ s/\\/&#092;/g
                   17101:     }
                   17102:     return $outgoing;
                   17103: }
                   17104: 
1.1075.2.74  raeburn  17105: # Checks for critical messages and returns a redirect url if one exists.
                   17106: # $interval indicates how often to check for messages.
                   17107: sub critical_redirect {
                   17108:     my ($interval) = @_;
                   17109:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
                   17110:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   17111:                                         $env{'user.name'});
                   17112:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   17113:         my $redirecturl;
                   17114:         if ($what[0]) {
                   17115:             if (($what[0] ne 'con_lost') && ($what[0]!~/^error\:/)) {
                   17116:                 $redirecturl='/adm/email?critical=display';
                   17117:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   17118:                 return (1, $url);
                   17119:             }
                   17120:         }
                   17121:     }
                   17122:     return ();
                   17123: }
                   17124: 
1.1075.2.64  raeburn  17125: # Use:
                   17126: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   17127: #
                   17128: ##################################################
                   17129: #          password associated functions         #
                   17130: ##################################################
                   17131: sub des_keys {
                   17132:     # Make a new key for DES encryption.
                   17133:     # Each key has two parts which are returned separately.
                   17134:     # Please note:  Each key must be passed through the &hex function
                   17135:     # before it is output to the web browser.  The hex versions cannot
                   17136:     # be used to decrypt.
                   17137:     my @hexstr=('0','1','2','3','4','5','6','7',
                   17138:                 '8','9','a','b','c','d','e','f');
                   17139:     my $lkey='';
                   17140:     for (0..7) {
                   17141:         $lkey.=$hexstr[rand(15)];
                   17142:     }
                   17143:     my $ukey='';
                   17144:     for (0..7) {
                   17145:         $ukey.=$hexstr[rand(15)];
                   17146:     }
                   17147:     return ($lkey,$ukey);
                   17148: }
                   17149: 
                   17150: sub des_decrypt {
                   17151:     my ($key,$cyphertext) = @_;
                   17152:     my $keybin=pack("H16",$key);
                   17153:     my $cypher;
                   17154:     if ($Crypt::DES::VERSION>=2.03) {
                   17155:         $cypher=new Crypt::DES $keybin;
                   17156:     } else {
                   17157:         $cypher=new DES $keybin;
                   17158:     }
1.1075.2.106  raeburn  17159:     my $plaintext='';
                   17160:     my $cypherlength = length($cyphertext);
                   17161:     my $numchunks = int($cypherlength/32);
                   17162:     for (my $j=0; $j<$numchunks; $j++) {
                   17163:         my $start = $j*32;
                   17164:         my $cypherblock = substr($cyphertext,$start,32);
                   17165:         my $chunk =
                   17166:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   17167:         $chunk .=
                   17168:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   17169:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   17170:         $plaintext .= $chunk;
                   17171:     }
1.1075.2.64  raeburn  17172:     return $plaintext;
                   17173: }
                   17174: 
1.1075.2.135  raeburn  17175: sub is_nonframeable {
                   17176:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   17177:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
                   17178:     return if (($remprotocol eq '') || ($remhost eq ''));
                   17179: 
                   17180:     $remprotocol = lc($remprotocol);
                   17181:     $remhost = lc($remhost);
                   17182:     my $remport = 80;
                   17183:     if ($remprotocol eq 'https') {
                   17184:         $remport = 443;
                   17185:     }
                   17186:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
                   17187:     if ($cached) {
                   17188:         unless ($nocache) {
                   17189:             if ($result) {
                   17190:                 return 1;
                   17191:             } else {
                   17192:                 return 0;
                   17193:             }
                   17194:         }
                   17195:     }
                   17196:     my $uselink;
                   17197:     my $request = new HTTP::Request('HEAD',$url);
1.1075.2.142  raeburn  17198:     my $ua = LWP::UserAgent->new;
                   17199:     $ua->timeout(5);
                   17200:     my $response=$ua->request($request);
1.1075.2.135  raeburn  17201:     if ($response->is_success()) {
                   17202:         my $secpolicy = lc($response->header('content-security-policy'));
                   17203:         my $xframeop = lc($response->header('x-frame-options'));
                   17204:         $secpolicy =~ s/^\s+|\s+$//g;
                   17205:         $xframeop =~ s/^\s+|\s+$//g;
                   17206:         if (($secpolicy ne '') || ($xframeop ne '')) {
                   17207:             my $remotehost = $remprotocol.'://'.$remhost;
                   17208:             my ($origin,$protocol,$port);
                   17209:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   17210:                 $port = $ENV{'SERVER_PORT'};
                   17211:             } else {
                   17212:                 $port = 80;
                   17213:             }
                   17214:             if ($absolute eq '') {
                   17215:                 $protocol = 'http:';
                   17216:                 if ($port == 443) {
                   17217:                     $protocol = 'https:';
                   17218:                 }
                   17219:                 $origin = $protocol.'//'.lc($hostname);
                   17220:             } else {
                   17221:                 $origin = lc($absolute);
                   17222:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   17223:             }
                   17224:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   17225:                 my $framepolicy = $1;
                   17226:                 $framepolicy =~ s/^\s+|\s+$//g;
                   17227:                 my @policies = split(/\s+/,$framepolicy);
                   17228:                 if (@policies) {
                   17229:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   17230:                         $uselink = 1;
                   17231:                     } else {
                   17232:                         $uselink = 1;
                   17233:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   17234:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   17235:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   17236:                             undef($uselink);
                   17237:                         }
                   17238:                         if ($uselink) {
                   17239:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   17240:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   17241:                                     undef($uselink);
                   17242:                                 }
                   17243:                             }
                   17244:                         }
                   17245:                         if ($uselink) {
                   17246:                             my @possok;
                   17247:                             if ($ip ne '') {
                   17248:                                 push(@possok,$ip);
                   17249:                             }
                   17250:                             my $hoststr = '';
                   17251:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   17252:                                 if ($hoststr eq '') {
                   17253:                                     $hoststr = $part;
                   17254:                                 } else {
                   17255:                                     $hoststr = "$part.$hoststr";
                   17256:                                 }
                   17257:                                 if ($hoststr eq $hostname) {
                   17258:                                     push(@possok,$hostname);
                   17259:                                 } else {
                   17260:                                     push(@possok,"*.$hoststr");
                   17261:                                 }
                   17262:                             }
                   17263:                             if (@possok) {
                   17264:                                 foreach my $poss (@possok) {
                   17265:                                     last if (!$uselink);
                   17266:                                     foreach my $policy (@policies) {
                   17267:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   17268:                                             undef($uselink);
                   17269:                                             last;
                   17270:                                         }
                   17271:                                     }
                   17272:                                 }
                   17273:                             }
                   17274:                         }
                   17275:                     }
                   17276:                 }
                   17277:             } elsif ($xframeop ne '') {
                   17278:                 $uselink = 1;
                   17279:                 my @policies = split(/\s*,\s*/,$xframeop);
                   17280:                 if (@policies) {
                   17281:                     unless (grep(/^deny$/,@policies)) {
                   17282:                         if ($origin ne '') {
                   17283:                             if (grep(/^sameorigin$/,@policies)) {
                   17284:                                 if ($remotehost eq $origin) {
                   17285:                                     undef($uselink);
                   17286:                                 }
                   17287:                             }
                   17288:                             if ($uselink) {
                   17289:                                 foreach my $policy (@policies) {
                   17290:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   17291:                                         my $allowfrom = $1;
                   17292:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   17293:                                             undef($uselink);
                   17294:                                             last;
                   17295:                                         }
                   17296:                                     }
                   17297:                                 }
                   17298:                             }
                   17299:                         }
                   17300:                     }
                   17301:                 }
                   17302:             }
                   17303:         }
                   17304:     }
                   17305:     if ($nocache) {
                   17306:         if ($cached) {
                   17307:             my $devalidate;
                   17308:             if ($uselink && !$result) {
                   17309:                 $devalidate = 1;
                   17310:             } elsif (!$uselink && $result) {
                   17311:                 $devalidate = 1;
                   17312:             }
                   17313:             if ($devalidate) {
                   17314:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   17315:             }
                   17316:         }
                   17317:     } else {
                   17318:         if ($uselink) {
                   17319:             $result = 1;
                   17320:         } else {
                   17321:             $result = 0;
                   17322:         }
                   17323:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   17324:     }
                   17325:     return $uselink;
                   17326: }
                   17327: 
1.112     bowersj2 17328: 1;
                   17329: __END__;
1.41      ng       17330: 

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