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

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.172! raeburn     4: # $Id: loncommon.pm,v 1.1075.2.171 2024/10/06 00:30:26 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.139     matthew    64: use HTML::Entities;
1.334     albertel   65: use Apache::lonhtmlcommon();
                     66: use Apache::loncoursedata();
1.344     albertel   67: use Apache::lontexconvert();
1.444     albertel   68: use Apache::lonclonecourse();
1.1075.2.25  raeburn    69: use Apache::lonuserutils();
1.1075.2.27  raeburn    70: use Apache::lonuserstate();
1.1075.2.69  raeburn    71: use Apache::courseclassifier();
1.479     albertel   72: use LONCAPA qw(:DEFAULT :match);
1.1075.2.135  raeburn    73: use HTTP::Request;
1.657     raeburn    74: use DateTime::TimeZone;
1.1075.2.102  raeburn    75: use DateTime::Locale;
1.1075.2.94  raeburn    76: use Encode();
1.1075.2.14  raeburn    77: use Authen::Captcha;
                     78: use Captcha::reCAPTCHA;
1.1075.2.107  raeburn    79: use JSON::DWIW;
                     80: use LWP::UserAgent;
1.1075.2.64  raeburn    81: use Crypt::DES;
                     82: use DynaLoader; # for Crypt::DES version
1.1075.2.128  raeburn    83: use File::Copy();
                     84: use File::Path();
1.117     www        85: 
1.517     raeburn    86: # ---------------------------------------------- Designs
                     87: use vars qw(%defaultdesign);
                     88: 
1.22      www        89: my $readit;
                     90: 
1.517     raeburn    91: 
1.157     matthew    92: ##
                     93: ## Global Variables
                     94: ##
1.46      matthew    95: 
1.643     foxr       96: 
                     97: # ----------------------------------------------- SSI with retries:
                     98: #
                     99: 
                    100: =pod
                    101: 
1.648     raeburn   102: =head1 Server Side include with retries:
1.643     foxr      103: 
                    104: =over 4
                    105: 
1.648     raeburn   106: =item * &ssi_with_retries(resource,retries form)
1.643     foxr      107: 
                    108: Performs an ssi with some number of retries.  Retries continue either
                    109: until the result is ok or until the retry count supplied by the
                    110: caller is exhausted.  
                    111: 
                    112: Inputs:
1.648     raeburn   113: 
                    114: =over 4
                    115: 
1.643     foxr      116: resource   - Identifies the resource to insert.
1.648     raeburn   117: 
1.643     foxr      118: retries    - Count of the number of retries allowed.
1.648     raeburn   119: 
1.643     foxr      120: form       - Hash that identifies the rendering options.
                    121: 
1.648     raeburn   122: =back
                    123: 
                    124: Returns:
                    125: 
                    126: =over 4
                    127: 
1.643     foxr      128: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   129: 
1.643     foxr      130: response   - The response from the last attempt (which may or may not have been successful.
                    131: 
1.648     raeburn   132: =back
                    133: 
                    134: =back
                    135: 
1.643     foxr      136: =cut
                    137: 
                    138: sub ssi_with_retries {
                    139:     my ($resource, $retries, %form) = @_;
                    140: 
                    141: 
                    142:     my $ok = 0;			# True if we got a good response.
                    143:     my $content;
                    144:     my $response;
                    145: 
                    146:     # Try to get the ssi done. within the retries count:
                    147: 
                    148:     do {
                    149: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    150: 	$ok      = $response->is_success;
1.650     www       151:         if (!$ok) {
                    152:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    153:         }
1.643     foxr      154: 	$retries--;
                    155:     } while (!$ok && ($retries > 0));
                    156: 
                    157:     if (!$ok) {
                    158: 	$content = '';		# On error return an empty content.
                    159:     }
                    160:     return ($content, $response);
                    161: 
                    162: }
                    163: 
                    164: 
                    165: 
1.20      www       166: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  167: my %language;
1.124     www       168: my %supported_language;
1.1048    foxr      169: my %latex_language;		# For choosing hyphenation in <transl..>
                    170: my %latex_language_bykey;	# for choosing hyphenation from metadata
1.12      harris41  171: my %cprtag;
1.192     taceyjo1  172: my %scprtag;
1.351     www       173: my %fe; my %fd; my %fm;
1.41      ng        174: my %category_extensions;
1.12      harris41  175: 
1.46      matthew   176: # ---------------------------------------------- Thesaurus variables
1.144     matthew   177: #
                    178: # %Keywords:
                    179: #      A hash used by &keyword to determine if a word is considered a keyword.
                    180: # $thesaurus_db_file 
                    181: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   182: 
                    183: my %Keywords;
                    184: my $thesaurus_db_file;
                    185: 
1.144     matthew   186: #
                    187: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    188: # thesaurus.tab, and filecategories.tab.
                    189: #
1.18      www       190: BEGIN {
1.46      matthew   191:     # Variable initialization
                    192:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    193:     #
1.22      www       194:     unless ($readit) {
1.12      harris41  195: # ------------------------------------------------------------------- languages
                    196:     {
1.158     raeburn   197:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    198:                                    '/language.tab';
1.1075.2.128  raeburn   199:         if ( open(my $fh,'<',$langtabfile) ) {
1.356     albertel  200:             while (my $line = <$fh>) {
                    201:                 next if ($line=~/^\#/);
                    202:                 chomp($line);
1.1048    foxr      203:                 my ($key,$two,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158     raeburn   204:                 $language{$key}=$val.' - '.$enc;
                    205:                 if ($sup) {
                    206:                     $supported_language{$key}=$sup;
                    207:                 }
1.1048    foxr      208: 		if ($latex) {
                    209: 		    $latex_language_bykey{$key} = $latex;
                    210: 		    $latex_language{$two} = $latex;
                    211: 		}
1.158     raeburn   212:             }
                    213:             close($fh);
                    214:         }
1.12      harris41  215:     }
                    216: # ------------------------------------------------------------------ copyrights
                    217:     {
1.158     raeburn   218:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    219:                                   '/copyright.tab';
1.1075.2.128  raeburn   220:         if ( open (my $fh,'<',$copyrightfile) ) {
1.356     albertel  221:             while (my $line = <$fh>) {
                    222:                 next if ($line=~/^\#/);
                    223:                 chomp($line);
                    224:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   225:                 $cprtag{$key}=$val;
                    226:             }
                    227:             close($fh);
                    228:         }
1.12      harris41  229:     }
1.351     www       230: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  231:     {
                    232:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    233:                                   '/source_copyright.tab';
1.1075.2.128  raeburn   234:         if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356     albertel  235:             while (my $line = <$fh>) {
                    236:                 next if ($line =~ /^\#/);
                    237:                 chomp($line);
                    238:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  239:                 $scprtag{$key}=$val;
                    240:             }
                    241:             close($fh);
                    242:         }
                    243:     }
1.63      www       244: 
1.517     raeburn   245: # -------------------------------------------------------------- default domain designs
1.63      www       246:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   247:     my $designfile = $designdir.'/default.tab';
1.1075.2.128  raeburn   248:     if ( open (my $fh,'<',$designfile) ) {
1.517     raeburn   249:         while (my $line = <$fh>) {
                    250:             next if ($line =~ /^\#/);
                    251:             chomp($line);
                    252:             my ($key,$val)=(split(/\=/,$line));
                    253:             if ($val) { $defaultdesign{$key}=$val; }
                    254:         }
                    255:         close($fh);
1.63      www       256:     }
                    257: 
1.15      harris41  258: # ------------------------------------------------------------- file categories
                    259:     {
1.158     raeburn   260:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    261:                                   '/filecategories.tab';
1.1075.2.128  raeburn   262:         if ( open (my $fh,'<',$categoryfile) ) {
1.356     albertel  263: 	    while (my $line = <$fh>) {
                    264: 		next if ($line =~ /^\#/);
                    265: 		chomp($line);
                    266:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.1075.2.119  raeburn   267:                 push(@{$category_extensions{lc($category)}},$extension);
1.158     raeburn   268:             }
                    269:             close($fh);
                    270:         }
                    271: 
1.15      harris41  272:     }
1.12      harris41  273: # ------------------------------------------------------------------ file types
                    274:     {
1.158     raeburn   275:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    276:                '/filetypes.tab';
1.1075.2.128  raeburn   277:         if ( open (my $fh,'<',$typesfile) ) {
1.356     albertel  278:             while (my $line = <$fh>) {
                    279: 		next if ($line =~ /^\#/);
                    280: 		chomp($line);
                    281:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   282:                 if ($descr ne '') {
                    283:                     $fe{$ending}=lc($emb);
                    284:                     $fd{$ending}=$descr;
1.351     www       285:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   286:                 }
                    287:             }
                    288:             close($fh);
                    289:         }
1.12      harris41  290:     }
1.22      www       291:     &Apache::lonnet::logthis(
1.705     tempelho  292:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       293:     $readit=1;
1.46      matthew   294:     }  # end of unless($readit) 
1.32      matthew   295:     
                    296: }
1.112     bowersj2  297: 
1.42      matthew   298: ###############################################################
                    299: ##           HTML and Javascript Helper Functions            ##
                    300: ###############################################################
                    301: 
                    302: =pod 
                    303: 
1.112     bowersj2  304: =head1 HTML and Javascript Functions
1.42      matthew   305: 
1.112     bowersj2  306: =over 4
                    307: 
1.648     raeburn   308: =item * &browser_and_searcher_javascript()
1.112     bowersj2  309: 
                    310: X<browsing, javascript>X<searching, javascript>Returns a string
                    311: containing javascript with two functions, C<openbrowser> and
                    312: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    313: tags.
1.42      matthew   314: 
1.648     raeburn   315: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   316: 
                    317: inputs: formname, elementname, only, omit
                    318: 
                    319: formname and elementname indicate the name of the html form and name of
                    320: the element that the results of the browsing selection are to be placed in. 
                    321: 
                    322: Specifying 'only' will restrict the browser to displaying only files
1.185     www       323: with the given extension.  Can be a comma separated list.
1.42      matthew   324: 
                    325: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       326: with the given extension.  Can be a comma separated list.
1.42      matthew   327: 
1.648     raeburn   328: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   329: 
                    330: Inputs: formname, elementname
                    331: 
                    332: formname and elementname specify the name of the html form and the name
                    333: of the element the selection from the search results will be placed in.
1.542     raeburn   334: 
1.42      matthew   335: =cut
                    336: 
                    337: sub browser_and_searcher_javascript {
1.199     albertel  338:     my ($mode)=@_;
                    339:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  340:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   341:     return <<END;
1.219     albertel  342: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   343:     var editbrowser = null;
1.135     albertel  344:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       345:         var url = '$resurl/?';
1.42      matthew   346:         if (editbrowser == null) {
                    347:             url += 'launch=1&';
                    348:         }
                    349:         url += 'catalogmode=interactive&';
1.199     albertel  350:         url += 'mode=$mode&';
1.611     albertel  351:         url += 'inhibitmenu=yes&';
1.42      matthew   352:         url += 'form=' + formname + '&';
                    353:         if (only != null) {
                    354:             url += 'only=' + only + '&';
1.217     albertel  355:         } else {
                    356:             url += 'only=&';
                    357: 	}
1.42      matthew   358:         if (omit != null) {
                    359:             url += 'omit=' + omit + '&';
1.217     albertel  360:         } else {
                    361:             url += 'omit=&';
                    362: 	}
1.135     albertel  363:         if (titleelement != null) {
                    364:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  365:         } else {
                    366: 	    url += 'titleelement=&';
                    367: 	}
1.42      matthew   368:         url += 'element=' + elementname + '';
                    369:         var title = 'Browser';
1.435     albertel  370:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   371:         options += ',width=700,height=600';
                    372:         editbrowser = open(url,title,options,'1');
                    373:         editbrowser.focus();
                    374:     }
                    375:     var editsearcher;
1.135     albertel  376:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   377:         var url = '/adm/searchcat?';
                    378:         if (editsearcher == null) {
                    379:             url += 'launch=1&';
                    380:         }
                    381:         url += 'catalogmode=interactive&';
1.199     albertel  382:         url += 'mode=$mode&';
1.42      matthew   383:         url += 'form=' + formname + '&';
1.135     albertel  384:         if (titleelement != null) {
                    385:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  386:         } else {
                    387: 	    url += 'titleelement=&';
                    388: 	}
1.42      matthew   389:         url += 'element=' + elementname + '';
                    390:         var title = 'Search';
1.435     albertel  391:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   392:         options += ',width=700,height=600';
                    393:         editsearcher = open(url,title,options,'1');
                    394:         editsearcher.focus();
                    395:     }
1.219     albertel  396: // END LON-CAPA Internal -->
1.42      matthew   397: END
1.170     www       398: }
                    399: 
                    400: sub lastresurl {
1.258     albertel  401:     if ($env{'environment.lastresurl'}) {
                    402: 	return $env{'environment.lastresurl'}
1.170     www       403:     } else {
                    404: 	return '/res';
                    405:     }
                    406: }
                    407: 
                    408: sub storeresurl {
                    409:     my $resurl=&Apache::lonnet::clutter(shift);
                    410:     unless ($resurl=~/^\/res/) { return 0; }
                    411:     $resurl=~s/\/$//;
                    412:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   413:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       414:     return 1;
1.42      matthew   415: }
                    416: 
1.74      www       417: sub studentbrowser_javascript {
1.111     www       418:    unless (
1.258     albertel  419:             (($env{'request.course.id'}) && 
1.302     albertel  420:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    421: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    422: 					  '/'.$env{'request.course.sec'})
                    423: 	      ))
1.258     albertel  424:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       425:           ) { return ''; }  
1.74      www       426:    return (<<'ENDSTDBRW');
1.776     bisitz    427: <script type="text/javascript" language="Javascript">
1.824     bisitz    428: // <![CDATA[
1.74      www       429:     var stdeditbrowser;
1.1075.2.143  raeburn   430:     function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv) {
1.74      www       431:         var url = '/adm/pickstudent?';
                    432:         var filter;
1.558     albertel  433: 	if (!ignorefilter) {
                    434: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    435: 	}
1.74      www       436:         if (filter != null) {
                    437:            if (filter != '') {
                    438:                url += 'filter='+filter+'&';
                    439: 	   }
                    440:         }
                    441:         url += 'form=' + formname + '&unameelement='+uname+
1.999     www       442:                                     '&udomelement='+udom+
                    443:                                     '&clicker='+clicker;
1.111     www       444: 	if (roleflag) { url+="&roles=1"; }
1.1075.2.143  raeburn   445:         if (courseadv == 'condition') {
                    446:             if (document.getElementById('courseadv')) {
                    447:                 courseadv = document.getElementById('courseadv').value;
                    448:             }
                    449:         }
                    450:         if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.102     www       451:         var title = 'Student_Browser';
1.74      www       452:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    453:         options += ',width=700,height=600';
                    454:         stdeditbrowser = open(url,title,options,'1');
                    455:         stdeditbrowser.focus();
                    456:     }
1.824     bisitz    457: // ]]>
1.74      www       458: </script>
                    459: ENDSTDBRW
                    460: }
1.42      matthew   461: 
1.1003    www       462: sub resourcebrowser_javascript {
                    463:    unless ($env{'request.course.id'}) { return ''; }
1.1004    www       464:    return (<<'ENDRESBRW');
1.1003    www       465: <script type="text/javascript" language="Javascript">
                    466: // <![CDATA[
                    467:     var reseditbrowser;
1.1004    www       468:     function openresbrowser(formname,reslink) {
1.1005    www       469:         var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003    www       470:         var title = 'Resource_Browser';
                    471:         var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005    www       472:         options += ',width=700,height=500';
1.1004    www       473:         reseditbrowser = open(url,title,options,'1');
                    474:         reseditbrowser.focus();
1.1003    www       475:     }
                    476: // ]]>
                    477: </script>
1.1004    www       478: ENDRESBRW
1.1003    www       479: }
                    480: 
1.74      www       481: sub selectstudent_link {
1.1075.2.143  raeburn   482:    my ($form,$unameele,$udomele,$courseadv,$clickerid)=@_;
1.999     www       483:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    484:                       &Apache::lonhtmlcommon::entity_encode($unameele)."','".
                    485:                       &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258     albertel  486:    if ($env{'request.course.id'}) {  
1.302     albertel  487:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    488: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    489: 					'/'.$env{'request.course.sec'})) {
1.111     www       490: 	   return '';
                    491:        }
1.999     www       492:        $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1075.2.143  raeburn   493:        if ($courseadv eq 'only') {
                    494:            $callargs .= ",'',1,'$courseadv'";
                    495:        } elsif ($courseadv eq 'none') {
                    496:            $callargs .= ",'','','$courseadv'";
                    497:        } elsif ($courseadv eq 'condition') {
                    498:            $callargs .= ",'','','$courseadv'";
1.793     raeburn   499:        }
                    500:        return '<span class="LC_nobreak">'.
                    501:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    502:               &mt('Select User').'</a></span>';
1.74      www       503:    }
1.258     albertel  504:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012    www       505:        $callargs .= ",'',1"; 
1.793     raeburn   506:        return '<span class="LC_nobreak">'.
                    507:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    508:               &mt('Select User').'</a></span>';
1.111     www       509:    }
                    510:    return '';
1.91      www       511: }
                    512: 
1.1004    www       513: sub selectresource_link {
                    514:    my ($form,$reslink,$arg)=@_;
                    515:    
                    516:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    517:                       &Apache::lonhtmlcommon::entity_encode($reslink)."'";
                    518:    unless ($env{'request.course.id'}) { return $arg; }
                    519:    return '<span class="LC_nobreak">'.
                    520:               '<a href="javascript:openresbrowser('.$callargs.');">'.
                    521:               $arg.'</a></span>';
                    522: }
                    523: 
                    524: 
                    525: 
1.653     raeburn   526: sub authorbrowser_javascript {
                    527:     return <<"ENDAUTHORBRW";
1.776     bisitz    528: <script type="text/javascript" language="JavaScript">
1.824     bisitz    529: // <![CDATA[
1.653     raeburn   530: var stdeditbrowser;
                    531: 
                    532: function openauthorbrowser(formname,udom) {
                    533:     var url = '/adm/pickauthor?';
                    534:     url += 'form='+formname+'&roledom='+udom;
                    535:     var title = 'Author_Browser';
                    536:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    537:     options += ',width=700,height=600';
                    538:     stdeditbrowser = open(url,title,options,'1');
                    539:     stdeditbrowser.focus();
                    540: }
                    541: 
1.824     bisitz    542: // ]]>
1.653     raeburn   543: </script>
                    544: ENDAUTHORBRW
                    545: }
                    546: 
1.91      www       547: sub coursebrowser_javascript {
1.1075.2.31  raeburn   548:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1075.2.95  raeburn   549:         $credits_element,$instcode) = @_;
1.932     raeburn   550:     my $wintitle = 'Course_Browser';
1.931     raeburn   551:     if ($crstype eq 'Community') {
1.932     raeburn   552:         $wintitle = 'Community_Browser';
1.909     raeburn   553:     }
1.876     raeburn   554:     my $id_functions = &javascript_index_functions();
                    555:     my $output = '
1.776     bisitz    556: <script type="text/javascript" language="JavaScript">
1.824     bisitz    557: // <![CDATA[
1.468     raeburn   558:     var stdeditbrowser;'."\n";
1.876     raeburn   559: 
                    560:     $output .= <<"ENDSTDBRW";
1.909     raeburn   561:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       562:         var url = '/adm/pickcourse?';
1.895     raeburn   563:         var formid = getFormIdByName(formname);
1.876     raeburn   564:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  565:         if (domainfilter != null) {
                    566:            if (domainfilter != '') {
                    567:                url += 'domainfilter='+domainfilter+'&';
                    568: 	   }
                    569:         }
1.91      www       570:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  571: 	                            '&cdomelement='+udom+
                    572:                                     '&cnameelement='+desc;
1.468     raeburn   573:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   574:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   575:                 url += '&roleelement='+extra_element;
                    576:                 if (domainfilter == null || domainfilter == '') {
                    577:                     url += '&domainfilter='+extra_element;
                    578:                 }
1.234     raeburn   579:             }
1.468     raeburn   580:             else {
                    581:                 if (formname == 'portform') {
                    582:                     url += '&setroles='+extra_element;
1.800     raeburn   583:                 } else {
                    584:                     if (formname == 'rules') {
                    585:                         url += '&fixeddom='+extra_element; 
                    586:                     }
1.468     raeburn   587:                 }
                    588:             }     
1.230     raeburn   589:         }
1.909     raeburn   590:         if (type != null && type != '') {
                    591:             url += '&type='+type;
                    592:         }
                    593:         if (type_elem != null && type_elem != '') {
                    594:             url += '&typeelement='+type_elem;
                    595:         }
1.872     raeburn   596:         if (formname == 'ccrs') {
                    597:             var ownername = document.forms[formid].ccuname.value;
                    598:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1075.2.101  raeburn   599:             url += '&cloner='+ownername+':'+ownerdom;
                    600:             if (type == 'Course') {
                    601:                 url += '&crscode='+document.forms[formid].crscode.value;
                    602:             }
1.1075.2.95  raeburn   603:         }
                    604:         if (formname == 'requestcrs') {
                    605:             url += '&crsdom=$domainfilter&crscode=$instcode';
1.872     raeburn   606:         }
1.293     raeburn   607:         if (multflag !=null && multflag != '') {
                    608:             url += '&multiple='+multflag;
                    609:         }
1.909     raeburn   610:         var title = '$wintitle';
1.91      www       611:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    612:         options += ',width=700,height=600';
                    613:         stdeditbrowser = open(url,title,options,'1');
                    614:         stdeditbrowser.focus();
                    615:     }
1.876     raeburn   616: $id_functions
                    617: ENDSTDBRW
1.1075.2.31  raeburn   618:     if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
                    619:         $output .= &setsec_javascript($sec_element,$formname,$role_element,
                    620:                                       $credits_element);
1.876     raeburn   621:     }
                    622:     $output .= '
                    623: // ]]>
                    624: </script>';
                    625:     return $output;
                    626: }
                    627: 
                    628: sub javascript_index_functions {
                    629:     return <<"ENDJS";
                    630: 
                    631: function getFormIdByName(formname) {
                    632:     for (var i=0;i<document.forms.length;i++) {
                    633:         if (document.forms[i].name == formname) {
                    634:             return i;
                    635:         }
                    636:     }
                    637:     return -1;
                    638: }
                    639: 
                    640: function getIndexByName(formid,item) {
                    641:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    642:         if (document.forms[formid].elements[i].name == item) {
                    643:             return i;
                    644:         }
                    645:     }
                    646:     return -1;
                    647: }
1.468     raeburn   648: 
1.876     raeburn   649: function getDomainFromSelectbox(formname,udom) {
                    650:     var userdom;
                    651:     var formid = getFormIdByName(formname);
                    652:     if (formid > -1) {
                    653:         var domid = getIndexByName(formid,udom);
                    654:         if (domid > -1) {
                    655:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    656:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    657:             }
                    658:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    659:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   660:             }
                    661:         }
                    662:     }
1.876     raeburn   663:     return userdom;
                    664: }
                    665: 
                    666: ENDJS
1.468     raeburn   667: 
1.876     raeburn   668: }
                    669: 
1.1017    raeburn   670: sub javascript_array_indexof {
1.1018    raeburn   671:     return <<ENDJS;
1.1017    raeburn   672: <script type="text/javascript" language="JavaScript">
                    673: // <![CDATA[
                    674: 
                    675: if (!Array.prototype.indexOf) {
                    676:     Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
                    677:         "use strict";
                    678:         if (this === void 0 || this === null) {
                    679:             throw new TypeError();
                    680:         }
                    681:         var t = Object(this);
                    682:         var len = t.length >>> 0;
                    683:         if (len === 0) {
                    684:             return -1;
                    685:         }
                    686:         var n = 0;
                    687:         if (arguments.length > 0) {
                    688:             n = Number(arguments[1]);
                    689:             if (n !== n) { // shortcut for verifying if it's NaN
                    690:                 n = 0;
                    691:             } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
                    692:                 n = (n > 0 || -1) * Math.floor(Math.abs(n));
                    693:             }
                    694:         }
                    695:         if (n >= len) {
                    696:             return -1;
                    697:         }
                    698:         var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
                    699:         for (; k < len; k++) {
                    700:             if (k in t && t[k] === searchElement) {
                    701:                 return k;
                    702:             }
                    703:         }
                    704:         return -1;
                    705:     }
                    706: }
                    707: 
                    708: // ]]>
                    709: </script>
                    710: 
                    711: ENDJS
                    712: 
                    713: }
                    714: 
1.876     raeburn   715: sub userbrowser_javascript {
                    716:     my $id_functions = &javascript_index_functions();
                    717:     return <<"ENDUSERBRW";
                    718: 
1.888     raeburn   719: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   720:     var url = '/adm/pickuser?';
                    721:     var userdom = getDomainFromSelectbox(formname,udom);
                    722:     if (userdom != null) {
                    723:        if (userdom != '') {
                    724:            url += 'srchdom='+userdom+'&';
                    725:        }
                    726:     }
                    727:     url += 'form=' + formname + '&unameelement='+uname+
                    728:                                 '&udomelement='+udom+
                    729:                                 '&ulastelement='+ulast+
                    730:                                 '&ufirstelement='+ufirst+
                    731:                                 '&uemailelement='+uemail+
1.881     raeburn   732:                                 '&hideudomelement='+hideudom+
                    733:                                 '&coursedom='+crsdom;
1.888     raeburn   734:     if ((caller != null) && (caller != undefined)) {
                    735:         url += '&caller='+caller;
                    736:     }
1.876     raeburn   737:     var title = 'User_Browser';
                    738:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    739:     options += ',width=700,height=600';
                    740:     var stdeditbrowser = open(url,title,options,'1');
                    741:     stdeditbrowser.focus();
                    742: }
                    743: 
1.888     raeburn   744: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   745:     var formid = getFormIdByName(formname);
                    746:     if (formid > -1) {
1.888     raeburn   747:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   748:         var domid = getIndexByName(formid,udom);
                    749:         var hidedomid = getIndexByName(formid,origdom);
                    750:         if (hidedomid > -1) {
                    751:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   752:             var unameval = document.forms[formid].elements[unameid].value;
                    753:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    754:                 if (domid > -1) {
                    755:                     var slct = document.forms[formid].elements[domid];
                    756:                     if (slct.type == 'select-one') {
                    757:                         var i;
                    758:                         for (i=0;i<slct.length;i++) {
                    759:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    760:                         }
                    761:                     }
                    762:                     if (slct.type == 'hidden') {
                    763:                         slct.value = fixeddom;
1.876     raeburn   764:                     }
                    765:                 }
1.468     raeburn   766:             }
                    767:         }
                    768:     }
1.876     raeburn   769:     return;
                    770: }
                    771: 
                    772: $id_functions
                    773: ENDUSERBRW
1.468     raeburn   774: }
                    775: 
                    776: sub setsec_javascript {
1.1075.2.31  raeburn   777:     my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905     raeburn   778:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    779:         $communityrolestr);
                    780:     if ($role_element ne '') {
                    781:         my @allroles = ('st','ta','ep','in','ad');
                    782:         foreach my $crstype ('Course','Community') {
                    783:             if ($crstype eq 'Community') {
                    784:                 foreach my $role (@allroles) {
                    785:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    786:                 }
                    787:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    788:             } else {
                    789:                 foreach my $role (@allroles) {
                    790:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    791:                 }
                    792:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    793:             }
                    794:         }
                    795:         $rolestr = '"'.join('","',@allroles).'"';
                    796:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    797:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    798:     }
1.468     raeburn   799:     my $setsections = qq|
                    800: function setSect(sectionlist) {
1.629     raeburn   801:     var sectionsArray = new Array();
                    802:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    803:         sectionsArray = sectionlist.split(",");
                    804:     }
1.468     raeburn   805:     var numSections = sectionsArray.length;
                    806:     document.$formname.$sec_element.length = 0;
                    807:     if (numSections == 0) {
                    808:         document.$formname.$sec_element.multiple=false;
                    809:         document.$formname.$sec_element.size=1;
                    810:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    811:     } else {
                    812:         if (numSections == 1) {
                    813:             document.$formname.$sec_element.multiple=false;
                    814:             document.$formname.$sec_element.size=1;
                    815:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    816:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    817:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    818:         } else {
                    819:             for (var i=0; i<numSections; i++) {
                    820:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    821:             }
                    822:             document.$formname.$sec_element.multiple=true
                    823:             if (numSections < 3) {
                    824:                 document.$formname.$sec_element.size=numSections;
                    825:             } else {
                    826:                 document.$formname.$sec_element.size=3;
                    827:             }
                    828:             document.$formname.$sec_element.options[0].selected = false
                    829:         }
                    830:     }
1.91      www       831: }
1.905     raeburn   832: 
                    833: function setRole(crstype) {
1.468     raeburn   834: |;
1.905     raeburn   835:     if ($role_element eq '') {
                    836:         $setsections .= '    return;
                    837: }
                    838: ';
                    839:     } else {
                    840:         $setsections .= qq|
                    841:     var elementLength = document.$formname.$role_element.length;
                    842:     var allroles = Array($rolestr);
                    843:     var courserolenames = Array($courserolestr);
                    844:     var communityrolenames = Array($communityrolestr);
                    845:     if (elementLength != undefined) {
                    846:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    847:             if (crstype == 'Course') {
                    848:                 return;
                    849:             } else {
                    850:                 allroles[5] = 'co';
                    851:                 for (var i=0; i<6; i++) {
                    852:                     document.$formname.$role_element.options[i].value = allroles[i];
                    853:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    854:                 }
                    855:             }
                    856:         } else {
                    857:             if (crstype == 'Community') {
                    858:                 return;
                    859:             } else {
                    860:                 allroles[5] = 'cc';
                    861:                 for (var i=0; i<6; i++) {
                    862:                     document.$formname.$role_element.options[i].value = allroles[i];
                    863:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    864:                 }
                    865:             }
                    866:         }
                    867:     }
                    868:     return;
                    869: }
                    870: |;
                    871:     }
1.1075.2.31  raeburn   872:     if ($credits_element) {
                    873:         $setsections .= qq|
                    874: function setCredits(defaultcredits) {
                    875:     document.$formname.$credits_element.value = defaultcredits;
                    876:     return;
                    877: }
                    878: |;
                    879:     }
1.468     raeburn   880:     return $setsections;
                    881: }
                    882: 
1.91      www       883: sub selectcourse_link {
1.909     raeburn   884:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    885:        $typeelement) = @_;
                    886:    my $type = $selecttype;
1.871     raeburn   887:    my $linktext = &mt('Select Course');
                    888:    if ($selecttype eq 'Community') {
1.909     raeburn   889:        $linktext = &mt('Select Community');
1.906     raeburn   890:    } elsif ($selecttype eq 'Course/Community') {
                    891:        $linktext = &mt('Select Course/Community');
1.909     raeburn   892:        $type = '';
1.1019    raeburn   893:    } elsif ($selecttype eq 'Select') {
                    894:        $linktext = &mt('Select');
                    895:        $type = '';
1.871     raeburn   896:    }
1.787     bisitz    897:    return '<span class="LC_nobreak">'
                    898:          ."<a href='"
                    899:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    900:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   901:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   902:          ."'>".$linktext.'</a>'
1.787     bisitz    903:          .'</span>';
1.74      www       904: }
1.42      matthew   905: 
1.653     raeburn   906: sub selectauthor_link {
                    907:    my ($form,$udom)=@_;
                    908:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    909:           &mt('Select Author').'</a>';
                    910: }
                    911: 
1.876     raeburn   912: sub selectuser_link {
1.881     raeburn   913:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   914:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   915:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   916:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   917:            ');">'.$linktext.'</a>';
1.876     raeburn   918: }
                    919: 
1.273     raeburn   920: sub check_uncheck_jscript {
                    921:     my $jscript = <<"ENDSCRT";
                    922: function checkAll(field) {
                    923:     if (field.length > 0) {
                    924:         for (i = 0; i < field.length; i++) {
1.1075.2.14  raeburn   925:             if (!field[i].disabled) {
                    926:                 field[i].checked = true;
                    927:             }
1.273     raeburn   928:         }
                    929:     } else {
1.1075.2.14  raeburn   930:         if (!field.disabled) {
                    931:             field.checked = true;
                    932:         }
1.273     raeburn   933:     }
                    934: }
                    935:  
                    936: function uncheckAll(field) {
                    937:     if (field.length > 0) {
                    938:         for (i = 0; i < field.length; i++) {
                    939:             field[i].checked = false ;
1.543     albertel  940:         }
                    941:     } else {
1.273     raeburn   942:         field.checked = false ;
                    943:     }
                    944: }
                    945: ENDSCRT
                    946:     return $jscript;
                    947: }
                    948: 
1.656     www       949: sub select_timezone {
1.1075.2.115  raeburn   950:    my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
                    951:    my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.659     raeburn   952:    if ($includeempty) {
                    953:        $output .= '<option value=""';
                    954:        if (($selected eq '') || ($selected eq 'local')) {
                    955:            $output .= ' selected="selected" ';
                    956:        }
                    957:        $output .= '> </option>';
                    958:    }
1.657     raeburn   959:    my @timezones = DateTime::TimeZone->all_names;
                    960:    foreach my $tzone (@timezones) {
                    961:        $output.= '<option value="'.$tzone.'"';
                    962:        if ($tzone eq $selected) {
                    963:            $output.=' selected="selected"';
                    964:        }
                    965:        $output.=">$tzone</option>\n";
1.656     www       966:    }
                    967:    $output.="</select>";
                    968:    return $output;
                    969: }
1.273     raeburn   970: 
1.687     raeburn   971: sub select_datelocale {
1.1075.2.115  raeburn   972:     my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
                    973:     my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687     raeburn   974:     if ($includeempty) {
                    975:         $output .= '<option value=""';
                    976:         if ($selected eq '') {
                    977:             $output .= ' selected="selected" ';
                    978:         }
                    979:         $output .= '> </option>';
                    980:     }
1.1075.2.102  raeburn   981:     my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   982:     my (@possibles,%locale_names);
1.1075.2.102  raeburn   983:     my @locales = DateTime::Locale->ids();
                    984:     foreach my $id (@locales) {
                    985:         if ($id ne '') {
                    986:             my ($en_terr,$native_terr);
                    987:             my $loc = DateTime::Locale->load($id);
                    988:             if (ref($loc)) {
                    989:                 $en_terr = $loc->name();
                    990:                 $native_terr = $loc->native_name();
1.687     raeburn   991:                 if (grep(/^en$/,@languages) || !@languages) {
                    992:                     if ($en_terr ne '') {
                    993:                         $locale_names{$id} = '('.$en_terr.')';
                    994:                     } elsif ($native_terr ne '') {
                    995:                         $locale_names{$id} = $native_terr;
                    996:                     }
                    997:                 } else {
                    998:                     if ($native_terr ne '') {
                    999:                         $locale_names{$id} = $native_terr.' ';
                   1000:                     } elsif ($en_terr ne '') {
                   1001:                         $locale_names{$id} = '('.$en_terr.')';
                   1002:                     }
                   1003:                 }
1.1075.2.94  raeburn  1004:                 $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1075.2.102  raeburn  1005:                 push(@possibles,$id);
1.687     raeburn  1006:             }
                   1007:         }
                   1008:     }
                   1009:     foreach my $item (sort(@possibles)) {
                   1010:         $output.= '<option value="'.$item.'"';
                   1011:         if ($item eq $selected) {
                   1012:             $output.=' selected="selected"';
                   1013:         }
                   1014:         $output.=">$item";
                   1015:         if ($locale_names{$item} ne '') {
1.1075.2.94  raeburn  1016:             $output.='  '.$locale_names{$item};
1.687     raeburn  1017:         }
                   1018:         $output.="</option>\n";
                   1019:     }
                   1020:     $output.="</select>";
                   1021:     return $output;
                   1022: }
                   1023: 
1.792     raeburn  1024: sub select_language {
1.1075.2.115  raeburn  1025:     my ($name,$selected,$includeempty,$noedit) = @_;
1.792     raeburn  1026:     my %langchoices;
                   1027:     if ($includeempty) {
1.1075.2.32  raeburn  1028:         %langchoices = ('' => 'No language preference');
1.792     raeburn  1029:     }
                   1030:     foreach my $id (&languageids()) {
                   1031:         my $code = &supportedlanguagecode($id);
                   1032:         if ($code) {
                   1033:             $langchoices{$code} = &plainlanguagedescription($id);
                   1034:         }
                   1035:     }
1.1075.2.32  raeburn  1036:     %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1075.2.115  raeburn  1037:     return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792     raeburn  1038: }
                   1039: 
1.42      matthew  1040: =pod
1.36      matthew  1041: 
1.648     raeburn  1042: =item * &linked_select_forms(...)
1.36      matthew  1043: 
                   1044: linked_select_forms returns a string containing a <script></script> block
                   1045: and html for two <select> menus.  The select menus will be linked in that
                   1046: changing the value of the first menu will result in new values being placed
                   1047: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn  1048: order unless a defined order is provided.
1.36      matthew  1049: 
                   1050: linked_select_forms takes the following ordered inputs:
                   1051: 
                   1052: =over 4
                   1053: 
1.112     bowersj2 1054: =item * $formname, the name of the <form> tag
1.36      matthew  1055: 
1.112     bowersj2 1056: =item * $middletext, the text which appears between the <select> tags
1.36      matthew  1057: 
1.112     bowersj2 1058: =item * $firstdefault, the default value for the first menu
1.36      matthew  1059: 
1.112     bowersj2 1060: =item * $firstselectname, the name of the first <select> tag
1.36      matthew  1061: 
1.112     bowersj2 1062: =item * $secondselectname, the name of the second <select> tag
1.36      matthew  1063: 
1.112     bowersj2 1064: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew  1065: 
1.609     raeburn  1066: =item * $menuorder, the order of values in the first menu
                   1067: 
1.1075.2.31  raeburn  1068: =item * $onchangefirst, additional javascript call to execute for an onchange
                   1069:         event for the first <select> tag
                   1070: 
                   1071: =item * $onchangesecond, additional javascript call to execute for an onchange
                   1072:         event for the second <select> tag
                   1073: 
1.41      ng       1074: =back 
                   1075: 
1.36      matthew  1076: Below is an example of such a hash.  Only the 'text', 'default', and 
                   1077: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                   1078: values for the first select menu.  The text that coincides with the 
1.41      ng       1079: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew  1080: and text for the second menu are given in the hash pointed to by 
                   1081: $menu{$choice1}->{'select2'}.  
                   1082: 
1.112     bowersj2 1083:  my %menu = ( A1 => { text =>"Choice A1" ,
                   1084:                        default => "B3",
                   1085:                        select2 => { 
                   1086:                            B1 => "Choice B1",
                   1087:                            B2 => "Choice B2",
                   1088:                            B3 => "Choice B3",
                   1089:                            B4 => "Choice B4"
1.609     raeburn  1090:                            },
                   1091:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2 1092:                    },
                   1093:                A2 => { text =>"Choice A2" ,
                   1094:                        default => "C2",
                   1095:                        select2 => { 
                   1096:                            C1 => "Choice C1",
                   1097:                            C2 => "Choice C2",
                   1098:                            C3 => "Choice C3"
1.609     raeburn  1099:                            },
                   1100:                        order => ['C2','C1','C3'],
1.112     bowersj2 1101:                    },
                   1102:                A3 => { text =>"Choice A3" ,
                   1103:                        default => "D6",
                   1104:                        select2 => { 
                   1105:                            D1 => "Choice D1",
                   1106:                            D2 => "Choice D2",
                   1107:                            D3 => "Choice D3",
                   1108:                            D4 => "Choice D4",
                   1109:                            D5 => "Choice D5",
                   1110:                            D6 => "Choice D6",
                   1111:                            D7 => "Choice D7"
1.609     raeburn  1112:                            },
                   1113:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2 1114:                    }
                   1115:                );
1.36      matthew  1116: 
                   1117: =cut
                   1118: 
                   1119: sub linked_select_forms {
                   1120:     my ($formname,
                   1121:         $middletext,
                   1122:         $firstdefault,
                   1123:         $firstselectname,
                   1124:         $secondselectname, 
1.609     raeburn  1125:         $hashref,
                   1126:         $menuorder,
1.1075.2.31  raeburn  1127:         $onchangefirst,
                   1128:         $onchangesecond
1.36      matthew  1129:         ) = @_;
                   1130:     my $second = "document.$formname.$secondselectname";
                   1131:     my $first = "document.$formname.$firstselectname";
                   1132:     # output the javascript to do the changing
                   1133:     my $result = '';
1.776     bisitz   1134:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz   1135:     $result.="// <![CDATA[\n";
1.36      matthew  1136:     $result.="var select2data = new Object();\n";
                   1137:     $" = '","';
                   1138:     my $debug = '';
                   1139:     foreach my $s1 (sort(keys(%$hashref))) {
                   1140:         $result.="select2data.d_$s1 = new Object();\n";        
                   1141:         $result.="select2data.d_$s1.def = new String('".
                   1142:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1143:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1144:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1145:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1146:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1147:         }
1.36      matthew  1148:         $result.="\"@s2values\");\n";
                   1149:         $result.="select2data.d_$s1.texts = new Array(";        
                   1150:         my @s2texts;
                   1151:         foreach my $value (@s2values) {
1.1075.2.119  raeburn  1152:             push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36      matthew  1153:         }
                   1154:         $result.="\"@s2texts\");\n";
                   1155:     }
                   1156:     $"=' ';
                   1157:     $result.= <<"END";
                   1158: 
                   1159: function select1_changed() {
                   1160:     // Determine new choice
                   1161:     var newvalue = "d_" + $first.value;
                   1162:     // update select2
                   1163:     var values     = select2data[newvalue].values;
                   1164:     var texts      = select2data[newvalue].texts;
                   1165:     var select2def = select2data[newvalue].def;
                   1166:     var i;
                   1167:     // out with the old
                   1168:     for (i = 0; i < $second.options.length; i++) {
                   1169:         $second.options[i] = null;
                   1170:     }
                   1171:     // in with the nuclear
                   1172:     for (i=0;i<values.length; i++) {
                   1173:         $second.options[i] = new Option(values[i]);
1.143     matthew  1174:         $second.options[i].value = values[i];
1.36      matthew  1175:         $second.options[i].text = texts[i];
                   1176:         if (values[i] == select2def) {
                   1177:             $second.options[i].selected = true;
                   1178:         }
                   1179:     }
                   1180: }
1.824     bisitz   1181: // ]]>
1.36      matthew  1182: </script>
                   1183: END
                   1184:     # output the initial values for the selection lists
1.1075.2.31  raeburn  1185:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed();$onchangefirst\">\n";
1.609     raeburn  1186:     my @order = sort(keys(%{$hashref}));
                   1187:     if (ref($menuorder) eq 'ARRAY') {
                   1188:         @order = @{$menuorder};
                   1189:     }
                   1190:     foreach my $value (@order) {
1.36      matthew  1191:         $result.="    <option value=\"$value\" ";
1.253     albertel 1192:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1193:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1194:     }
                   1195:     $result .= "</select>\n";
                   1196:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1197:     $result .= $middletext;
1.1075.2.31  raeburn  1198:     $result .= "<select size=\"1\" name=\"$secondselectname\"";
                   1199:     if ($onchangesecond) {
                   1200:         $result .= ' onchange="'.$onchangesecond.'"';
                   1201:     }
                   1202:     $result .= ">\n";
1.36      matthew  1203:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1204:     
                   1205:     my @secondorder = sort(keys(%select2));
                   1206:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1207:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1208:     }
                   1209:     foreach my $value (@secondorder) {
1.36      matthew  1210:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1211:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1212:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1213:     }
                   1214:     $result .= "</select>\n";
                   1215:     #    return $debug;
                   1216:     return $result;
                   1217: }   #  end of sub linked_select_forms {
                   1218: 
1.45      matthew  1219: =pod
1.44      bowersj2 1220: 
1.973     raeburn  1221: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid)
1.44      bowersj2 1222: 
1.112     bowersj2 1223: Returns a string corresponding to an HTML link to the given help
                   1224: $topic, where $topic corresponds to the name of a .tex file in
                   1225: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1226: spaces. 
                   1227: 
                   1228: $text will optionally be linked to the same topic, allowing you to
                   1229: link text in addition to the graphic. If you do not want to link
                   1230: text, but wish to specify one of the later parameters, pass an
                   1231: empty string. 
                   1232: 
                   1233: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1234: the link will not open a new window. If false, the link will open
                   1235: a new window using Javascript. (Default is false.) 
                   1236: 
                   1237: $width and $height are optional numerical parameters that will
                   1238: override the width and height of the popped up window, which may
1.973     raeburn  1239: be useful for certain help topics with big pictures included.
                   1240: 
                   1241: $imgid is the id of the img tag used for the help icon. This may be
                   1242: used in a javascript call to switch the image src.  See 
                   1243: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1244: 
                   1245: =cut
                   1246: 
                   1247: sub help_open_topic {
1.973     raeburn  1248:     my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_;
1.48      bowersj2 1249:     $text = "" if (not defined $text);
1.44      bowersj2 1250:     $stayOnPage = 0 if (not defined $stayOnPage);
1.1033    www      1251:     $width = 500 if (not defined $width);
1.44      bowersj2 1252:     $height = 400 if (not defined $height);
                   1253:     my $filename = $topic;
                   1254:     $filename =~ s/ /_/g;
                   1255: 
1.48      bowersj2 1256:     my $template = "";
                   1257:     my $link;
1.572     banghart 1258:     
1.159     www      1259:     $topic=~s/\W/\_/g;
1.44      bowersj2 1260: 
1.572     banghart 1261:     if (!$stayOnPage) {
1.1075.2.50  raeburn  1262:         if ($env{'browser.mobile'}) {
                   1263: 	    $link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
                   1264:         } else {
                   1265:             $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1266:         }
1.1037    www      1267:     } elsif ($stayOnPage eq 'popup') {
                   1268:         $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 1269:     } else {
1.48      bowersj2 1270: 	$link = "/adm/help/${filename}.hlp";
                   1271:     }
                   1272: 
                   1273:     # Add the text
1.755     neumanie 1274:     if ($text ne "") {	
1.763     bisitz   1275: 	$template.='<span class="LC_help_open_topic">'
                   1276:                   .'<a target="_top" href="'.$link.'">'
                   1277:                   .$text.'</a>';
1.48      bowersj2 1278:     }
                   1279: 
1.763     bisitz   1280:     # (Always) Add the graphic
1.179     matthew  1281:     my $title = &mt('Online Help');
1.667     raeburn  1282:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1283:     if ($imgid ne '') {
                   1284:         $imgid = ' id="'.$imgid.'"';
                   1285:     }
1.763     bisitz   1286:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1287:               .'<img src="'.$helpicon.'" border="0"'
                   1288:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1289:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1290:               .' /></a>';
                   1291:     if ($text ne "") {	
                   1292:         $template.='</span>';
                   1293:     }
1.44      bowersj2 1294:     return $template;
                   1295: 
1.106     bowersj2 1296: }
                   1297: 
                   1298: # This is a quicky function for Latex cheatsheet editing, since it 
                   1299: # appears in at least four places
                   1300: sub helpLatexCheatsheet {
1.1037    www      1301:     my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732     raeburn  1302:     my $out;
1.106     bowersj2 1303:     my $addOther = '';
1.732     raeburn  1304:     if ($topic) {
1.1037    www      1305: 	$addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763     bisitz   1306:     }
                   1307:     $out = '<span>' # Start cheatsheet
                   1308: 	  .$addOther
                   1309:           .'<span>'
1.1037    www      1310: 	  .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1311: 	  .'</span> <span>'
1.1037    www      1312: 	  .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1313: 	  .'</span>';
1.732     raeburn  1314:     unless ($not_author) {
1.763     bisitz   1315:         $out .= ' <span>'
1.1037    www      1316: 	       .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
1.1075.2.71  raeburn  1317: 	       .'</span> <span>'
1.1075.2.78  raeburn  1318:                .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.1075.2.71  raeburn  1319:                .'</span>';
1.732     raeburn  1320:     }
1.763     bisitz   1321:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1322:     return $out;
1.172     www      1323: }
                   1324: 
1.430     albertel 1325: sub general_help {
                   1326:     my $helptopic='Student_Intro';
                   1327:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1328: 	$helptopic='Authoring_Intro';
1.907     raeburn  1329:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1330: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1331:     } elsif ($env{'request.role'}=~/^dc/) {
                   1332:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1333:     }
                   1334:     return $helptopic;
                   1335: }
                   1336: 
                   1337: sub update_help_link {
                   1338:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1339:     my $origurl = $ENV{'REQUEST_URI'};
                   1340:     $origurl=~s|^/~|/priv/|;
                   1341:     my $timestamp = time;
                   1342:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1343:         $$datum = &escape($$datum);
                   1344:     }
                   1345: 
                   1346:     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";
                   1347:     my $output .= <<"ENDOUTPUT";
                   1348: <script type="text/javascript">
1.824     bisitz   1349: // <![CDATA[
1.430     albertel 1350: banner_link = '$banner_link';
1.824     bisitz   1351: // ]]>
1.430     albertel 1352: </script>
                   1353: ENDOUTPUT
                   1354:     return $output;
                   1355: }
                   1356: 
                   1357: # now just updates the help link and generates a blue icon
1.193     raeburn  1358: sub help_open_menu {
1.430     albertel 1359:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1360: 	= @_;    
1.949     droeschl 1361:     $stayOnPage = 1;
1.430     albertel 1362:     my $output;
                   1363:     if ($component_help) {
                   1364: 	if (!$text) {
                   1365: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1366: 				       $width,$height);
                   1367: 	} else {
                   1368: 	    my $help_text;
                   1369: 	    $help_text=&unescape($topic);
                   1370: 	    $output='<table><tr><td>'.
                   1371: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1372: 				 $width,$height).'</td></tr></table>';
                   1373: 	}
                   1374:     }
                   1375:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1376:     return $output.$banner_link;
                   1377: }
                   1378: 
                   1379: sub top_nav_help {
1.1075.2.158  raeburn  1380:     my ($text,$linkattr) = @_;
1.436     albertel 1381:     $text = &mt($text);
1.1075.2.60  raeburn  1382:     my $stay_on_page;
                   1383:     unless ($env{'environment.remote'} eq 'on') {
                   1384:         $stay_on_page = 1;
                   1385:     }
1.1075.2.61  raeburn  1386:     my ($link,$banner_link);
                   1387:     unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
                   1388:         $link = ($stay_on_page) ? "javascript:helpMenu('display')"
                   1389: 	                         : "javascript:helpMenu('open')";
                   1390:         $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
                   1391:     }
1.201     raeburn  1392:     my $title = &mt('Get help');
1.1075.2.61  raeburn  1393:     if ($link) {
                   1394:         return <<"END";
1.436     albertel 1395: $banner_link
1.1075.2.158  raeburn  1396: <a href="$link" title="$title" $linkattr>$text</a>
1.436     albertel 1397: END
1.1075.2.61  raeburn  1398:     } else {
                   1399:         return '&nbsp;'.$text.'&nbsp;';
                   1400:     }
1.436     albertel 1401: }
                   1402: 
                   1403: sub help_menu_js {
1.1075.2.52  raeburn  1404:     my ($httphost) = @_;
1.949     droeschl 1405:     my $stayOnPage = 1;
1.436     albertel 1406:     my $width = 620;
                   1407:     my $height = 600;
1.430     albertel 1408:     my $helptopic=&general_help();
1.1075.2.52  raeburn  1409:     my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1410:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1411:     my $start_page =
                   1412:         &Apache::loncommon::start_page('Help Menu', undef,
                   1413: 				       {'frameset'    => 1,
                   1414: 					'js_ready'    => 1,
1.1075.2.136  raeburn  1415:                                         'use_absolute' => $httphost,
1.331     albertel 1416: 					'add_entries' => {
                   1417: 					    'border' => '0',
1.579     raeburn  1418: 					    'rows'   => "110,*",},});
1.331     albertel 1419:     my $end_page =
                   1420:         &Apache::loncommon::end_page({'frameset' => 1,
                   1421: 				      'js_ready' => 1,});
                   1422: 
1.436     albertel 1423:     my $template .= <<"ENDTEMPLATE";
                   1424: <script type="text/javascript">
1.877     bisitz   1425: // <![CDATA[
1.253     albertel 1426: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1427: var banner_link = '';
1.243     raeburn  1428: function helpMenu(target) {
                   1429:     var caller = this;
                   1430:     if (target == 'open') {
                   1431:         var newWindow = null;
                   1432:         try {
1.262     albertel 1433:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1434:         }
                   1435:         catch(error) {
                   1436:             writeHelp(caller);
                   1437:             return;
                   1438:         }
                   1439:         if (newWindow) {
                   1440:             caller = newWindow;
                   1441:         }
1.193     raeburn  1442:     }
1.243     raeburn  1443:     writeHelp(caller);
                   1444:     return;
                   1445: }
                   1446: function writeHelp(caller) {
1.1075.2.61  raeburn  1447:     caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
                   1448:     caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
                   1449:     caller.document.close();
                   1450:     caller.focus();
1.193     raeburn  1451: }
1.877     bisitz   1452: // END LON-CAPA Internal -->
1.253     albertel 1453: // ]]>
1.436     albertel 1454: </script>
1.193     raeburn  1455: ENDTEMPLATE
                   1456:     return $template;
                   1457: }
                   1458: 
1.172     www      1459: sub help_open_bug {
                   1460:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1461:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1462:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1463:     $text = "" if (not defined $text);
                   1464: 	$stayOnPage=1;
1.184     albertel 1465:     $width = 600 if (not defined $width);
                   1466:     $height = 600 if (not defined $height);
1.172     www      1467: 
                   1468:     $topic=~s/\W+/\+/g;
                   1469:     my $link='';
                   1470:     my $template='';
1.379     albertel 1471:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1472: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1473:     if (!$stayOnPage)
                   1474:     {
                   1475: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1476:     }
                   1477:     else
                   1478:     {
                   1479: 	$link = $url;
                   1480:     }
                   1481:     # Add the text
                   1482:     if ($text ne "")
                   1483:     {
                   1484: 	$template .= 
                   1485:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1486:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1487:     }
                   1488: 
                   1489:     # Add the graphic
1.179     matthew  1490:     my $title = &mt('Report a Bug');
1.215     albertel 1491:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1492:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1493:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1494: ENDTEMPLATE
                   1495:     if ($text ne '') { $template.='</td></tr></table>' };
                   1496:     return $template;
                   1497: 
                   1498: }
                   1499: 
                   1500: sub help_open_faq {
                   1501:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1502:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1503:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1504:     $text = "" if (not defined $text);
                   1505: 	$stayOnPage=1;
                   1506:     $width = 350 if (not defined $width);
                   1507:     $height = 400 if (not defined $height);
                   1508: 
                   1509:     $topic=~s/\W+/\+/g;
                   1510:     my $link='';
                   1511:     my $template='';
                   1512:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1513:     if (!$stayOnPage)
                   1514:     {
                   1515: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1516:     }
                   1517:     else
                   1518:     {
                   1519: 	$link = $url;
                   1520:     }
                   1521: 
                   1522:     # Add the text
                   1523:     if ($text ne "")
                   1524:     {
                   1525: 	$template .= 
1.173     www      1526:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1527:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1528:     }
                   1529: 
                   1530:     # Add the graphic
1.179     matthew  1531:     my $title = &mt('View the FAQ');
1.215     albertel 1532:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1533:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1534:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1535: ENDTEMPLATE
                   1536:     if ($text ne '') { $template.='</td></tr></table>' };
                   1537:     return $template;
                   1538: 
1.44      bowersj2 1539: }
1.37      matthew  1540: 
1.180     matthew  1541: ###############################################################
                   1542: ###############################################################
                   1543: 
1.45      matthew  1544: =pod
                   1545: 
1.648     raeburn  1546: =item * &change_content_javascript():
1.256     matthew  1547: 
                   1548: This and the next function allow you to create small sections of an
                   1549: otherwise static HTML page that you can update on the fly with
                   1550: Javascript, even in Netscape 4.
                   1551: 
                   1552: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1553: must be written to the HTML page once. It will prove the Javascript
                   1554: function "change(name, content)". Calling the change function with the
                   1555: name of the section 
                   1556: you want to update, matching the name passed to C<changable_area>, and
                   1557: the new content you want to put in there, will put the content into
                   1558: that area.
                   1559: 
                   1560: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1561: to contain room for the original contents. You need to "make space"
                   1562: for whatever changes you wish to make, and be B<sure> to check your
                   1563: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1564: it's adequate for updating a one-line status display, but little more.
                   1565: This script will set the space to 100% width, so you only need to
                   1566: worry about height in Netscape 4.
                   1567: 
                   1568: Modern browsers are much less limiting, and if you can commit to the
                   1569: user not using Netscape 4, this feature may be used freely with
                   1570: pretty much any HTML.
                   1571: 
                   1572: =cut
                   1573: 
                   1574: sub change_content_javascript {
                   1575:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1576:     if ($env{'browser.type'} eq 'netscape' &&
                   1577: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1578: 	return (<<NETSCAPE4);
                   1579: 	function change(name, content) {
                   1580: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1581: 	    doc.open();
                   1582: 	    doc.write(content);
                   1583: 	    doc.close();
                   1584: 	}
                   1585: NETSCAPE4
                   1586:     } else {
                   1587: 	# Otherwise, we need to use semi-standards-compliant code
                   1588: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1589: 	# is really scary, and every useful browser supports it
                   1590: 	return (<<DOMBASED);
                   1591: 	function change(name, content) {
                   1592: 	    element = document.getElementById(name);
                   1593: 	    element.innerHTML = content;
                   1594: 	}
                   1595: DOMBASED
                   1596:     }
                   1597: }
                   1598: 
                   1599: =pod
                   1600: 
1.648     raeburn  1601: =item * &changable_area($name,$origContent):
1.256     matthew  1602: 
                   1603: This provides a "changable area" that can be modified on the fly via
                   1604: the Javascript code provided in C<change_content_javascript>. $name is
                   1605: the name you will use to reference the area later; do not repeat the
                   1606: same name on a given HTML page more then once. $origContent is what
                   1607: the area will originally contain, which can be left blank.
                   1608: 
                   1609: =cut
                   1610: 
                   1611: sub changable_area {
                   1612:     my ($name, $origContent) = @_;
                   1613: 
1.258     albertel 1614:     if ($env{'browser.type'} eq 'netscape' &&
                   1615: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1616: 	# If this is netscape 4, we need to use the Layer tag
                   1617: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1618:     } else {
                   1619: 	return "<span id='$name'>$origContent</span>";
                   1620:     }
                   1621: }
                   1622: 
                   1623: =pod
                   1624: 
1.648     raeburn  1625: =item * &viewport_geometry_js 
1.590     raeburn  1626: 
                   1627: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1628: 
                   1629: =cut
                   1630: 
                   1631: 
                   1632: sub viewport_geometry_js { 
                   1633:     return <<"GEOMETRY";
                   1634: var Geometry = {};
                   1635: function init_geometry() {
                   1636:     if (Geometry.init) { return };
                   1637:     Geometry.init=1;
                   1638:     if (window.innerHeight) {
                   1639:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1640:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1641:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1642:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1643:     }
                   1644:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1645:         Geometry.getViewportHeight =
                   1646:             function() { return document.documentElement.clientHeight; };
                   1647:         Geometry.getViewportWidth =
                   1648:             function() { return document.documentElement.clientWidth; };
                   1649: 
                   1650:         Geometry.getHorizontalScroll =
                   1651:             function() { return document.documentElement.scrollLeft; };
                   1652:         Geometry.getVerticalScroll =
                   1653:             function() { return document.documentElement.scrollTop; };
                   1654:     }
                   1655:     else if (document.body.clientHeight) {
                   1656:         Geometry.getViewportHeight =
                   1657:             function() { return document.body.clientHeight; };
                   1658:         Geometry.getViewportWidth =
                   1659:             function() { return document.body.clientWidth; };
                   1660:         Geometry.getHorizontalScroll =
                   1661:             function() { return document.body.scrollLeft; };
                   1662:         Geometry.getVerticalScroll =
                   1663:             function() { return document.body.scrollTop; };
                   1664:     }
                   1665: }
                   1666: 
                   1667: GEOMETRY
                   1668: }
                   1669: 
                   1670: =pod
                   1671: 
1.648     raeburn  1672: =item * &viewport_size_js()
1.590     raeburn  1673: 
                   1674: 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. 
                   1675: 
                   1676: =cut
                   1677: 
                   1678: sub viewport_size_js {
                   1679:     my $geometry = &viewport_geometry_js();
                   1680:     return <<"DIMS";
                   1681: 
                   1682: $geometry
                   1683: 
                   1684: function getViewportDims(width,height) {
                   1685:     init_geometry();
                   1686:     width.value = Geometry.getViewportWidth();
                   1687:     height.value = Geometry.getViewportHeight();
                   1688:     return;
                   1689: }
                   1690: 
                   1691: DIMS
                   1692: }
                   1693: 
                   1694: =pod
                   1695: 
1.648     raeburn  1696: =item * &resize_textarea_js()
1.565     albertel 1697: 
                   1698: emits the needed javascript to resize a textarea to be as big as possible
                   1699: 
                   1700: creates a function resize_textrea that takes two IDs first should be
                   1701: the id of the element to resize, second should be the id of a div that
                   1702: surrounds everything that comes after the textarea, this routine needs
                   1703: to be attached to the <body> for the onload and onresize events.
                   1704: 
1.648     raeburn  1705: =back
1.565     albertel 1706: 
                   1707: =cut
                   1708: 
                   1709: sub resize_textarea_js {
1.590     raeburn  1710:     my $geometry = &viewport_geometry_js();
1.565     albertel 1711:     return <<"RESIZE";
                   1712:     <script type="text/javascript">
1.824     bisitz   1713: // <![CDATA[
1.590     raeburn  1714: $geometry
1.565     albertel 1715: 
1.588     albertel 1716: function getX(element) {
                   1717:     var x = 0;
                   1718:     while (element) {
                   1719: 	x += element.offsetLeft;
                   1720: 	element = element.offsetParent;
                   1721:     }
                   1722:     return x;
                   1723: }
                   1724: function getY(element) {
                   1725:     var y = 0;
                   1726:     while (element) {
                   1727: 	y += element.offsetTop;
                   1728: 	element = element.offsetParent;
                   1729:     }
                   1730:     return y;
                   1731: }
                   1732: 
                   1733: 
1.565     albertel 1734: function resize_textarea(textarea_id,bottom_id) {
                   1735:     init_geometry();
                   1736:     var textarea        = document.getElementById(textarea_id);
                   1737:     //alert(textarea);
                   1738: 
1.588     albertel 1739:     var textarea_top    = getY(textarea);
1.565     albertel 1740:     var textarea_height = textarea.offsetHeight;
                   1741:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1742:     var bottom_top      = getY(bottom);
1.565     albertel 1743:     var bottom_height   = bottom.offsetHeight;
                   1744:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1745:     var fudge           = 23;
1.565     albertel 1746:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1747:     if (new_height < 300) {
                   1748: 	new_height = 300;
                   1749:     }
                   1750:     textarea.style.height=new_height+'px';
                   1751: }
1.824     bisitz   1752: // ]]>
1.565     albertel 1753: </script>
                   1754: RESIZE
                   1755: 
                   1756: }
                   1757: 
1.1075.2.112  raeburn  1758: sub colorfuleditor_js {
                   1759:     return <<"COLORFULEDIT"
                   1760: <script type="text/javascript">
                   1761: // <![CDATA[>
                   1762:     function fold_box(curDepth, lastresource){
                   1763: 
                   1764:     // we need a list because there can be several blocks you need to fold in one tag
                   1765:         var block = document.getElementsByName('foldblock_'+curDepth);
                   1766:     // but there is only one folding button per tag
                   1767:         var foldbutton = document.getElementById('folding_btn_'+curDepth);
                   1768: 
                   1769:         if(block.item(0).style.display == 'none'){
                   1770: 
                   1771:             foldbutton.value = '@{[&mt("Hide")]}';
                   1772:             for (i = 0; i < block.length; i++){
                   1773:                 block.item(i).style.display = '';
                   1774:             }
                   1775:         }else{
                   1776: 
                   1777:             foldbutton.value = '@{[&mt("Show")]}';
                   1778:             for (i = 0; i < block.length; i++){
                   1779:                 // block.item(i).style.visibility = 'collapse';
                   1780:                 block.item(i).style.display = 'none';
                   1781:             }
                   1782:         };
                   1783:         saveState(lastresource);
                   1784:     }
                   1785: 
                   1786:     function saveState (lastresource) {
                   1787: 
                   1788:         var tag_list = getTagList();
                   1789:         if(tag_list != null){
                   1790:             var timestamp = new Date().getTime();
                   1791:             var key = lastresource;
                   1792: 
                   1793:             // the value pattern is: 'time;key1,value1;key2,value2; ... '
                   1794:             // starting with timestamp
                   1795:             var value = timestamp+';';
                   1796: 
                   1797:             // building the list of key-value pairs
                   1798:             for(var i = 0; i < tag_list.length; i++){
                   1799:                 value += tag_list[i]+',';
                   1800:                 value += document.getElementsByName(tag_list[i])[0].style.display+';';
                   1801:             }
                   1802: 
                   1803:             // only iterate whole storage if nothing to override
                   1804:             if(localStorage.getItem(key) == null){
                   1805: 
                   1806:                 // prevent storage from growing large
                   1807:                 if(localStorage.length > 50){
                   1808:                     var regex_getTimestamp = /^(?:\d)+;/;
                   1809:                     var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
                   1810:                     var oldest_key;
                   1811: 
                   1812:                     for(var i = 1; i < localStorage.length; i++){
                   1813:                         if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
                   1814:                             oldest_key = localStorage.key(i);
                   1815:                             oldest_timestamp = regex_getTimestamp.exec(oldest_key);
                   1816:                         }
                   1817:                     }
                   1818:                     localStorage.removeItem(oldest_key);
                   1819:                 }
                   1820:             }
                   1821:             localStorage.setItem(key,value);
                   1822:         }
                   1823:     }
                   1824: 
                   1825:     // restore folding status of blocks (on page load)
                   1826:     function restoreState (lastresource) {
                   1827:         if(localStorage.getItem(lastresource) != null){
                   1828:             var key = lastresource;
                   1829:             var value = localStorage.getItem(key);
                   1830:             var regex_delTimestamp = /^\d+;/;
                   1831: 
                   1832:             value.replace(regex_delTimestamp, '');
                   1833: 
                   1834:             var valueArr = value.split(';');
                   1835:             var pairs;
                   1836:             var elements;
                   1837:             for (var i = 0; i < valueArr.length; i++){
                   1838:                 pairs = valueArr[i].split(',');
                   1839:                 elements = document.getElementsByName(pairs[0]);
                   1840: 
                   1841:                 for (var j = 0; j < elements.length; j++){
                   1842:                     elements[j].style.display = pairs[1];
                   1843:                     if (pairs[1] == "none"){
                   1844:                         var regex_id = /([_\\d]+)\$/;
                   1845:                         regex_id.exec(pairs[0]);
                   1846:                         document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
                   1847:                     }
                   1848:                 }
                   1849:             }
                   1850:         }
                   1851:     }
                   1852: 
                   1853:     function getTagList () {
                   1854: 
                   1855:         var stringToSearch = document.lonhomework.innerHTML;
                   1856: 
                   1857:         var ret = new Array();
                   1858:         var regex_findBlock = /(foldblock_.*?)"/g;
                   1859:         var tag_list = stringToSearch.match(regex_findBlock);
                   1860: 
                   1861:         if(tag_list != null){
                   1862:             for(var i = 0; i < tag_list.length; i++){
                   1863:                 ret.push(tag_list[i].replace(/"/, ''));
                   1864:             }
                   1865:         }
                   1866:         return ret;
                   1867:     }
                   1868: 
                   1869:     function saveScrollPosition (resource) {
                   1870:         var tag_list = getTagList();
                   1871: 
                   1872:         // we dont always want to jump to the first block
                   1873:         // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
                   1874:         if(\$(window).scrollTop() > 170){
                   1875:             if(tag_list != null){
                   1876:                 var result;
                   1877:                 for(var i = 0; i < tag_list.length; i++){
                   1878:                     if(isElementInViewport(tag_list[i])){
                   1879:                         result += tag_list[i]+';';
                   1880:                     }
                   1881:                 }
                   1882:                 sessionStorage.setItem('anchor_'+resource, result);
                   1883:             }
                   1884:         } else {
                   1885:             // we dont need to save zero, just delete the item to leave everything tidy
                   1886:             sessionStorage.removeItem('anchor_'+resource);
                   1887:         }
                   1888:     }
                   1889: 
                   1890:     function restoreScrollPosition(resource){
                   1891: 
                   1892:         var elem = sessionStorage.getItem('anchor_'+resource);
                   1893:         if(elem != null){
                   1894:             var tag_list = elem.split(';');
                   1895:             var elem_list;
                   1896: 
                   1897:             for(var i = 0; i < tag_list.length; i++){
                   1898:                 elem_list = document.getElementsByName(tag_list[i]);
                   1899: 
                   1900:                 if(elem_list.length > 0){
                   1901:                     elem = elem_list[0];
                   1902:                     break;
                   1903:                 }
                   1904:             }
                   1905:             elem.scrollIntoView();
                   1906:         }
                   1907:     }
                   1908: 
                   1909:     function isElementInViewport(el) {
                   1910: 
                   1911:         // change to last element instead of first
                   1912:         var elem = document.getElementsByName(el);
                   1913:         var rect = elem[0].getBoundingClientRect();
                   1914: 
                   1915:         return (
                   1916:             rect.top >= 0 &&
                   1917:             rect.left >= 0 &&
                   1918:             rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
                   1919:             rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
                   1920:         );
                   1921:     }
                   1922: 
                   1923:     function autosize(depth){
                   1924:         var cmInst = window['cm'+depth];
                   1925:         var fitsizeButton = document.getElementById('fitsize'+depth);
                   1926: 
                   1927:         // is fixed size, switching to dynamic
                   1928:         if (sessionStorage.getItem("autosized_"+depth) == null) {
                   1929:             cmInst.setSize("","auto");
                   1930:             fitsizeButton.value = "@{[&mt('Fixed size')]}";
                   1931:             sessionStorage.setItem("autosized_"+depth, "yes");
                   1932: 
                   1933:         // is dynamic size, switching to fixed
                   1934:         } else {
                   1935:             cmInst.setSize("","300px");
                   1936:             fitsizeButton.value = "@{[&mt('Dynamic size')]}";
                   1937:             sessionStorage.removeItem("autosized_"+depth);
                   1938:         }
                   1939:     }
                   1940: 
                   1941: 
                   1942: 
                   1943: // ]]>
                   1944: </script>
                   1945: COLORFULEDIT
                   1946: }
                   1947: 
                   1948: sub xmleditor_js {
                   1949:     return <<XMLEDIT
                   1950: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
                   1951: <script type="text/javascript">
                   1952: // <![CDATA[>
                   1953: 
                   1954:     function saveScrollPosition (resource) {
                   1955: 
                   1956:         var scrollPos = \$(window).scrollTop();
                   1957:         sessionStorage.setItem(resource,scrollPos);
                   1958:     }
                   1959: 
                   1960:     function restoreScrollPosition(resource){
                   1961: 
                   1962:         var scrollPos = sessionStorage.getItem(resource);
                   1963:         \$(window).scrollTop(scrollPos);
                   1964:     }
                   1965: 
                   1966:     // unless internet explorer
                   1967:     if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
                   1968: 
                   1969:         \$(document).ready(function() {
                   1970:              \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
                   1971:         });
                   1972:     }
                   1973: 
                   1974:     // inserts text at cursor position into codemirror (xml editor only)
                   1975:     function insertText(text){
                   1976:         cm.focus();
                   1977:         var curPos = cm.getCursor();
                   1978:         cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
                   1979:     }
                   1980: // ]]>
                   1981: </script>
                   1982: XMLEDIT
                   1983: }
                   1984: 
                   1985: sub insert_folding_button {
                   1986:     my $curDepth = $Apache::lonxml::curdepth;
                   1987:     my $lastresource = $env{'request.ambiguous'};
                   1988: 
                   1989:     return "<input type=\"button\" id=\"folding_btn_$curDepth\"
                   1990:             value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
                   1991: }
                   1992: 
                   1993: 
1.565     albertel 1994: =pod
                   1995: 
1.256     matthew  1996: =head1 Excel and CSV file utility routines
                   1997: 
                   1998: =cut
                   1999: 
                   2000: ###############################################################
                   2001: ###############################################################
                   2002: 
                   2003: =pod
                   2004: 
1.1075.2.56  raeburn  2005: =over 4
                   2006: 
1.648     raeburn  2007: =item * &csv_translate($text) 
1.37      matthew  2008: 
1.185     www      2009: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  2010: format.
                   2011: 
                   2012: =cut
                   2013: 
1.180     matthew  2014: ###############################################################
                   2015: ###############################################################
1.37      matthew  2016: sub csv_translate {
                   2017:     my $text = shift;
                   2018:     $text =~ s/\"/\"\"/g;
1.209     albertel 2019:     $text =~ s/\n/ /g;
1.37      matthew  2020:     return $text;
                   2021: }
1.180     matthew  2022: 
                   2023: ###############################################################
                   2024: ###############################################################
                   2025: 
                   2026: =pod
                   2027: 
1.648     raeburn  2028: =item * &define_excel_formats()
1.180     matthew  2029: 
                   2030: Define some commonly used Excel cell formats.
                   2031: 
                   2032: Currently supported formats:
                   2033: 
                   2034: =over 4
                   2035: 
                   2036: =item header
                   2037: 
                   2038: =item bold
                   2039: 
                   2040: =item h1
                   2041: 
                   2042: =item h2
                   2043: 
                   2044: =item h3
                   2045: 
1.256     matthew  2046: =item h4
                   2047: 
                   2048: =item i
                   2049: 
1.180     matthew  2050: =item date
                   2051: 
                   2052: =back
                   2053: 
                   2054: Inputs: $workbook
                   2055: 
                   2056: Returns: $format, a hash reference.
                   2057: 
1.1057    foxr     2058: 
1.180     matthew  2059: =cut
                   2060: 
                   2061: ###############################################################
                   2062: ###############################################################
                   2063: sub define_excel_formats {
                   2064:     my ($workbook) = @_;
                   2065:     my $format;
                   2066:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   2067:                                                 bottom    => 1,
                   2068:                                                 align     => 'center');
                   2069:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   2070:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   2071:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   2072:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  2073:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  2074:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  2075:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  2076:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  2077:     return $format;
                   2078: }
                   2079: 
                   2080: ###############################################################
                   2081: ###############################################################
1.113     bowersj2 2082: 
                   2083: =pod
                   2084: 
1.648     raeburn  2085: =item * &create_workbook()
1.255     matthew  2086: 
                   2087: Create an Excel worksheet.  If it fails, output message on the
                   2088: request object and return undefs.
                   2089: 
                   2090: Inputs: Apache request object
                   2091: 
                   2092: Returns (undef) on failure, 
                   2093:     Excel worksheet object, scalar with filename, and formats 
                   2094:     from &Apache::loncommon::define_excel_formats on success
                   2095: 
                   2096: =cut
                   2097: 
                   2098: ###############################################################
                   2099: ###############################################################
                   2100: sub create_workbook {
                   2101:     my ($r) = @_;
                   2102:         #
                   2103:     # Create the excel spreadsheet
                   2104:     my $filename = '/prtspool/'.
1.258     albertel 2105:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  2106:         time.'_'.rand(1000000000).'.xls';
                   2107:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   2108:     if (! defined($workbook)) {
                   2109:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   2110:         $r->print(
                   2111:             '<p class="LC_error">'
                   2112:            .&mt('Problems occurred in creating the new Excel file.')
                   2113:            .' '.&mt('This error has been logged.')
                   2114:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2115:            .'</p>'
                   2116:         );
1.255     matthew  2117:         return (undef);
                   2118:     }
                   2119:     #
1.1014    foxr     2120:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  2121:     #
                   2122:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   2123:     return ($workbook,$filename,$format);
                   2124: }
                   2125: 
                   2126: ###############################################################
                   2127: ###############################################################
                   2128: 
                   2129: =pod
                   2130: 
1.648     raeburn  2131: =item * &create_text_file()
1.113     bowersj2 2132: 
1.542     raeburn  2133: Create a file to write to and eventually make available to the user.
1.256     matthew  2134: If file creation fails, outputs an error message on the request object and 
                   2135: return undefs.
1.113     bowersj2 2136: 
1.256     matthew  2137: Inputs: Apache request object, and file suffix
1.113     bowersj2 2138: 
1.256     matthew  2139: Returns (undef) on failure, 
                   2140:     Filehandle and filename on success.
1.113     bowersj2 2141: 
                   2142: =cut
                   2143: 
1.256     matthew  2144: ###############################################################
                   2145: ###############################################################
                   2146: sub create_text_file {
                   2147:     my ($r,$suffix) = @_;
                   2148:     if (! defined($suffix)) { $suffix = 'txt'; };
                   2149:     my $fh;
                   2150:     my $filename = '/prtspool/'.
1.258     albertel 2151:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  2152:         time.'_'.rand(1000000000).'.'.$suffix;
                   2153:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   2154:     if (! defined($fh)) {
                   2155:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   2156:         $r->print(
                   2157:             '<p class="LC_error">'
                   2158:            .&mt('Problems occurred in creating the output file.')
                   2159:            .' '.&mt('This error has been logged.')
                   2160:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2161:            .'</p>'
                   2162:         );
1.113     bowersj2 2163:     }
1.256     matthew  2164:     return ($fh,$filename)
1.113     bowersj2 2165: }
                   2166: 
                   2167: 
1.256     matthew  2168: =pod 
1.113     bowersj2 2169: 
                   2170: =back
                   2171: 
                   2172: =cut
1.37      matthew  2173: 
                   2174: ###############################################################
1.33      matthew  2175: ##        Home server <option> list generating code          ##
                   2176: ###############################################################
1.35      matthew  2177: 
1.169     www      2178: # ------------------------------------------
                   2179: 
                   2180: sub domain_select {
                   2181:     my ($name,$value,$multiple)=@_;
                   2182:     my %domains=map { 
1.514     albertel 2183: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 2184:     } &Apache::lonnet::all_domains();
1.169     www      2185:     if ($multiple) {
                   2186: 	$domains{''}=&mt('Any domain');
1.550     albertel 2187: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 2188: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      2189:     } else {
1.550     albertel 2190: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  2191: 	return &select_form($name,$value,\%domains);
1.169     www      2192:     }
                   2193: }
                   2194: 
1.282     albertel 2195: #-------------------------------------------
                   2196: 
                   2197: =pod
                   2198: 
1.519     raeburn  2199: =head1 Routines for form select boxes
                   2200: 
                   2201: =over 4
                   2202: 
1.648     raeburn  2203: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 2204: 
                   2205: Returns a string containing a <select> element int multiple mode
                   2206: 
                   2207: 
                   2208: Args:
                   2209:   $name - name of the <select> element
1.506     raeburn  2210:   $value - scalar or array ref of values that should already be selected
1.282     albertel 2211:   $size - number of rows long the select element is
1.283     albertel 2212:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 2213:           (shown text should already have been &mt())
1.506     raeburn  2214:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 2215: 
1.282     albertel 2216: =cut
                   2217: 
                   2218: #-------------------------------------------
1.169     www      2219: sub multiple_select_form {
1.284     albertel 2220:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      2221:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   2222:     my $output='';
1.191     matthew  2223:     if (! defined($size)) {
                   2224:         $size = 4;
1.283     albertel 2225:         if (scalar(keys(%$hash))<4) {
                   2226:             $size = scalar(keys(%$hash));
1.191     matthew  2227:         }
                   2228:     }
1.734     bisitz   2229:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 2230:     my @order;
1.506     raeburn  2231:     if (ref($order) eq 'ARRAY')  {
                   2232:         @order = @{$order};
                   2233:     } else {
                   2234:         @order = sort(keys(%$hash));
1.501     banghart 2235:     }
                   2236:     if (exists($$hash{'select_form_order'})) {
                   2237:         @order = @{$$hash{'select_form_order'}};
                   2238:     }
                   2239:         
1.284     albertel 2240:     foreach my $key (@order) {
1.356     albertel 2241:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 2242:         $output.='selected="selected" ' if ($selected{$key});
                   2243:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      2244:     }
                   2245:     $output.="</select>\n";
                   2246:     return $output;
                   2247: }
                   2248: 
1.88      www      2249: #-------------------------------------------
                   2250: 
                   2251: =pod
                   2252: 
1.1075.2.115  raeburn  2253: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88      www      2254: 
                   2255: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  2256: allow a user to select options from a ref to a hash containing:
                   2257: option_name => displayed text. An optional $onchange can include
1.1075.2.115  raeburn  2258: a javascript onchange item, e.g., onchange="this.form.submit();".
                   2259: An optional arg -- $readonly -- if true will cause the select form
                   2260: to be disabled, e.g., for the case where an instructor has a section-
                   2261: specific role, and is viewing/modifying parameters.  
1.970     raeburn  2262: 
1.88      www      2263: See lonrights.pm for an example invocation and use.
                   2264: 
                   2265: =cut
                   2266: 
                   2267: #-------------------------------------------
                   2268: sub select_form {
1.1075.2.115  raeburn  2269:     my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970     raeburn  2270:     return unless (ref($hashref) eq 'HASH');
                   2271:     if ($onchange) {
                   2272:         $onchange = ' onchange="'.$onchange.'"';
                   2273:     }
1.1075.2.129  raeburn  2274:     my $disabled;
                   2275:     if ($readonly) {
                   2276:         $disabled = ' disabled="disabled"';
                   2277:     }
                   2278:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128     albertel 2279:     my @keys;
1.970     raeburn  2280:     if (exists($hashref->{'select_form_order'})) {
                   2281: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 2282:     } else {
1.970     raeburn  2283: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 2284:     }
1.356     albertel 2285:     foreach my $key (@keys) {
                   2286:         $selectform.=
                   2287: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   2288:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  2289:                 ">".$hashref->{$key}."</option>\n";
1.88      www      2290:     }
                   2291:     $selectform.="</select>";
                   2292:     return $selectform;
                   2293: }
                   2294: 
1.475     www      2295: # For display filters
                   2296: 
                   2297: sub display_filter {
1.1074    raeburn  2298:     my ($context) = @_;
1.475     www      2299:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      2300:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074    raeburn  2301:     my $phraseinput = 'hidden';
                   2302:     my $includeinput = 'hidden';
                   2303:     my ($checked,$includetypestext);
                   2304:     if ($env{'form.displayfilter'} eq 'containing') {
                   2305:         $phraseinput = 'text'; 
                   2306:         if ($context eq 'parmslog') {
                   2307:             $includeinput = 'checkbox';
                   2308:             if ($env{'form.includetypes'}) {
                   2309:                 $checked = ' checked="checked"';
                   2310:             }
                   2311:             $includetypestext = &mt('Include parameter types');
                   2312:         }
                   2313:     } else {
                   2314:         $includetypestext = '&nbsp;';
                   2315:     }
                   2316:     my ($additional,$secondid,$thirdid);
                   2317:     if ($context eq 'parmslog') {
                   2318:         $additional = 
                   2319:             '<label><input type="'.$includeinput.'" name="includetypes"'. 
                   2320:             $checked.' name="includetypes" value="1" id="includetypes" />'.
                   2321:             '&nbsp;<span id="includetypestext">'.$includetypestext.'</span>'.
                   2322:             '</label>';
                   2323:         $secondid = 'includetypes';
                   2324:         $thirdid = 'includetypestext';
                   2325:     }
                   2326:     my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
                   2327:                                                     '$secondid','$thirdid')";
                   2328:     return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.475     www      2329: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   2330: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   2331: 	   '</label></span> <span class="LC_nobreak">'.
1.1074    raeburn  2332:            &mt('Filter: [_1]',
1.477     www      2333: 	   &select_form($env{'form.displayfilter'},
                   2334: 			'displayfilter',
1.970     raeburn  2335: 			{'currentfolder' => 'Current folder/page',
1.477     www      2336: 			 'containing' => 'Containing phrase',
1.1074    raeburn  2337: 			 'none' => 'None'},$onchange)).'&nbsp;'.
                   2338: 			 '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
                   2339:                          &HTML::Entities::encode($env{'form.containingphrase'}).
                   2340:                          '" />'.$additional;
                   2341: }
                   2342: 
                   2343: sub display_filter_js {
                   2344:     my $includetext = &mt('Include parameter types');
                   2345:     return <<"ENDJS";
                   2346:   
                   2347: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
                   2348:     var firstType = 'hidden';
                   2349:     if (setter.options[setter.selectedIndex].value == 'containing') {
                   2350:         firstType = 'text';
                   2351:     }
                   2352:     firstObject = document.getElementById(firstid);
                   2353:     if (typeof(firstObject) == 'object') {
                   2354:         if (firstObject.type != firstType) {
                   2355:             changeInputType(firstObject,firstType);
                   2356:         }
                   2357:     }
                   2358:     if (context == 'parmslog') {
                   2359:         var secondType = 'hidden';
                   2360:         if (firstType == 'text') {
                   2361:             secondType = 'checkbox';
                   2362:         }
                   2363:         secondObject = document.getElementById(secondid);  
                   2364:         if (typeof(secondObject) == 'object') {
                   2365:             if (secondObject.type != secondType) {
                   2366:                 changeInputType(secondObject,secondType);
                   2367:             }
                   2368:         }
                   2369:         var textItem = document.getElementById(thirdid);
                   2370:         var currtext = textItem.innerHTML;
                   2371:         var newtext;
                   2372:         if (firstType == 'text') {
                   2373:             newtext = '$includetext';
                   2374:         } else {
                   2375:             newtext = '&nbsp;';
                   2376:         }
                   2377:         if (currtext != newtext) {
                   2378:             textItem.innerHTML = newtext;
                   2379:         }
                   2380:     }
                   2381:     return;
                   2382: }
                   2383: 
                   2384: function changeInputType(oldObject,newType) {
                   2385:     var newObject = document.createElement('input');
                   2386:     newObject.type = newType;
                   2387:     if (oldObject.size) {
                   2388:         newObject.size = oldObject.size;
                   2389:     }
                   2390:     if (oldObject.value) {
                   2391:         newObject.value = oldObject.value;
                   2392:     }
                   2393:     if (oldObject.name) {
                   2394:         newObject.name = oldObject.name;
                   2395:     }
                   2396:     if (oldObject.id) {
                   2397:         newObject.id = oldObject.id;
                   2398:     }
                   2399:     oldObject.parentNode.replaceChild(newObject,oldObject);
                   2400:     return;
                   2401: }
                   2402: 
                   2403: ENDJS
1.475     www      2404: }
                   2405: 
1.167     www      2406: sub gradeleveldescription {
                   2407:     my $gradelevel=shift;
                   2408:     my %gradelevels=(0 => 'Not specified',
                   2409: 		     1 => 'Grade 1',
                   2410: 		     2 => 'Grade 2',
                   2411: 		     3 => 'Grade 3',
                   2412: 		     4 => 'Grade 4',
                   2413: 		     5 => 'Grade 5',
                   2414: 		     6 => 'Grade 6',
                   2415: 		     7 => 'Grade 7',
                   2416: 		     8 => 'Grade 8',
                   2417: 		     9 => 'Grade 9',
                   2418: 		     10 => 'Grade 10',
                   2419: 		     11 => 'Grade 11',
                   2420: 		     12 => 'Grade 12',
                   2421: 		     13 => 'Grade 13',
                   2422: 		     14 => '100 Level',
                   2423: 		     15 => '200 Level',
                   2424: 		     16 => '300 Level',
                   2425: 		     17 => '400 Level',
                   2426: 		     18 => 'Graduate Level');
                   2427:     return &mt($gradelevels{$gradelevel});
                   2428: }
                   2429: 
1.163     www      2430: sub select_level_form {
                   2431:     my ($deflevel,$name)=@_;
                   2432:     unless ($deflevel) { $deflevel=0; }
1.167     www      2433:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   2434:     for (my $i=0; $i<=18; $i++) {
                   2435:         $selectform.="<option value=\"$i\" ".
1.253     albertel 2436:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      2437:                 ">".&gradeleveldescription($i)."</option>\n";
                   2438:     }
                   2439:     $selectform.="</select>";
                   2440:     return $selectform;
1.163     www      2441: }
1.167     www      2442: 
1.35      matthew  2443: #-------------------------------------------
                   2444: 
1.45      matthew  2445: =pod
                   2446: 
1.1075.2.115  raeburn  2447: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35      matthew  2448: 
                   2449: Returns a string containing a <select name='$name' size='1'> form to 
                   2450: allow a user to select the domain to preform an operation in.  
                   2451: See loncreateuser.pm for an example invocation and use.
                   2452: 
1.90      www      2453: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   2454: selected");
                   2455: 
1.743     raeburn  2456: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   2457: 
1.910     raeburn  2458: 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.
                   2459: 
1.1075.2.36  raeburn  2460: The optional $incdoms is a reference to an array of domains which will be the only available options.
                   2461: 
1.1075.2.115  raeburn  2462: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
                   2463: 
                   2464: The optional $disabled argument, if true, adds the disabled attribute to the select tag. 
1.563     raeburn  2465: 
1.35      matthew  2466: =cut
                   2467: 
                   2468: #-------------------------------------------
1.34      matthew  2469: sub select_dom_form {
1.1075.2.115  raeburn  2470:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872     raeburn  2471:     if ($onchange) {
1.874     raeburn  2472:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  2473:     }
1.1075.2.115  raeburn  2474:     if ($disabled) {
                   2475:         $disabled = ' disabled="disabled"';
                   2476:     }
1.1075.2.36  raeburn  2477:     my (@domains,%exclude);
1.910     raeburn  2478:     if (ref($incdoms) eq 'ARRAY') {
                   2479:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   2480:     } else {
                   2481:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   2482:     }
1.90      www      2483:     if ($includeempty) { @domains=('',@domains); }
1.1075.2.36  raeburn  2484:     if (ref($excdoms) eq 'ARRAY') {
                   2485:         map { $exclude{$_} = 1; } @{$excdoms};
                   2486:     }
1.1075.2.115  raeburn  2487:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356     albertel 2488:     foreach my $dom (@domains) {
1.1075.2.36  raeburn  2489:         next if ($exclude{$dom});
1.356     albertel 2490:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  2491:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   2492:         if ($showdomdesc) {
                   2493:             if ($dom ne '') {
                   2494:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   2495:                 if ($domdesc ne '') {
                   2496:                     $selectdomain .= ' ('.$domdesc.')';
                   2497:                 }
                   2498:             } 
                   2499:         }
                   2500:         $selectdomain .= "</option>\n";
1.34      matthew  2501:     }
                   2502:     $selectdomain.="</select>";
                   2503:     return $selectdomain;
                   2504: }
                   2505: 
1.35      matthew  2506: #-------------------------------------------
                   2507: 
1.45      matthew  2508: =pod
                   2509: 
1.648     raeburn  2510: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  2511: 
1.586     raeburn  2512: input: 4 arguments (two required, two optional) - 
                   2513:     $domain - domain of new user
                   2514:     $name - name of form element
                   2515:     $default - Value of 'default' causes a default item to be first 
                   2516:                             option, and selected by default. 
                   2517:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2518:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2519: output: returns 2 items: 
1.586     raeburn  2520: (a) form element which contains either:
                   2521:    (i) <select name="$name">
                   2522:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2523:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2524:        </select>
                   2525:        form item if there are multiple library servers in $domain, or
                   2526:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2527:        if there is only one library server in $domain.
                   2528: 
                   2529: (b) number of library servers found.
                   2530: 
                   2531: See loncreateuser.pm for example of use.
1.35      matthew  2532: 
                   2533: =cut
                   2534: 
                   2535: #-------------------------------------------
1.586     raeburn  2536: sub home_server_form_item {
                   2537:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2538:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2539:     my $result;
                   2540:     my $numlib = keys(%servers);
                   2541:     if ($numlib > 1) {
                   2542:         $result .= '<select name="'.$name.'" />'."\n";
                   2543:         if ($default) {
1.804     bisitz   2544:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2545:                        '</option>'."\n";
                   2546:         }
                   2547:         foreach my $hostid (sort(keys(%servers))) {
                   2548:             $result.= '<option value="'.$hostid.'">'.
                   2549: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2550:         }
                   2551:         $result .= '</select>'."\n";
                   2552:     } elsif ($numlib == 1) {
                   2553:         my $hostid;
                   2554:         foreach my $item (keys(%servers)) {
                   2555:             $hostid = $item;
                   2556:         }
                   2557:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2558:                    $hostid.'" />';
                   2559:                    if (!$hide) {
                   2560:                        $result .= $hostid.' '.$servers{$hostid};
                   2561:                    }
                   2562:                    $result .= "\n";
                   2563:     } elsif ($default) {
                   2564:         $result .= '<input type="hidden" name="'.$name.
                   2565:                    '" value="default" />';
                   2566:                    if (!$hide) {
                   2567:                        $result .= &mt('default');
                   2568:                    }
                   2569:                    $result .= "\n";
1.33      matthew  2570:     }
1.586     raeburn  2571:     return ($result,$numlib);
1.33      matthew  2572: }
1.112     bowersj2 2573: 
                   2574: =pod
                   2575: 
1.534     albertel 2576: =back 
                   2577: 
1.112     bowersj2 2578: =cut
1.87      matthew  2579: 
                   2580: ###############################################################
1.112     bowersj2 2581: ##                  Decoding User Agent                      ##
1.87      matthew  2582: ###############################################################
                   2583: 
                   2584: =pod
                   2585: 
1.112     bowersj2 2586: =head1 Decoding the User Agent
                   2587: 
                   2588: =over 4
                   2589: 
                   2590: =item * &decode_user_agent()
1.87      matthew  2591: 
                   2592: Inputs: $r
                   2593: 
                   2594: Outputs:
                   2595: 
                   2596: =over 4
                   2597: 
1.112     bowersj2 2598: =item * $httpbrowser
1.87      matthew  2599: 
1.112     bowersj2 2600: =item * $clientbrowser
1.87      matthew  2601: 
1.112     bowersj2 2602: =item * $clientversion
1.87      matthew  2603: 
1.112     bowersj2 2604: =item * $clientmathml
1.87      matthew  2605: 
1.112     bowersj2 2606: =item * $clientunicode
1.87      matthew  2607: 
1.112     bowersj2 2608: =item * $clientos
1.87      matthew  2609: 
1.1075.2.42  raeburn  2610: =item * $clientmobile
                   2611: 
                   2612: =item * $clientinfo
                   2613: 
1.1075.2.77  raeburn  2614: =item * $clientosversion
                   2615: 
1.87      matthew  2616: =back
                   2617: 
1.157     matthew  2618: =back 
                   2619: 
1.87      matthew  2620: =cut
                   2621: 
                   2622: ###############################################################
                   2623: ###############################################################
                   2624: sub decode_user_agent {
1.247     albertel 2625:     my ($r)=@_;
1.87      matthew  2626:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2627:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2628:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2629:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2630:     my $clientbrowser='unknown';
                   2631:     my $clientversion='0';
                   2632:     my $clientmathml='';
                   2633:     my $clientunicode='0';
1.1075.2.42  raeburn  2634:     my $clientmobile=0;
1.1075.2.77  raeburn  2635:     my $clientosversion='';
1.87      matthew  2636:     for (my $i=0;$i<=$#browsertype;$i++) {
1.1075.2.76  raeburn  2637:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87      matthew  2638: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2639: 	    $clientbrowser=$bname;
                   2640:             $httpbrowser=~/$vreg/i;
                   2641: 	    $clientversion=$1;
                   2642:             $clientmathml=($clientversion>=$minv);
                   2643:             $clientunicode=($clientversion>=$univ);
                   2644: 	}
                   2645:     }
                   2646:     my $clientos='unknown';
1.1075.2.42  raeburn  2647:     my $clientinfo;
1.87      matthew  2648:     if (($httpbrowser=~/linux/i) ||
                   2649:         ($httpbrowser=~/unix/i) ||
                   2650:         ($httpbrowser=~/ux/i) ||
                   2651:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2652:     if (($httpbrowser=~/vax/i) ||
                   2653:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2654:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2655:     if (($httpbrowser=~/mac/i) ||
                   2656:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1075.2.77  raeburn  2657:     if ($httpbrowser=~/win/i) {
                   2658:         $clientos='win';
                   2659:         if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
                   2660:             $clientosversion = $1;
                   2661:         }
                   2662:     }
1.87      matthew  2663:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1075.2.42  raeburn  2664:     if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
                   2665:         $clientmobile=lc($1);
                   2666:     }
                   2667:     if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
                   2668:         $clientinfo = 'firefox-'.$1;
                   2669:     } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
                   2670:         $clientinfo = 'chromeframe-'.$1;
                   2671:     }
1.87      matthew  2672:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1075.2.77  raeburn  2673:             $clientunicode,$clientos,$clientmobile,$clientinfo,
                   2674:             $clientosversion);
1.87      matthew  2675: }
                   2676: 
1.32      matthew  2677: ###############################################################
                   2678: ##    Authentication changing form generation subroutines    ##
                   2679: ###############################################################
                   2680: ##
                   2681: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2682: ## hash, and have reasonable default values.
                   2683: ##
                   2684: ##    formname = the name given in the <form> tag.
1.35      matthew  2685: #-------------------------------------------
                   2686: 
1.45      matthew  2687: =pod
                   2688: 
1.112     bowersj2 2689: =head1 Authentication Routines
                   2690: 
                   2691: =over 4
                   2692: 
1.648     raeburn  2693: =item * &authform_xxxxxx()
1.35      matthew  2694: 
                   2695: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2696: handle some of the conveniences required for authentication forms.  
                   2697: This is not an optimal method, but it works.  
                   2698: 
                   2699: =over 4
                   2700: 
1.112     bowersj2 2701: =item * authform_header
1.35      matthew  2702: 
1.112     bowersj2 2703: =item * authform_authorwarning
1.35      matthew  2704: 
1.112     bowersj2 2705: =item * authform_nochange
1.35      matthew  2706: 
1.112     bowersj2 2707: =item * authform_kerberos
1.35      matthew  2708: 
1.112     bowersj2 2709: =item * authform_internal
1.35      matthew  2710: 
1.112     bowersj2 2711: =item * authform_filesystem
1.35      matthew  2712: 
                   2713: =back
                   2714: 
1.648     raeburn  2715: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2716: 
1.35      matthew  2717: =cut
                   2718: 
                   2719: #-------------------------------------------
1.32      matthew  2720: sub authform_header{  
                   2721:     my %in = (
                   2722:         formname => 'cu',
1.80      albertel 2723:         kerb_def_dom => '',
1.32      matthew  2724:         @_,
                   2725:     );
                   2726:     $in{'formname'} = 'document.' . $in{'formname'};
                   2727:     my $result='';
1.80      albertel 2728: 
                   2729: #---------------------------------------------- Code for upper case translation
                   2730:     my $Javascript_toUpperCase;
                   2731:     unless ($in{kerb_def_dom}) {
                   2732:         $Javascript_toUpperCase =<<"END";
                   2733:         switch (choice) {
                   2734:            case 'krb': currentform.elements[choicearg].value =
                   2735:                currentform.elements[choicearg].value.toUpperCase();
                   2736:                break;
                   2737:            default:
                   2738:         }
                   2739: END
                   2740:     } else {
                   2741:         $Javascript_toUpperCase = "";
                   2742:     }
                   2743: 
1.165     raeburn  2744:     my $radioval = "'nochange'";
1.591     raeburn  2745:     if (defined($in{'curr_authtype'})) {
                   2746:         if ($in{'curr_authtype'} ne '') {
                   2747:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2748:         }
1.174     matthew  2749:     }
1.165     raeburn  2750:     my $argfield = 'null';
1.591     raeburn  2751:     if (defined($in{'mode'})) {
1.165     raeburn  2752:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2753:             if (defined($in{'curr_autharg'})) {
                   2754:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2755:                     $argfield = "'$in{'curr_autharg'}'";
                   2756:                 }
                   2757:             }
                   2758:         }
                   2759:     }
                   2760: 
1.32      matthew  2761:     $result.=<<"END";
                   2762: var current = new Object();
1.165     raeburn  2763: current.radiovalue = $radioval;
                   2764: current.argfield = $argfield;
1.32      matthew  2765: 
                   2766: function changed_radio(choice,currentform) {
                   2767:     var choicearg = choice + 'arg';
                   2768:     // If a radio button in changed, we need to change the argfield
                   2769:     if (current.radiovalue != choice) {
                   2770:         current.radiovalue = choice;
                   2771:         if (current.argfield != null) {
                   2772:             currentform.elements[current.argfield].value = '';
                   2773:         }
                   2774:         if (choice == 'nochange') {
                   2775:             current.argfield = null;
                   2776:         } else {
                   2777:             current.argfield = choicearg;
                   2778:             switch(choice) {
                   2779:                 case 'krb': 
                   2780:                     currentform.elements[current.argfield].value = 
                   2781:                         "$in{'kerb_def_dom'}";
                   2782:                 break;
                   2783:               default:
                   2784:                 break;
                   2785:             }
                   2786:         }
                   2787:     }
                   2788:     return;
                   2789: }
1.22      www      2790: 
1.32      matthew  2791: function changed_text(choice,currentform) {
                   2792:     var choicearg = choice + 'arg';
                   2793:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2794:         $Javascript_toUpperCase
1.32      matthew  2795:         // clear old field
                   2796:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2797:             currentform.elements[current.argfield].value = '';
                   2798:         }
                   2799:         current.argfield = choicearg;
                   2800:     }
                   2801:     set_auth_radio_buttons(choice,currentform);
                   2802:     return;
1.20      www      2803: }
1.32      matthew  2804: 
                   2805: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  2806:     var numauthchoices = currentform.login.length;
                   2807:     if (typeof numauthchoices  == "undefined") {
                   2808:         return;
                   2809:     } 
1.32      matthew  2810:     var i=0;
1.986     raeburn  2811:     while (i < numauthchoices) {
1.32      matthew  2812:         if (currentform.login[i].value == newvalue) { break; }
                   2813:         i++;
                   2814:     }
1.986     raeburn  2815:     if (i == numauthchoices) {
1.32      matthew  2816:         return;
                   2817:     }
                   2818:     current.radiovalue = newvalue;
                   2819:     currentform.login[i].checked = true;
                   2820:     return;
                   2821: }
                   2822: END
                   2823:     return $result;
                   2824: }
                   2825: 
1.1075.2.20  raeburn  2826: sub authform_authorwarning {
1.32      matthew  2827:     my $result='';
1.144     matthew  2828:     $result='<i>'.
                   2829:         &mt('As a general rule, only authors or co-authors should be '.
                   2830:             'filesystem authenticated '.
                   2831:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2832:     return $result;
                   2833: }
                   2834: 
1.1075.2.20  raeburn  2835: sub authform_nochange {
1.32      matthew  2836:     my %in = (
                   2837:               formname => 'document.cu',
                   2838:               kerb_def_dom => 'MSU.EDU',
                   2839:               @_,
                   2840:           );
1.1075.2.20  raeburn  2841:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'}); 
1.586     raeburn  2842:     my $result;
1.1075.2.20  raeburn  2843:     if (!$authnum) {
                   2844:         $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586     raeburn  2845:     } else {
                   2846:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2847:                   '<input type="radio" name="login" value="nochange" '.
                   2848:                   'checked="checked" onclick="'.
1.281     albertel 2849:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2850: 	    '</label>';
1.586     raeburn  2851:     }
1.32      matthew  2852:     return $result;
                   2853: }
                   2854: 
1.591     raeburn  2855: sub authform_kerberos {
1.32      matthew  2856:     my %in = (
                   2857:               formname => 'document.cu',
                   2858:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2859:               kerb_def_auth => 'krb4',
1.32      matthew  2860:               @_,
                   2861:               );
1.586     raeburn  2862:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1075.2.117  raeburn  2863:         $autharg,$jscall,$disabled);
1.1075.2.20  raeburn  2864:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80      albertel 2865:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2866:        $check5 = ' checked="checked"';
1.80      albertel 2867:     } else {
1.772     bisitz   2868:        $check4 = ' checked="checked"';
1.80      albertel 2869:     }
1.1075.2.117  raeburn  2870:     if ($in{'readonly'}) {
                   2871:         $disabled = ' disabled="disabled"';
                   2872:     }
1.165     raeburn  2873:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2874:     if (defined($in{'curr_authtype'})) {
                   2875:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2876:             $krbcheck = ' checked="checked"';
1.623     raeburn  2877:             if (defined($in{'mode'})) {
                   2878:                 if ($in{'mode'} eq 'modifyuser') {
                   2879:                     $krbcheck = '';
                   2880:                 }
                   2881:             }
1.591     raeburn  2882:             if (defined($in{'curr_kerb_ver'})) {
                   2883:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2884:                     $check5 = ' checked="checked"';
1.591     raeburn  2885:                     $check4 = '';
                   2886:                 } else {
1.772     bisitz   2887:                     $check4 = ' checked="checked"';
1.591     raeburn  2888:                     $check5 = '';
                   2889:                 }
1.586     raeburn  2890:             }
1.591     raeburn  2891:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2892:                 $krbarg = $in{'curr_autharg'};
                   2893:             }
1.586     raeburn  2894:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2895:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2896:                     $result = 
                   2897:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2898:         $in{'curr_autharg'},$krbver);
                   2899:                 } else {
                   2900:                     $result =
                   2901:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2902:                 }
                   2903:                 return $result; 
                   2904:             }
                   2905:         }
                   2906:     } else {
                   2907:         if ($authnum == 1) {
1.784     bisitz   2908:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2909:         }
                   2910:     }
1.586     raeburn  2911:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2912:         return;
1.587     raeburn  2913:     } elsif ($authtype eq '') {
1.591     raeburn  2914:         if (defined($in{'mode'})) {
1.587     raeburn  2915:             if ($in{'mode'} eq 'modifycourse') {
                   2916:                 if ($authnum == 1) {
1.1075.2.117  raeburn  2917:                     $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587     raeburn  2918:                 }
                   2919:             }
                   2920:         }
1.586     raeburn  2921:     }
                   2922:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2923:     if ($authtype eq '') {
                   2924:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2925:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1075.2.117  raeburn  2926:                     $krbcheck.$disabled.' />';
1.586     raeburn  2927:     }
                   2928:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1075.2.20  raeburn  2929:         ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586     raeburn  2930:          $in{'curr_authtype'} eq 'krb5') ||
1.1075.2.20  raeburn  2931:         (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586     raeburn  2932:          $in{'curr_authtype'} eq 'krb4')) {
                   2933:         $result .= &mt
1.144     matthew  2934:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2935:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2936:          '<label>'.$authtype,
1.281     albertel 2937:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2938:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2939:              'onchange="'.$jscall.'"'.$disabled.' />',
                   2940:          '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
                   2941:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281     albertel 2942: 	 '</label>');
1.586     raeburn  2943:     } elsif ($can_assign{'krb4'}) {
                   2944:         $result .= &mt
                   2945:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2946:          '[_3] Version 4 [_4]',
                   2947:          '<label>'.$authtype,
                   2948:          '</label><input type="text" size="10" name="krbarg" '.
                   2949:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2950:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  2951:          '<label><input type="hidden" name="krbver" value="4" />',
                   2952:          '</label>');
                   2953:     } elsif ($can_assign{'krb5'}) {
                   2954:         $result .= &mt
                   2955:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2956:          '[_3] Version 5 [_4]',
                   2957:          '<label>'.$authtype,
                   2958:          '</label><input type="text" size="10" name="krbarg" '.
                   2959:              'value="'.$krbarg.'" '.
1.1075.2.117  raeburn  2960:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  2961:          '<label><input type="hidden" name="krbver" value="5" />',
                   2962:          '</label>');
                   2963:     }
1.32      matthew  2964:     return $result;
                   2965: }
                   2966: 
1.1075.2.20  raeburn  2967: sub authform_internal {
1.586     raeburn  2968:     my %in = (
1.32      matthew  2969:                 formname => 'document.cu',
                   2970:                 kerb_def_dom => 'MSU.EDU',
                   2971:                 @_,
                   2972:                 );
1.1075.2.117  raeburn  2973:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  2974:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  2975:     if ($in{'readonly'}) {
                   2976:         $disabled = ' disabled="disabled"';
                   2977:     }
1.591     raeburn  2978:     if (defined($in{'curr_authtype'})) {
                   2979:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2980:             if ($can_assign{'int'}) {
1.772     bisitz   2981:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2982:                 if (defined($in{'mode'})) {
                   2983:                     if ($in{'mode'} eq 'modifyuser') {
                   2984:                         $intcheck = '';
                   2985:                     }
                   2986:                 }
1.591     raeburn  2987:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2988:                     $intarg = $in{'curr_autharg'};
                   2989:                 }
                   2990:             } else {
                   2991:                 $result = &mt('Currently internally authenticated.');
                   2992:                 return $result;
1.165     raeburn  2993:             }
                   2994:         }
1.586     raeburn  2995:     } else {
                   2996:         if ($authnum == 1) {
1.784     bisitz   2997:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2998:         }
                   2999:     }
                   3000:     if (!$can_assign{'int'}) {
                   3001:         return;
1.587     raeburn  3002:     } elsif ($authtype eq '') {
1.591     raeburn  3003:         if (defined($in{'mode'})) {
1.587     raeburn  3004:             if ($in{'mode'} eq 'modifycourse') {
                   3005:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3006:                     $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587     raeburn  3007:                 }
                   3008:             }
                   3009:         }
1.165     raeburn  3010:     }
1.586     raeburn  3011:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   3012:     if ($authtype eq '') {
                   3013:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1075.2.117  raeburn  3014:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3015:     }
1.605     bisitz   3016:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1075.2.117  raeburn  3017:                $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3018:     $result = &mt
1.144     matthew  3019:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  3020:          '<label>'.$authtype,'</label>'.$autharg);
1.1075.2.118  raeburn  3021:     $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  3022:     return $result;
                   3023: }
                   3024: 
1.1075.2.20  raeburn  3025: sub authform_local {
1.32      matthew  3026:     my %in = (
                   3027:               formname => 'document.cu',
                   3028:               kerb_def_dom => 'MSU.EDU',
                   3029:               @_,
                   3030:               );
1.1075.2.117  raeburn  3031:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  3032:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  3033:     if ($in{'readonly'}) {
                   3034:         $disabled = ' disabled="disabled"';
                   3035:     }
1.591     raeburn  3036:     if (defined($in{'curr_authtype'})) {
                   3037:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  3038:             if ($can_assign{'loc'}) {
1.772     bisitz   3039:                 $loccheck = 'checked="checked" ';
1.623     raeburn  3040:                 if (defined($in{'mode'})) {
                   3041:                     if ($in{'mode'} eq 'modifyuser') {
                   3042:                         $loccheck = '';
                   3043:                     }
                   3044:                 }
1.591     raeburn  3045:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3046:                     $locarg = $in{'curr_autharg'};
                   3047:                 }
                   3048:             } else {
                   3049:                 $result = &mt('Currently using local (institutional) authentication.');
                   3050:                 return $result;
1.165     raeburn  3051:             }
                   3052:         }
1.586     raeburn  3053:     } else {
                   3054:         if ($authnum == 1) {
1.784     bisitz   3055:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  3056:         }
                   3057:     }
                   3058:     if (!$can_assign{'loc'}) {
                   3059:         return;
1.587     raeburn  3060:     } elsif ($authtype eq '') {
1.591     raeburn  3061:         if (defined($in{'mode'})) {
1.587     raeburn  3062:             if ($in{'mode'} eq 'modifycourse') {
                   3063:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3064:                     $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587     raeburn  3065:                 }
                   3066:             }
                   3067:         }
1.165     raeburn  3068:     }
1.586     raeburn  3069:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   3070:     if ($authtype eq '') {
                   3071:         $authtype = '<input type="radio" name="login" value="loc" '.
                   3072:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117  raeburn  3073:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3074:     }
                   3075:     $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1075.2.117  raeburn  3076:                $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3077:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   3078:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  3079:     return $result;
                   3080: }
                   3081: 
1.1075.2.20  raeburn  3082: sub authform_filesystem {
1.32      matthew  3083:     my %in = (
                   3084:               formname => 'document.cu',
                   3085:               kerb_def_dom => 'MSU.EDU',
                   3086:               @_,
                   3087:               );
1.1075.2.117  raeburn  3088:     my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1075.2.20  raeburn  3089:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1075.2.117  raeburn  3090:     if ($in{'readonly'}) {
                   3091:         $disabled = ' disabled="disabled"';
                   3092:     }
1.591     raeburn  3093:     if (defined($in{'curr_authtype'})) {
                   3094:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  3095:             if ($can_assign{'fsys'}) {
1.772     bisitz   3096:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  3097:                 if (defined($in{'mode'})) {
                   3098:                     if ($in{'mode'} eq 'modifyuser') {
                   3099:                         $fsyscheck = '';
                   3100:                     }
                   3101:                 }
1.586     raeburn  3102:             } else {
                   3103:                 $result = &mt('Currently Filesystem Authenticated.');
                   3104:                 return $result;
                   3105:             }           
                   3106:         }
                   3107:     } else {
                   3108:         if ($authnum == 1) {
1.784     bisitz   3109:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  3110:         }
                   3111:     }
                   3112:     if (!$can_assign{'fsys'}) {
                   3113:         return;
1.587     raeburn  3114:     } elsif ($authtype eq '') {
1.591     raeburn  3115:         if (defined($in{'mode'})) {
1.587     raeburn  3116:             if ($in{'mode'} eq 'modifycourse') {
                   3117:                 if ($authnum == 1) {
1.1075.2.117  raeburn  3118:                     $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587     raeburn  3119:                 }
                   3120:             }
                   3121:         }
1.586     raeburn  3122:     }
                   3123:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   3124:     if ($authtype eq '') {
                   3125:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   3126:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1075.2.117  raeburn  3127:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3128:     }
1.1075.2.158  raeburn  3129:     $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1075.2.117  raeburn  3130:                ' onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3131:     $result = &mt
1.144     matthew  3132:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1075.2.158  raeburn  3133:          '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  3134:     return $result;
                   3135: }
                   3136: 
1.586     raeburn  3137: sub get_assignable_auth {
                   3138:     my ($dom) = @_;
                   3139:     if ($dom eq '') {
                   3140:         $dom = $env{'request.role.domain'};
                   3141:     }
                   3142:     my %can_assign = (
                   3143:                           krb4 => 1,
                   3144:                           krb5 => 1,
                   3145:                           int  => 1,
                   3146:                           loc  => 1,
                   3147:                      );
                   3148:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   3149:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   3150:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   3151:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   3152:             my $context;
                   3153:             if ($env{'request.role'} =~ /^au/) {
                   3154:                 $context = 'author';
1.1075.2.117  raeburn  3155:             } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586     raeburn  3156:                 $context = 'domain';
                   3157:             } elsif ($env{'request.course.id'}) {
                   3158:                 $context = 'course';
                   3159:             }
                   3160:             if ($context) {
                   3161:                 if (ref($authhash->{$context}) eq 'HASH') {
                   3162:                    %can_assign = %{$authhash->{$context}}; 
                   3163:                 }
                   3164:             }
                   3165:         }
                   3166:     }
                   3167:     my $authnum = 0;
                   3168:     foreach my $key (keys(%can_assign)) {
                   3169:         if ($can_assign{$key}) {
                   3170:             $authnum ++;
                   3171:         }
                   3172:     }
                   3173:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   3174:         $authnum --;
                   3175:     }
                   3176:     return ($authnum,%can_assign);
                   3177: }
                   3178: 
1.1075.2.137  raeburn  3179: sub check_passwd_rules {
                   3180:     my ($domain,$plainpass) = @_;
                   3181:     my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
                   3182:     my ($min,$max,@chars,@brokerule,$warning);
1.1075.2.138  raeburn  3183:     $min = $Apache::lonnet::passwdmin;
1.1075.2.137  raeburn  3184:     if (ref($passwdconf{'chars'}) eq 'ARRAY') {
                   3185:         if ($passwdconf{'min'} =~ /^\d+$/) {
1.1075.2.138  raeburn  3186:             if ($passwdconf{'min'} > $min) {
                   3187:                 $min = $passwdconf{'min'};
                   3188:             }
1.1075.2.137  raeburn  3189:         }
                   3190:         if ($passwdconf{'max'} =~ /^\d+$/) {
                   3191:             $max = $passwdconf{'max'};
                   3192:         }
                   3193:         @chars = @{$passwdconf{'chars'}};
                   3194:     }
                   3195:     if (($min) && (length($plainpass) < $min)) {
                   3196:         push(@brokerule,'min');
                   3197:     }
                   3198:     if (($max) && (length($plainpass) > $max)) {
                   3199:         push(@brokerule,'max');
                   3200:     }
                   3201:     if (@chars) {
                   3202:         my %rules;
                   3203:         map { $rules{$_} = 1; } @chars;
                   3204:         if ($rules{'uc'}) {
                   3205:             unless ($plainpass =~ /[A-Z]/) {
                   3206:                 push(@brokerule,'uc');
                   3207:             }
                   3208:         }
                   3209:         if ($rules{'lc'}) {
                   3210:             unless ($plainpass =~ /[a-z]/) {
                   3211:                 push(@brokerule,'lc');
                   3212:             }
                   3213:         }
                   3214:         if ($rules{'num'}) {
                   3215:             unless ($plainpass =~ /\d/) {
                   3216:                 push(@brokerule,'num');
                   3217:             }
                   3218:         }
                   3219:         if ($rules{'spec'}) {
                   3220:             unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
                   3221:                 push(@brokerule,'spec');
                   3222:             }
                   3223:         }
                   3224:     }
                   3225:     if (@brokerule) {
                   3226:         my %rulenames = &Apache::lonlocal::texthash(
                   3227:             uc   => 'At least one upper case letter',
                   3228:             lc   => 'At least one lower case letter',
                   3229:             num  => 'At least one number',
                   3230:             spec => 'At least one non-alphanumeric',
                   3231:         );
                   3232:         $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
                   3233:         $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
                   3234:         $rulenames{'num'} .= ': 0123456789';
                   3235:         $rulenames{'spec'} .= ': !&quot;\#$%&amp;\'()*+,-./:;&lt;=&gt;?@[\]^_\`{|}~';
                   3236:         $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
                   3237:         $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
                   3238:         $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1075.2.143  raeburn  3239:         foreach my $rule ('min','max','uc','lc','num','spec') {
1.1075.2.137  raeburn  3240:             if (grep(/^$rule$/,@brokerule)) {
                   3241:                 $warning .= '<li>'.$rulenames{$rule}.'</li>';
                   3242:             }
                   3243:         }
                   3244:         $warning .= '</ul>';
                   3245:     }
                   3246:     if (wantarray) {
                   3247:         return @brokerule;
                   3248:     }
                   3249:     return $warning;
                   3250: }
                   3251: 
1.80      albertel 3252: ###############################################################
                   3253: ##    Get Kerberos Defaults for Domain                 ##
                   3254: ###############################################################
                   3255: ##
                   3256: ## Returns default kerberos version and an associated argument
                   3257: ## as listed in file domain.tab. If not listed, provides
                   3258: ## appropriate default domain and kerberos version.
                   3259: ##
                   3260: #-------------------------------------------
                   3261: 
                   3262: =pod
                   3263: 
1.648     raeburn  3264: =item * &get_kerberos_defaults()
1.80      albertel 3265: 
                   3266: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  3267: version and domain. If not found, it defaults to version 4 and the 
                   3268: domain of the server.
1.80      albertel 3269: 
1.648     raeburn  3270: =over 4
                   3271: 
1.80      albertel 3272: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   3273: 
1.648     raeburn  3274: =back
                   3275: 
                   3276: =back
                   3277: 
1.80      albertel 3278: =cut
                   3279: 
                   3280: #-------------------------------------------
                   3281: sub get_kerberos_defaults {
                   3282:     my $domain=shift;
1.641     raeburn  3283:     my ($krbdef,$krbdefdom);
                   3284:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   3285:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   3286:         $krbdef = $domdefaults{'auth_def'};
                   3287:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   3288:     } else {
1.80      albertel 3289:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   3290:         my $krbdefdom=$1;
                   3291:         $krbdefdom=~tr/a-z/A-Z/;
                   3292:         $krbdef = "krb4";
                   3293:     }
                   3294:     return ($krbdef,$krbdefdom);
                   3295: }
1.112     bowersj2 3296: 
1.32      matthew  3297: 
1.46      matthew  3298: ###############################################################
                   3299: ##                Thesaurus Functions                        ##
                   3300: ###############################################################
1.20      www      3301: 
1.46      matthew  3302: =pod
1.20      www      3303: 
1.112     bowersj2 3304: =head1 Thesaurus Functions
                   3305: 
                   3306: =over 4
                   3307: 
1.648     raeburn  3308: =item * &initialize_keywords()
1.46      matthew  3309: 
                   3310: Initializes the package variable %Keywords if it is empty.  Uses the
                   3311: package variable $thesaurus_db_file.
                   3312: 
                   3313: =cut
                   3314: 
                   3315: ###################################################
                   3316: 
                   3317: sub initialize_keywords {
                   3318:     return 1 if (scalar keys(%Keywords));
                   3319:     # If we are here, %Keywords is empty, so fill it up
                   3320:     #   Make sure the file we need exists...
                   3321:     if (! -e $thesaurus_db_file) {
                   3322:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   3323:                                  " failed because it does not exist");
                   3324:         return 0;
                   3325:     }
                   3326:     #   Set up the hash as a database
                   3327:     my %thesaurus_db;
                   3328:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3329:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3330:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   3331:                                  $thesaurus_db_file);
                   3332:         return 0;
                   3333:     } 
                   3334:     #  Get the average number of appearances of a word.
                   3335:     my $avecount = $thesaurus_db{'average.count'};
                   3336:     #  Put keywords (those that appear > average) into %Keywords
                   3337:     while (my ($word,$data)=each (%thesaurus_db)) {
                   3338:         my ($count,undef) = split /:/,$data;
                   3339:         $Keywords{$word}++ if ($count > $avecount);
                   3340:     }
                   3341:     untie %thesaurus_db;
                   3342:     # Remove special values from %Keywords.
1.356     albertel 3343:     foreach my $value ('total.count','average.count') {
                   3344:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  3345:   }
1.46      matthew  3346:     return 1;
                   3347: }
                   3348: 
                   3349: ###################################################
                   3350: 
                   3351: =pod
                   3352: 
1.648     raeburn  3353: =item * &keyword($word)
1.46      matthew  3354: 
                   3355: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   3356: than the average number of times in the thesaurus database.  Calls 
                   3357: &initialize_keywords
                   3358: 
                   3359: =cut
                   3360: 
                   3361: ###################################################
1.20      www      3362: 
                   3363: sub keyword {
1.46      matthew  3364:     return if (!&initialize_keywords());
                   3365:     my $word=lc(shift());
                   3366:     $word=~s/\W//g;
                   3367:     return exists($Keywords{$word});
1.20      www      3368: }
1.46      matthew  3369: 
                   3370: ###############################################################
                   3371: 
                   3372: =pod 
1.20      www      3373: 
1.648     raeburn  3374: =item * &get_related_words()
1.46      matthew  3375: 
1.160     matthew  3376: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  3377: an array of words.  If the keyword is not in the thesaurus, an empty array
                   3378: will be returned.  The order of the words returned is determined by the
                   3379: database which holds them.
                   3380: 
                   3381: Uses global $thesaurus_db_file.
                   3382: 
1.1057    foxr     3383: 
1.46      matthew  3384: =cut
                   3385: 
                   3386: ###############################################################
                   3387: sub get_related_words {
                   3388:     my $keyword = shift;
                   3389:     my %thesaurus_db;
                   3390:     if (! -e $thesaurus_db_file) {
                   3391:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   3392:                                  "failed because the file does not exist");
                   3393:         return ();
                   3394:     }
                   3395:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 3396:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  3397:         return ();
                   3398:     } 
                   3399:     my @Words=();
1.429     www      3400:     my $count=0;
1.46      matthew  3401:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 3402: 	# The first element is the number of times
                   3403: 	# the word appears.  We do not need it now.
1.429     www      3404: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   3405: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   3406: 	my $threshold=$mostfrequentcount/10;
                   3407:         foreach my $possibleword (@RelatedWords) {
                   3408:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   3409:             if ($wordcount>$threshold) {
                   3410: 		push(@Words,$word);
                   3411:                 $count++;
                   3412:                 if ($count>10) { last; }
                   3413: 	    }
1.20      www      3414:         }
                   3415:     }
1.46      matthew  3416:     untie %thesaurus_db;
                   3417:     return @Words;
1.14      harris41 3418: }
1.46      matthew  3419: 
1.112     bowersj2 3420: =pod
                   3421: 
                   3422: =back
                   3423: 
                   3424: =cut
1.61      www      3425: 
                   3426: # -------------------------------------------------------------- Plaintext name
1.81      albertel 3427: =pod
                   3428: 
1.112     bowersj2 3429: =head1 User Name Functions
                   3430: 
                   3431: =over 4
                   3432: 
1.648     raeburn  3433: =item * &plainname($uname,$udom,$first)
1.81      albertel 3434: 
1.112     bowersj2 3435: Takes a users logon name and returns it as a string in
1.226     albertel 3436: "first middle last generation" form 
                   3437: if $first is set to 'lastname' then it returns it as
                   3438: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 3439: 
                   3440: =cut
1.61      www      3441: 
1.295     www      3442: 
1.81      albertel 3443: ###############################################################
1.61      www      3444: sub plainname {
1.226     albertel 3445:     my ($uname,$udom,$first)=@_;
1.537     albertel 3446:     return if (!defined($uname) || !defined($udom));
1.295     www      3447:     my %names=&getnames($uname,$udom);
1.226     albertel 3448:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   3449: 					  $names{'middlename'},
                   3450: 					  $names{'lastname'},
                   3451: 					  $names{'generation'},$first);
                   3452:     $name=~s/^\s+//;
1.62      www      3453:     $name=~s/\s+$//;
                   3454:     $name=~s/\s+/ /g;
1.353     albertel 3455:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      3456:     return $name;
1.61      www      3457: }
1.66      www      3458: 
                   3459: # -------------------------------------------------------------------- Nickname
1.81      albertel 3460: =pod
                   3461: 
1.648     raeburn  3462: =item * &nickname($uname,$udom)
1.81      albertel 3463: 
                   3464: Gets a users name and returns it as a string as
                   3465: 
                   3466: "&quot;nickname&quot;"
1.66      www      3467: 
1.81      albertel 3468: if the user has a nickname or
                   3469: 
                   3470: "first middle last generation"
                   3471: 
                   3472: if the user does not
                   3473: 
                   3474: =cut
1.66      www      3475: 
                   3476: sub nickname {
                   3477:     my ($uname,$udom)=@_;
1.537     albertel 3478:     return if (!defined($uname) || !defined($udom));
1.295     www      3479:     my %names=&getnames($uname,$udom);
1.68      albertel 3480:     my $name=$names{'nickname'};
1.66      www      3481:     if ($name) {
                   3482:        $name='&quot;'.$name.'&quot;'; 
                   3483:     } else {
                   3484:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   3485: 	     $names{'lastname'}.' '.$names{'generation'};
                   3486:        $name=~s/\s+$//;
                   3487:        $name=~s/\s+/ /g;
                   3488:     }
                   3489:     return $name;
                   3490: }
                   3491: 
1.295     www      3492: sub getnames {
                   3493:     my ($uname,$udom)=@_;
1.537     albertel 3494:     return if (!defined($uname) || !defined($udom));
1.433     albertel 3495:     if ($udom eq 'public' && $uname eq 'public') {
                   3496: 	return ('lastname' => &mt('Public'));
                   3497:     }
1.295     www      3498:     my $id=$uname.':'.$udom;
                   3499:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   3500:     if ($cached) {
                   3501: 	return %{$names};
                   3502:     } else {
                   3503: 	my %loadnames=&Apache::lonnet::get('environment',
                   3504:                     ['firstname','middlename','lastname','generation','nickname'],
                   3505: 					 $udom,$uname);
                   3506: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   3507: 	return %loadnames;
                   3508:     }
                   3509: }
1.61      www      3510: 
1.542     raeburn  3511: # -------------------------------------------------------------------- getemails
1.648     raeburn  3512: 
1.542     raeburn  3513: =pod
                   3514: 
1.648     raeburn  3515: =item * &getemails($uname,$udom)
1.542     raeburn  3516: 
                   3517: Gets a user's email information and returns it as a hash with keys:
                   3518: notification, critnotification, permanentemail
                   3519: 
                   3520: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  3521: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  3522:  
1.648     raeburn  3523: 
1.542     raeburn  3524: =cut
                   3525: 
1.648     raeburn  3526: 
1.466     albertel 3527: sub getemails {
                   3528:     my ($uname,$udom)=@_;
                   3529:     if ($udom eq 'public' && $uname eq 'public') {
                   3530: 	return;
                   3531:     }
1.467     www      3532:     if (!$udom) { $udom=$env{'user.domain'}; }
                   3533:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 3534:     my $id=$uname.':'.$udom;
                   3535:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   3536:     if ($cached) {
                   3537: 	return %{$names};
                   3538:     } else {
                   3539: 	my %loadnames=&Apache::lonnet::get('environment',
                   3540:                     			   ['notification','critnotification',
                   3541: 					    'permanentemail'],
                   3542: 					   $udom,$uname);
                   3543: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   3544: 	return %loadnames;
                   3545:     }
                   3546: }
                   3547: 
1.551     albertel 3548: sub flush_email_cache {
                   3549:     my ($uname,$udom)=@_;
                   3550:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3551:     if (!$uname) { $uname=$env{'user.name'};   }
                   3552:     return if ($udom eq 'public' && $uname eq 'public');
                   3553:     my $id=$uname.':'.$udom;
                   3554:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   3555: }
                   3556: 
1.728     raeburn  3557: # -------------------------------------------------------------------- getlangs
                   3558: 
                   3559: =pod
                   3560: 
                   3561: =item * &getlangs($uname,$udom)
                   3562: 
                   3563: Gets a user's language preference and returns it as a hash with key:
                   3564: language.
                   3565: 
                   3566: =cut
                   3567: 
                   3568: 
                   3569: sub getlangs {
                   3570:     my ($uname,$udom) = @_;
                   3571:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3572:     if (!$uname) { $uname=$env{'user.name'};   }
                   3573:     my $id=$uname.':'.$udom;
                   3574:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   3575:     if ($cached) {
                   3576:         return %{$langs};
                   3577:     } else {
                   3578:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   3579:                                            $udom,$uname);
                   3580:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   3581:         return %loadlangs;
                   3582:     }
                   3583: }
                   3584: 
                   3585: sub flush_langs_cache {
                   3586:     my ($uname,$udom)=@_;
                   3587:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3588:     if (!$uname) { $uname=$env{'user.name'};   }
                   3589:     return if ($udom eq 'public' && $uname eq 'public');
                   3590:     my $id=$uname.':'.$udom;
                   3591:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   3592: }
                   3593: 
1.61      www      3594: # ------------------------------------------------------------------ Screenname
1.81      albertel 3595: 
                   3596: =pod
                   3597: 
1.648     raeburn  3598: =item * &screenname($uname,$udom)
1.81      albertel 3599: 
                   3600: Gets a users screenname and returns it as a string
                   3601: 
                   3602: =cut
1.61      www      3603: 
                   3604: sub screenname {
                   3605:     my ($uname,$udom)=@_;
1.258     albertel 3606:     if ($uname eq $env{'user.name'} &&
                   3607: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 3608:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 3609:     return $names{'screenname'};
1.62      www      3610: }
                   3611: 
1.212     albertel 3612: 
1.802     bisitz   3613: # ------------------------------------------------------------- Confirm Wrapper
                   3614: =pod
                   3615: 
1.1075.2.42  raeburn  3616: =item * &confirmwrapper($message)
1.802     bisitz   3617: 
                   3618: Wrap messages about completion of operation in box
                   3619: 
                   3620: =cut
                   3621: 
                   3622: sub confirmwrapper {
                   3623:     my ($message)=@_;
                   3624:     if ($message) {
                   3625:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3626:                .$message."\n"
                   3627:                .'</div>'."\n";
                   3628:     } else {
                   3629:         return $message;
                   3630:     }
                   3631: }
                   3632: 
1.62      www      3633: # ------------------------------------------------------------- Message Wrapper
                   3634: 
                   3635: sub messagewrapper {
1.369     www      3636:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3637:     return 
1.441     albertel 3638:         '<a href="/adm/email?compose=individual&amp;'.
                   3639:         'recname='.$username.'&amp;recdom='.$domain.
                   3640: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3641:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3642: }
1.802     bisitz   3643: 
1.74      www      3644: # --------------------------------------------------------------- Notes Wrapper
                   3645: 
                   3646: sub noteswrapper {
                   3647:     my ($link,$un,$do)=@_;
                   3648:     return 
1.896     amueller 3649: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3650: }
1.802     bisitz   3651: 
1.62      www      3652: # ------------------------------------------------------------- Aboutme Wrapper
                   3653: 
                   3654: sub aboutmewrapper {
1.1070    raeburn  3655:     my ($link,$username,$domain,$target,$class)=@_;
1.447     raeburn  3656:     if (!defined($username)  && !defined($domain)) {
                   3657:         return;
                   3658:     }
1.1075.2.15  raeburn  3659:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070    raeburn  3660: 	($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3661: }
                   3662: 
                   3663: # ------------------------------------------------------------ Syllabus Wrapper
                   3664: 
                   3665: sub syllabuswrapper {
1.707     bisitz   3666:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3667:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3668: }
1.14      harris41 3669: 
1.802     bisitz   3670: # -----------------------------------------------------------------------------
                   3671: 
1.1075.2.167  raeburn  3672: sub aboutme_on {
                   3673:     my ($uname,$udom)=@_;
                   3674:     unless ($uname) { $uname=$env{'user.name'}; }
                   3675:     unless ($udom)  { $udom=$env{'user.domain'}; }
                   3676:     return if ($udom eq 'public' && $uname eq 'public');
                   3677:     my $hashkey=$uname.':'.$udom;
                   3678:     my ($aboutme,$cached)=&Apache::lonnet::is_cached_new('aboutme',$hashkey);
                   3679:     if ($cached) {
                   3680:         return $aboutme;
                   3681:     }
                   3682:     $aboutme = &Apache::lonnet::usertools_access($uname,$udom,'aboutme');
                   3683:     &Apache::lonnet::do_cache_new('aboutme',$hashkey,$aboutme,3600);
                   3684:     return $aboutme;
                   3685: }
                   3686: 
                   3687: sub devalidate_aboutme_cache {
                   3688:     my ($uname,$udom)=@_;
                   3689:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   3690:     if (!$uname) { $uname=$env{'user.name'};   }
                   3691:     return if ($udom eq 'public' && $uname eq 'public');
                   3692:     my $id=$uname.':'.$udom;
                   3693:     &Apache::lonnet::devalidate_cache_new('aboutme',$id);
                   3694: }
                   3695: 
1.208     matthew  3696: sub track_student_link {
1.887     raeburn  3697:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3698:     my $link ="/adm/trackstudent?";
1.208     matthew  3699:     my $title = 'View recent activity';
                   3700:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3701:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3702:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3703:         $title .= ' of this student';
1.268     albertel 3704:     } 
1.208     matthew  3705:     if (defined($target) && $target !~ /^\s*$/) {
                   3706:         $target = qq{target="$target"};
                   3707:     } else {
                   3708:         $target = '';
                   3709:     }
1.268     albertel 3710:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3711:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3712:     $title = &mt($title);
                   3713:     $linktext = &mt($linktext);
1.448     albertel 3714:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3715: 	&help_open_topic('View_recent_activity');
1.208     matthew  3716: }
                   3717: 
1.781     raeburn  3718: sub slot_reservations_link {
                   3719:     my ($linktext,$sname,$sdom,$target) = @_;
                   3720:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3721:     my $title = 'View slot reservation history';
                   3722:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3723:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3724:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3725:         $title .= ' of this student';
                   3726:     }
                   3727:     if (defined($target) && $target !~ /^\s*$/) {
                   3728:         $target = qq{target="$target"};
                   3729:     } else {
                   3730:         $target = '';
                   3731:     }
                   3732:     $title = &mt($title);
                   3733:     $linktext = &mt($linktext);
                   3734:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3735: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3736: 
                   3737: }
                   3738: 
1.508     www      3739: # ===================================================== Display a student photo
                   3740: 
                   3741: 
1.509     albertel 3742: sub student_image_tag {
1.508     www      3743:     my ($domain,$user)=@_;
                   3744:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3745:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3746: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3747:     } else {
                   3748: 	return '';
                   3749:     }
                   3750: }
                   3751: 
1.112     bowersj2 3752: =pod
                   3753: 
                   3754: =back
                   3755: 
                   3756: =head1 Access .tab File Data
                   3757: 
                   3758: =over 4
                   3759: 
1.648     raeburn  3760: =item * &languageids() 
1.112     bowersj2 3761: 
                   3762: returns list of all language ids
                   3763: 
                   3764: =cut
                   3765: 
1.14      harris41 3766: sub languageids {
1.16      harris41 3767:     return sort(keys(%language));
1.14      harris41 3768: }
                   3769: 
1.112     bowersj2 3770: =pod
                   3771: 
1.648     raeburn  3772: =item * &languagedescription() 
1.112     bowersj2 3773: 
                   3774: returns description of a specified language id
                   3775: 
                   3776: =cut
                   3777: 
1.14      harris41 3778: sub languagedescription {
1.125     www      3779:     my $code=shift;
                   3780:     return  ($supported_language{$code}?'* ':'').
                   3781:             $language{$code}.
1.126     www      3782: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3783: }
                   3784: 
1.1048    foxr     3785: =pod
                   3786: 
                   3787: =item * &plainlanguagedescription
                   3788: 
                   3789: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   3790: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   3791: 
                   3792: =cut
                   3793: 
1.145     www      3794: sub plainlanguagedescription {
                   3795:     my $code=shift;
                   3796:     return $language{$code};
                   3797: }
                   3798: 
1.1048    foxr     3799: =pod
                   3800: 
                   3801: =item * &supportedlanguagecode
                   3802: 
                   3803: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   3804: code.
                   3805: 
                   3806: =cut
                   3807: 
1.145     www      3808: sub supportedlanguagecode {
                   3809:     my $code=shift;
                   3810:     return $supported_language{$code};
1.97      www      3811: }
                   3812: 
1.112     bowersj2 3813: =pod
                   3814: 
1.1048    foxr     3815: =item * &latexlanguage()
                   3816: 
                   3817: Given a language key code returns the correspondnig language to use
                   3818: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   3819: is no supported hyphenation for the language code.
                   3820: 
                   3821: =cut
                   3822: 
                   3823: sub latexlanguage {
                   3824:     my $code = shift;
                   3825:     return $latex_language{$code};
                   3826: }
                   3827: 
                   3828: =pod
                   3829: 
                   3830: =item * &latexhyphenation()
                   3831: 
                   3832: Same as above but what's supplied is the language as it might be stored
                   3833: in the metadata.
                   3834: 
                   3835: =cut
                   3836: 
                   3837: sub latexhyphenation {
                   3838:     my $key = shift;
                   3839:     return $latex_language_bykey{$key};
                   3840: }
                   3841: 
                   3842: =pod
                   3843: 
1.648     raeburn  3844: =item * &copyrightids() 
1.112     bowersj2 3845: 
                   3846: returns list of all copyrights
                   3847: 
                   3848: =cut
                   3849: 
                   3850: sub copyrightids {
                   3851:     return sort(keys(%cprtag));
                   3852: }
                   3853: 
                   3854: =pod
                   3855: 
1.648     raeburn  3856: =item * &copyrightdescription() 
1.112     bowersj2 3857: 
                   3858: returns description of a specified copyright id
                   3859: 
                   3860: =cut
                   3861: 
                   3862: sub copyrightdescription {
1.166     www      3863:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3864: }
1.197     matthew  3865: 
                   3866: =pod
                   3867: 
1.648     raeburn  3868: =item * &source_copyrightids() 
1.192     taceyjo1 3869: 
                   3870: returns list of all source copyrights
                   3871: 
                   3872: =cut
                   3873: 
                   3874: sub source_copyrightids {
                   3875:     return sort(keys(%scprtag));
                   3876: }
                   3877: 
                   3878: =pod
                   3879: 
1.648     raeburn  3880: =item * &source_copyrightdescription() 
1.192     taceyjo1 3881: 
                   3882: returns description of a specified source copyright id
                   3883: 
                   3884: =cut
                   3885: 
                   3886: sub source_copyrightdescription {
                   3887:     return &mt($scprtag{shift(@_)});
                   3888: }
1.112     bowersj2 3889: 
                   3890: =pod
                   3891: 
1.648     raeburn  3892: =item * &filecategories() 
1.112     bowersj2 3893: 
                   3894: returns list of all file categories
                   3895: 
                   3896: =cut
                   3897: 
                   3898: sub filecategories {
                   3899:     return sort(keys(%category_extensions));
                   3900: }
                   3901: 
                   3902: =pod
                   3903: 
1.648     raeburn  3904: =item * &filecategorytypes() 
1.112     bowersj2 3905: 
                   3906: returns list of file types belonging to a given file
                   3907: category
                   3908: 
                   3909: =cut
                   3910: 
                   3911: sub filecategorytypes {
1.356     albertel 3912:     my ($cat) = @_;
                   3913:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3914: }
                   3915: 
                   3916: =pod
                   3917: 
1.648     raeburn  3918: =item * &fileembstyle() 
1.112     bowersj2 3919: 
                   3920: returns embedding style for a specified file type
                   3921: 
                   3922: =cut
                   3923: 
                   3924: sub fileembstyle {
                   3925:     return $fe{lc(shift(@_))};
1.169     www      3926: }
                   3927: 
1.351     www      3928: sub filemimetype {
                   3929:     return $fm{lc(shift(@_))};
                   3930: }
                   3931: 
1.169     www      3932: 
                   3933: sub filecategoryselect {
                   3934:     my ($name,$value)=@_;
1.189     matthew  3935:     return &select_form($value,$name,
1.970     raeburn  3936:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 3937: }
                   3938: 
                   3939: =pod
                   3940: 
1.648     raeburn  3941: =item * &filedescription() 
1.112     bowersj2 3942: 
                   3943: returns description for a specified file type
                   3944: 
                   3945: =cut
                   3946: 
                   3947: sub filedescription {
1.188     matthew  3948:     my $file_description = $fd{lc(shift())};
                   3949:     $file_description =~ s:([\[\]]):~$1:g;
                   3950:     return &mt($file_description);
1.112     bowersj2 3951: }
                   3952: 
                   3953: =pod
                   3954: 
1.648     raeburn  3955: =item * &filedescriptionex() 
1.112     bowersj2 3956: 
                   3957: returns description for a specified file type with
                   3958: extra formatting
                   3959: 
                   3960: =cut
                   3961: 
                   3962: sub filedescriptionex {
                   3963:     my $ex=shift;
1.188     matthew  3964:     my $file_description = $fd{lc($ex)};
                   3965:     $file_description =~ s:([\[\]]):~$1:g;
                   3966:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3967: }
                   3968: 
                   3969: # End of .tab access
                   3970: =pod
                   3971: 
                   3972: =back
                   3973: 
                   3974: =cut
                   3975: 
                   3976: # ------------------------------------------------------------------ File Types
                   3977: sub fileextensions {
                   3978:     return sort(keys(%fe));
                   3979: }
                   3980: 
1.97      www      3981: # ----------------------------------------------------------- Display Languages
                   3982: # returns a hash with all desired display languages
                   3983: #
                   3984: 
                   3985: sub display_languages {
                   3986:     my %languages=();
1.695     raeburn  3987:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3988: 	$languages{$lang}=1;
1.97      www      3989:     }
                   3990:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3991:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3992: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3993: 	    $languages{$lang}=1;
1.97      www      3994:         }
                   3995:     }
                   3996:     return %languages;
1.14      harris41 3997: }
                   3998: 
1.582     albertel 3999: sub languages {
                   4000:     my ($possible_langs) = @_;
1.695     raeburn  4001:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 4002:     if (!ref($possible_langs)) {
                   4003: 	if( wantarray ) {
                   4004: 	    return @preferred_langs;
                   4005: 	} else {
                   4006: 	    return $preferred_langs[0];
                   4007: 	}
                   4008:     }
                   4009:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   4010:     my @preferred_possibilities;
                   4011:     foreach my $preferred_lang (@preferred_langs) {
                   4012: 	if (exists($possibilities{$preferred_lang})) {
                   4013: 	    push(@preferred_possibilities, $preferred_lang);
                   4014: 	}
                   4015:     }
                   4016:     if( wantarray ) {
                   4017: 	return @preferred_possibilities;
                   4018:     }
                   4019:     return $preferred_possibilities[0];
                   4020: }
                   4021: 
1.742     raeburn  4022: sub user_lang {
                   4023:     my ($touname,$toudom,$fromcid) = @_;
                   4024:     my @userlangs;
                   4025:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   4026:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   4027:                     $env{'course.'.$fromcid.'.languages'}));
                   4028:     } else {
                   4029:         my %langhash = &getlangs($touname,$toudom);
                   4030:         if ($langhash{'languages'} ne '') {
                   4031:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   4032:         } else {
                   4033:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   4034:             if ($domdefs{'lang_def'} ne '') {
                   4035:                 @userlangs = ($domdefs{'lang_def'});
                   4036:             }
                   4037:         }
                   4038:     }
                   4039:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   4040:     my $user_lh = Apache::localize->get_handle(@languages);
                   4041:     return $user_lh;
                   4042: }
                   4043: 
                   4044: 
1.112     bowersj2 4045: ###############################################################
                   4046: ##               Student Answer Attempts                     ##
                   4047: ###############################################################
                   4048: 
                   4049: =pod
                   4050: 
                   4051: =head1 Alternate Problem Views
                   4052: 
                   4053: =over 4
                   4054: 
1.648     raeburn  4055: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1075.2.86  raeburn  4056:     $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112     bowersj2 4057: 
                   4058: Return string with previous attempt on problem. Arguments:
                   4059: 
                   4060: =over 4
                   4061: 
                   4062: =item * $symb: Problem, including path
                   4063: 
                   4064: =item * $username: username of the desired student
                   4065: 
                   4066: =item * $domain: domain of the desired student
1.14      harris41 4067: 
1.112     bowersj2 4068: =item * $course: Course ID
1.14      harris41 4069: 
1.112     bowersj2 4070: =item * $getattempt: Leave blank for all attempts, otherwise put
                   4071:     something
1.14      harris41 4072: 
1.112     bowersj2 4073: =item * $regexp: if string matches this regexp, the string will be
                   4074:     sent to $gradesub
1.14      harris41 4075: 
1.112     bowersj2 4076: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 4077: 
1.1075.2.86  raeburn  4078: =item * $usec: section of the desired student
                   4079: 
                   4080: =item * $identifier: counter for student (multiple students one problem) or
                   4081:     problem (one student; whole sequence).
                   4082: 
1.112     bowersj2 4083: =back
1.14      harris41 4084: 
1.112     bowersj2 4085: The output string is a table containing all desired attempts, if any.
1.16      harris41 4086: 
1.112     bowersj2 4087: =cut
1.1       albertel 4088: 
                   4089: sub get_previous_attempt {
1.1075.2.86  raeburn  4090:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1       albertel 4091:   my $prevattempts='';
1.43      ng       4092:   no strict 'refs';
1.1       albertel 4093:   if ($symb) {
1.3       albertel 4094:     my (%returnhash)=
                   4095:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 4096:     if ($returnhash{'version'}) {
                   4097:       my %lasthash=();
                   4098:       my $version;
                   4099:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.91  raeburn  4100:         foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
                   4101:             if ($key =~ /\.rawrndseed$/) {
                   4102:                 my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
                   4103:                 $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
                   4104:             } else {
                   4105:                 $lasthash{$key}=$returnhash{$version.':'.$key};
                   4106:             }
1.19      harris41 4107:         }
1.1       albertel 4108:       }
1.596     albertel 4109:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   4110:       $prevattempts.='<th>'.&mt('History').'</th>';
1.1075.2.86  raeburn  4111:       my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945     raeburn  4112:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 4113:       foreach my $key (sort(keys(%lasthash))) {
                   4114: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       4115: 	if ($#parts > 0) {
1.31      albertel 4116: 	  my $data=$parts[-1];
1.989     raeburn  4117:           next if ($data eq 'foilorder');
1.31      albertel 4118: 	  pop(@parts);
1.1010    www      4119:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  4120:           if ($data eq 'type') {
                   4121:               unless ($showsurv) {
                   4122:                   my $id = join(',',@parts);
                   4123:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  4124:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   4125:                       $lasthidden{$ign.'.'.$id} = 1;
                   4126:                   }
1.945     raeburn  4127:               }
1.1075.2.86  raeburn  4128:               if ($identifier ne '') {
                   4129:                   my $id = join(',',@parts);
                   4130:                   if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
                   4131:                                                $domain,$username,$usec,undef,$course) =~ /^no/) {
                   4132:                       $hidestatus{$ign.'.'.$id} = 1;
                   4133:                   }
                   4134:               }
                   4135:           } elsif ($data eq 'regrader') {
                   4136:               if (($identifier ne '') && (@parts)) {
                   4137:                   my $id = join(',',@parts);
                   4138:                   $regraded{$ign.'.'.$id} = 1;
                   4139:               }
1.1010    www      4140:           } 
1.31      albertel 4141: 	} else {
1.41      ng       4142: 	  if ($#parts == 0) {
                   4143: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   4144: 	  } else {
                   4145: 	    $prevattempts.='<th>'.$ign.'</th>';
                   4146: 	  }
1.31      albertel 4147: 	}
1.16      harris41 4148:       }
1.596     albertel 4149:       $prevattempts.=&end_data_table_header_row();
1.40      ng       4150:       if ($getattempt eq '') {
1.1075.2.86  raeburn  4151:         my (%solved,%resets,%probstatus);
                   4152:         if (($identifier ne '') && (keys(%regraded) > 0)) {
                   4153:             for ($version=1;$version<=$returnhash{'version'};$version++) {
                   4154:                 foreach my $id (keys(%regraded)) {
                   4155:                     if (($returnhash{$version.':'.$id.'.regrader'}) &&
                   4156:                         ($returnhash{$version.':'.$id.'.tries'} eq '') &&
                   4157:                         ($returnhash{$version.':'.$id.'.award'} eq '')) {
                   4158:                         push(@{$resets{$id}},$version);
                   4159:                     }
                   4160:                 }
                   4161:             }
                   4162:         }
1.40      ng       4163: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1075.2.86  raeburn  4164:             my (@hidden,@unsolved);
1.945     raeburn  4165:             if (%typeparts) {
                   4166:                 foreach my $id (keys(%typeparts)) {
1.1075.2.86  raeburn  4167:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') ||
                   4168:                         ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945     raeburn  4169:                         push(@hidden,$id);
1.1075.2.86  raeburn  4170:                     } elsif ($identifier ne '') {
                   4171:                         unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
                   4172:                                 ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
                   4173:                                 ($hidestatus{$id})) {
                   4174:                             next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
                   4175:                             if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
                   4176:                                 push(@{$solved{$id}},$version);
                   4177:                             } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
                   4178:                                      (ref($solved{$id}) eq 'ARRAY')) {
                   4179:                                 my $skip;
                   4180:                                 if (ref($resets{$id}) eq 'ARRAY') {
                   4181:                                     foreach my $reset (@{$resets{$id}}) {
                   4182:                                         if ($reset > $solved{$id}[-1]) {
                   4183:                                             $skip=1;
                   4184:                                             last;
                   4185:                                         }
                   4186:                                     }
                   4187:                                 }
                   4188:                                 unless ($skip) {
                   4189:                                     my ($ign,$partslist) = split(/\./,$id,2);
                   4190:                                     push(@unsolved,$partslist);
                   4191:                                 }
                   4192:                             }
                   4193:                         }
1.945     raeburn  4194:                     }
                   4195:                 }
                   4196:             }
                   4197:             $prevattempts.=&start_data_table_row().
1.1075.2.86  raeburn  4198:                            '<td>'.&mt('Transaction [_1]',$version);
                   4199:             if (@unsolved) {
                   4200:                 $prevattempts .= '<span class="LC_nobreak"><label>'.
                   4201:                                  '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
                   4202:                                  &mt('Hide').'</label></span>';
                   4203:             }
                   4204:             $prevattempts .= '</td>';
1.945     raeburn  4205:             if (@hidden) {
                   4206:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4207:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  4208:                     my $hide;
                   4209:                     foreach my $id (@hidden) {
                   4210:                         if ($key =~ /^\Q$id\E/) {
                   4211:                             $hide = 1;
                   4212:                             last;
                   4213:                         }
                   4214:                     }
                   4215:                     if ($hide) {
                   4216:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4217:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4218:                             my $value = &format_previous_attempt_value($key,
                   4219:                                              $returnhash{$version.':'.$key});
                   4220:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4221:                         } else {
                   4222:                             $prevattempts.='<td>&nbsp;</td>';
                   4223:                         }
                   4224:                     } else {
                   4225:                         if ($key =~ /\./) {
1.1075.2.91  raeburn  4226:                             my $value = $returnhash{$version.':'.$key};
                   4227:                             if ($key =~ /\.rndseed$/) {
                   4228:                                 my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4229:                                 if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4230:                                     $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4231:                                 }
                   4232:                             }
                   4233:                             $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4234:                                            '&nbsp;</td>';
1.945     raeburn  4235:                         } else {
                   4236:                             $prevattempts.='<td>&nbsp;</td>';
                   4237:                         }
                   4238:                     }
                   4239:                 }
                   4240:             } else {
                   4241: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4242:                     next if ($key =~ /\.foilorder$/);
1.1075.2.91  raeburn  4243:                     my $value = $returnhash{$version.':'.$key};
                   4244:                     if ($key =~ /\.rndseed$/) {
                   4245:                         my ($id) = ($key =~ /^(.+)\.rndseed$/);
                   4246:                         if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   4247:                             $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   4248:                         }
                   4249:                     }
                   4250:                     $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   4251:                                    '&nbsp;</td>';
1.945     raeburn  4252: 	        }
                   4253:             }
                   4254: 	    $prevattempts.=&end_data_table_row();
1.40      ng       4255: 	 }
1.1       albertel 4256:       }
1.945     raeburn  4257:       my @currhidden = keys(%lasthidden);
1.596     albertel 4258:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 4259:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  4260:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  4261:           if (%typeparts) {
                   4262:               my $hidden;
                   4263:               foreach my $id (@currhidden) {
                   4264:                   if ($key =~ /^\Q$id\E/) {
                   4265:                       $hidden = 1;
                   4266:                       last;
                   4267:                   }
                   4268:               }
                   4269:               if ($hidden) {
                   4270:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   4271:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   4272:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4273:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4274:                           $value = &$gradesub($value);
                   4275:                       }
                   4276:                       $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4277:                   } else {
                   4278:                       $prevattempts.='<td>&nbsp;</td>';
                   4279:                   }
                   4280:               } else {
                   4281:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4282:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4283:                       $value = &$gradesub($value);
                   4284:                   }
                   4285:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4286:               }
                   4287:           } else {
                   4288: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   4289: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   4290:                   $value = &$gradesub($value);
                   4291:               }
                   4292: 	      $prevattempts.='<td>'.$value.'&nbsp;</td>';
                   4293:           }
1.16      harris41 4294:       }
1.596     albertel 4295:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 4296:     } else {
1.596     albertel 4297:       $prevattempts=
                   4298: 	  &start_data_table().&start_data_table_row().
                   4299: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   4300: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4301:     }
                   4302:   } else {
1.596     albertel 4303:     $prevattempts=
                   4304: 	  &start_data_table().&start_data_table_row().
                   4305: 	  '<td>'.&mt('No data.').'</td>'.
                   4306: 	  &end_data_table_row().&end_data_table();
1.1       albertel 4307:   }
1.10      albertel 4308: }
                   4309: 
1.581     albertel 4310: sub format_previous_attempt_value {
                   4311:     my ($key,$value) = @_;
1.1011    www      4312:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.581     albertel 4313: 	$value = &Apache::lonlocal::locallocaltime($value);
                   4314:     } elsif (ref($value) eq 'ARRAY') {
                   4315: 	$value = '('.join(', ', @{ $value }).')';
1.988     raeburn  4316:     } elsif ($key =~ /answerstring$/) {
                   4317:         my %answers = &Apache::lonnet::str2hash($value);
                   4318:         my @anskeys = sort(keys(%answers));
                   4319:         if (@anskeys == 1) {
                   4320:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  4321:             if ($answer =~ m{\0}) {
                   4322:                 $answer =~ s{\0}{,}g;
1.988     raeburn  4323:             }
                   4324:             my $tag_internal_answer_name = 'INTERNAL';
                   4325:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   4326:                 $value = $answer; 
                   4327:             } else {
                   4328:                 $value = $anskeys[0].'='.$answer;
                   4329:             }
                   4330:         } else {
                   4331:             foreach my $ans (@anskeys) {
                   4332:                 my $answer = $answers{$ans};
1.1001    raeburn  4333:                 if ($answer =~ m{\0}) {
                   4334:                     $answer =~ s{\0}{,}g;
1.988     raeburn  4335:                 }
                   4336:                 $value .=  $ans.'='.$answer.'<br />';;
                   4337:             } 
                   4338:         }
1.581     albertel 4339:     } else {
                   4340: 	$value = &unescape($value);
                   4341:     }
                   4342:     return $value;
                   4343: }
                   4344: 
                   4345: 
1.107     albertel 4346: sub relative_to_absolute {
                   4347:     my ($url,$output)=@_;
                   4348:     my $parser=HTML::TokeParser->new(\$output);
                   4349:     my $token;
                   4350:     my $thisdir=$url;
                   4351:     my @rlinks=();
                   4352:     while ($token=$parser->get_token) {
                   4353: 	if ($token->[0] eq 'S') {
                   4354: 	    if ($token->[1] eq 'a') {
                   4355: 		if ($token->[2]->{'href'}) {
                   4356: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   4357: 		}
                   4358: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   4359: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   4360: 	    } elsif ($token->[1] eq 'base') {
                   4361: 		$thisdir=$token->[2]->{'href'};
                   4362: 	    }
                   4363: 	}
                   4364:     }
                   4365:     $thisdir=~s-/[^/]*$--;
1.356     albertel 4366:     foreach my $link (@rlinks) {
1.726     raeburn  4367: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 4368: 		($link=~/^\//) ||
                   4369: 		($link=~/^javascript:/i) ||
                   4370: 		($link=~/^mailto:/i) ||
                   4371: 		($link=~/^\#/)) {
                   4372: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   4373: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 4374: 	}
                   4375:     }
                   4376: # -------------------------------------------------- Deal with Applet codebases
                   4377:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   4378:     return $output;
                   4379: }
                   4380: 
1.112     bowersj2 4381: =pod
                   4382: 
1.648     raeburn  4383: =item * &get_student_view()
1.112     bowersj2 4384: 
                   4385: show a snapshot of what student was looking at
                   4386: 
                   4387: =cut
                   4388: 
1.10      albertel 4389: sub get_student_view {
1.186     albertel 4390:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      4391:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4392:   my (%form);
1.10      albertel 4393:   my @elements=('symb','courseid','domain','username');
                   4394:   foreach my $element (@elements) {
1.186     albertel 4395:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4396:   }
1.186     albertel 4397:   if (defined($moreenv)) {
                   4398:       %form=(%form,%{$moreenv});
                   4399:   }
1.236     albertel 4400:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 4401:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      4402:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 4403:   $userview=~s/\<body[^\>]*\>//gi;
                   4404:   $userview=~s/\<\/body\>//gi;
                   4405:   $userview=~s/\<html\>//gi;
                   4406:   $userview=~s/\<\/html\>//gi;
                   4407:   $userview=~s/\<head\>//gi;
                   4408:   $userview=~s/\<\/head\>//gi;
                   4409:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 4410:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      4411:   if (wantarray) {
                   4412:      return ($userview,$response);
                   4413:   } else {
                   4414:      return $userview;
                   4415:   }
                   4416: }
                   4417: 
                   4418: sub get_student_view_with_retries {
                   4419:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   4420: 
                   4421:     my $ok = 0;                 # True if we got a good response.
                   4422:     my $content;
                   4423:     my $response;
                   4424: 
                   4425:     # Try to get the student_view done. within the retries count:
                   4426:     
                   4427:     do {
                   4428:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   4429:          $ok      = $response->is_success;
                   4430:          if (!$ok) {
                   4431:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   4432:          }
                   4433:          $retries--;
                   4434:     } while (!$ok && ($retries > 0));
                   4435:     
                   4436:     if (!$ok) {
                   4437:        $content = '';          # On error return an empty content.
                   4438:     }
1.651     www      4439:     if (wantarray) {
                   4440:        return ($content, $response);
                   4441:     } else {
                   4442:        return $content;
                   4443:     }
1.11      albertel 4444: }
                   4445: 
1.1075.2.149  raeburn  4446: sub css_links {
                   4447:     my ($currsymb,$level) = @_;
                   4448:     my ($links,@symbs,%cssrefs,%httpref);
                   4449:     if ($level eq 'map') {
                   4450:         my $navmap = Apache::lonnavmaps::navmap->new();
                   4451:         if (ref($navmap)) {
                   4452:             my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
                   4453:             my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
                   4454:             foreach my $res (@resources) {
                   4455:                 if (ref($res) && $res->symb()) {
                   4456:                     push(@symbs,$res->symb());
                   4457:                 }
                   4458:             }
                   4459:         }
                   4460:     } else {
                   4461:         @symbs = ($currsymb);
                   4462:     }
                   4463:     foreach my $symb (@symbs) {
                   4464:         my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
                   4465:         if ($css_href =~ /\S/) {
                   4466:             unless ($css_href =~ m{https?://}) {
                   4467:                 my $url = (&Apache::lonnet::decode_symb($symb))[-1];
                   4468:                 my $proburl =  &Apache::lonnet::clutter($url);
                   4469:                 my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
                   4470:                 unless ($css_href =~ m{^/}) {
                   4471:                     $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
                   4472:                 }
                   4473:                 if ($css_href =~ m{^/(res|uploaded)/}) {
                   4474:                     unless (($httpref{'httpref.'.$css_href}) ||
                   4475:                             (&Apache::lonnet::is_on_map($css_href))) {
                   4476:                         my $thisurl = $proburl;
                   4477:                         if ($env{'httpref.'.$proburl}) {
                   4478:                             $thisurl = $env{'httpref.'.$proburl};
                   4479:                         }
                   4480:                         $httpref{'httpref.'.$css_href} = $thisurl;
                   4481:                     }
                   4482:                 }
                   4483:             }
                   4484:             $cssrefs{$css_href} = 1;
                   4485:         }
                   4486:     }
                   4487:     if (keys(%httpref)) {
                   4488:         &Apache::lonnet::appenv(\%httpref);
                   4489:     }
                   4490:     if (keys(%cssrefs)) {
                   4491:         foreach my $css_href (keys(%cssrefs)) {
                   4492:             next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
                   4493:             $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
                   4494:         }
                   4495:     }
                   4496:     return $links;
                   4497: }
                   4498: 
1.112     bowersj2 4499: =pod
                   4500: 
1.648     raeburn  4501: =item * &get_student_answers() 
1.112     bowersj2 4502: 
                   4503: show a snapshot of how student was answering problem
                   4504: 
                   4505: =cut
                   4506: 
1.11      albertel 4507: sub get_student_answers {
1.100     sakharuk 4508:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      4509:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 4510:   my (%moreenv);
1.11      albertel 4511:   my @elements=('symb','courseid','domain','username');
                   4512:   foreach my $element (@elements) {
1.186     albertel 4513:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 4514:   }
1.186     albertel 4515:   $moreenv{'grade_target'}='answer';
                   4516:   %moreenv=(%form,%moreenv);
1.497     raeburn  4517:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   4518:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 4519:   return $userview;
1.1       albertel 4520: }
1.116     albertel 4521: 
                   4522: =pod
                   4523: 
                   4524: =item * &submlink()
                   4525: 
1.242     albertel 4526: Inputs: $text $uname $udom $symb $target
1.116     albertel 4527: 
                   4528: Returns: A link to grades.pm such as to see the SUBM view of a student
                   4529: 
                   4530: =cut
                   4531: 
                   4532: ###############################################
                   4533: sub submlink {
1.242     albertel 4534:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 4535:     if (!($uname && $udom)) {
                   4536: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4537: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 4538: 	if (!$symb) { $symb=$cursymb; }
                   4539:     }
1.254     matthew  4540:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4541:     $symb=&escape($symb);
1.960     bisitz   4542:     if ($target) { $target=" target=\"$target\""; }
                   4543:     return
                   4544:         '<a href="/adm/grades?command=submission'.
                   4545:         '&amp;symb='.$symb.
                   4546:         '&amp;student='.$uname.
                   4547:         '&amp;userdom='.$udom.'"'.
                   4548:         $target.'>'.$text.'</a>';
1.242     albertel 4549: }
                   4550: ##############################################
                   4551: 
                   4552: =pod
                   4553: 
                   4554: =item * &pgrdlink()
                   4555: 
                   4556: Inputs: $text $uname $udom $symb $target
                   4557: 
                   4558: Returns: A link to grades.pm such as to see the PGRD view of a student
                   4559: 
                   4560: =cut
                   4561: 
                   4562: ###############################################
                   4563: sub pgrdlink {
                   4564:     my $link=&submlink(@_);
                   4565:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   4566:     return $link;
                   4567: }
                   4568: ##############################################
                   4569: 
                   4570: =pod
                   4571: 
                   4572: =item * &pprmlink()
                   4573: 
                   4574: Inputs: $text $uname $udom $symb $target
                   4575: 
                   4576: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 4577: student and a specific resource
1.242     albertel 4578: 
                   4579: =cut
                   4580: 
                   4581: ###############################################
                   4582: sub pprmlink {
                   4583:     my ($text,$uname,$udom,$symb,$target)=@_;
                   4584:     if (!($uname && $udom)) {
                   4585: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 4586: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 4587: 	if (!$symb) { $symb=$cursymb; }
                   4588:     }
1.254     matthew  4589:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      4590:     $symb=&escape($symb);
1.242     albertel 4591:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 4592:     return '<a href="/adm/parmset?command=set&amp;'.
                   4593: 	'symb='.$symb.'&amp;uname='.$uname.
                   4594: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 4595: }
                   4596: ##############################################
1.37      matthew  4597: 
1.112     bowersj2 4598: =pod
                   4599: 
                   4600: =back
                   4601: 
                   4602: =cut
                   4603: 
1.37      matthew  4604: ###############################################
1.51      www      4605: 
                   4606: 
                   4607: sub timehash {
1.687     raeburn  4608:     my ($thistime) = @_;
                   4609:     my $timezone = &Apache::lonlocal::gettimezone();
                   4610:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   4611:                      ->set_time_zone($timezone);
                   4612:     my $wday = $dt->day_of_week();
                   4613:     if ($wday == 7) { $wday = 0; }
                   4614:     return ( 'second' => $dt->second(),
                   4615:              'minute' => $dt->minute(),
                   4616:              'hour'   => $dt->hour(),
                   4617:              'day'     => $dt->day_of_month(),
                   4618:              'month'   => $dt->month(),
                   4619:              'year'    => $dt->year(),
                   4620:              'weekday' => $wday,
                   4621:              'dayyear' => $dt->day_of_year(),
                   4622:              'dlsav'   => $dt->is_dst() );
1.51      www      4623: }
                   4624: 
1.370     www      4625: sub utc_string {
                   4626:     my ($date)=@_;
1.371     www      4627:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      4628: }
                   4629: 
1.51      www      4630: sub maketime {
                   4631:     my %th=@_;
1.687     raeburn  4632:     my ($epoch_time,$timezone,$dt);
                   4633:     $timezone = &Apache::lonlocal::gettimezone();
                   4634:     eval {
                   4635:         $dt = DateTime->new( year   => $th{'year'},
                   4636:                              month  => $th{'month'},
                   4637:                              day    => $th{'day'},
                   4638:                              hour   => $th{'hour'},
                   4639:                              minute => $th{'minute'},
                   4640:                              second => $th{'second'},
                   4641:                              time_zone => $timezone,
                   4642:                          );
                   4643:     };
                   4644:     if (!$@) {
                   4645:         $epoch_time = $dt->epoch;
                   4646:         if ($epoch_time) {
                   4647:             return $epoch_time;
                   4648:         }
                   4649:     }
1.51      www      4650:     return POSIX::mktime(
                   4651:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      4652:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      4653: }
                   4654: 
                   4655: #########################################
1.51      www      4656: 
                   4657: sub findallcourses {
1.482     raeburn  4658:     my ($roles,$uname,$udom) = @_;
1.355     albertel 4659:     my %roles;
                   4660:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 4661:     my %courses;
1.51      www      4662:     my $now=time;
1.482     raeburn  4663:     if (!defined($uname)) {
                   4664:         $uname = $env{'user.name'};
                   4665:     }
                   4666:     if (!defined($udom)) {
                   4667:         $udom = $env{'user.domain'};
                   4668:     }
                   4669:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  4670:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  4671:         if (!%roles) {
                   4672:             %roles = (
                   4673:                        cc => 1,
1.907     raeburn  4674:                        co => 1,
1.482     raeburn  4675:                        in => 1,
                   4676:                        ep => 1,
                   4677:                        ta => 1,
                   4678:                        cr => 1,
                   4679:                        st => 1,
                   4680:              );
                   4681:         }
                   4682:         foreach my $entry (keys(%roleshash)) {
                   4683:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   4684:             if ($trole =~ /^cr/) { 
                   4685:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   4686:             } else {
                   4687:                 next if (!exists($roles{$trole}));
                   4688:             }
                   4689:             if ($tend) {
                   4690:                 next if ($tend < $now);
                   4691:             }
                   4692:             if ($tstart) {
                   4693:                 next if ($tstart > $now);
                   4694:             }
1.1058    raeburn  4695:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  4696:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  4697:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  4698:             if ($secpart eq '') {
                   4699:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   4700:                 $sec = 'none';
1.1058    raeburn  4701:                 $value .= $cnum.'/';
1.482     raeburn  4702:             } else {
                   4703:                 $cnum = $cnumpart;
                   4704:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  4705:                 $value .= $cnum.'/'.$sec;
                   4706:             }
                   4707:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4708:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4709:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4710:                 }
                   4711:             } else {
                   4712:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  4713:             }
1.482     raeburn  4714:         }
                   4715:     } else {
                   4716:         foreach my $key (keys(%env)) {
1.483     albertel 4717: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   4718:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  4719: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   4720: 	        next if ($role eq 'ca' || $role eq 'aa');
                   4721: 	        next if (%roles && !exists($roles{$role}));
                   4722: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   4723:                 my $active=1;
                   4724:                 if ($starttime) {
                   4725: 		    if ($now<$starttime) { $active=0; }
                   4726:                 }
                   4727:                 if ($endtime) {
                   4728:                     if ($now>$endtime) { $active=0; }
                   4729:                 }
                   4730:                 if ($active) {
1.1058    raeburn  4731:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  4732:                     if ($sec eq '') {
                   4733:                         $sec = 'none';
1.1058    raeburn  4734:                     } else {
                   4735:                         $value .= $sec;
                   4736:                     }
                   4737:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   4738:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   4739:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   4740:                         }
                   4741:                     } else {
                   4742:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  4743:                     }
1.474     raeburn  4744:                 }
                   4745:             }
1.51      www      4746:         }
                   4747:     }
1.474     raeburn  4748:     return %courses;
1.51      www      4749: }
1.37      matthew  4750: 
1.54      www      4751: ###############################################
1.474     raeburn  4752: 
                   4753: sub blockcheck {
1.1075.2.158  raeburn  4754:     my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.490     raeburn  4755: 
1.1075.2.158  raeburn  4756:     unless ($activity eq 'docs') {
                   4757:         my ($has_evb,$check_ipaccess);
                   4758:         my $dom = $env{'user.domain'};
                   4759:         if ($env{'request.course.id'}) {
                   4760:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   4761:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   4762:             my $checkrole = "cm./$cdom/$cnum";
                   4763:             my $sec = $env{'request.course.sec'};
                   4764:             if ($sec ne '') {
                   4765:                 $checkrole .= "/$sec";
                   4766:             }
                   4767:             if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   4768:                 ($env{'request.role'} !~ /^st/)) {
                   4769:                 $has_evb = 1;
                   4770:             }
                   4771:             unless ($has_evb) {
                   4772:                 if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
                   4773:                     ($activity eq 'boards') || ($activity eq 'groups') || ($activity eq 'chat')) {
                   4774:                     if ($udom eq $cdom) {
                   4775:                         $check_ipaccess = 1;
                   4776:                     }
                   4777:                 }
                   4778:             }
1.1075.2.163  raeburn  4779:         } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
                   4780:                 ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
                   4781:             my $checkrole;
                   4782:             if ($env{'request.role.domain'} eq '') {
                   4783:                 $checkrole = "cm./$env{'user.domain'}/";
                   4784:             } else {
                   4785:                 $checkrole = "cm./$env{'request.role.domain'}/";
                   4786:             }
                   4787:             if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
                   4788:                 $has_evb = 1;
                   4789:             }
1.1075.2.158  raeburn  4790:         }
                   4791:         unless ($has_evb || $check_ipaccess) {
                   4792:             my @machinedoms = &Apache::lonnet::current_machine_domains();
                   4793:             if (($dom eq 'public') && ($activity eq 'port')) {
                   4794:                 $dom = $udom;
                   4795:             }
                   4796:             if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
                   4797:                 $check_ipaccess = 1;
                   4798:             } else {
                   4799:                 my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   4800:                 my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
                   4801:                 my $prim = &Apache::lonnet::domain($dom,'primary');
                   4802:                 my $intdom = &Apache::lonnet::internet_dom($prim);
                   4803:                 if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
                   4804:                     if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
                   4805:                         $check_ipaccess = 1;
                   4806:                     }
                   4807:                 }
                   4808:             }
                   4809:         }
                   4810:         if ($check_ipaccess) {
                   4811:             my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
                   4812:             unless (defined($cached)) {
                   4813:                 my %domconfig =
                   4814:                     &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
                   4815:                 $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
                   4816:             }
                   4817:             if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
                   4818:                 foreach my $id (keys(%{$ipaccessref})) {
                   4819:                     if (ref($ipaccessref->{$id}) eq 'HASH') {
                   4820:                         my $range = $ipaccessref->{$id}->{'ip'};
                   4821:                         if ($range) {
                   4822:                             if (&Apache::lonnet::ip_match($clientip,$range)) {
                   4823:                                 if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
                   4824:                                     if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
                   4825:                                         return ('','','',$id,$dom);
                   4826:                                         last;
                   4827:                                     }
                   4828:                                 }
                   4829:                             }
                   4830:                         }
                   4831:                     }
                   4832:                 }
                   4833:             }
                   4834:         }
1.1075.2.164  raeburn  4835:         if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
                   4836:             return ();
                   4837:         }
1.1075.2.158  raeburn  4838:     }
1.1075.2.73  raeburn  4839:     if (defined($udom) && defined($uname)) {
                   4840:         # If uname and udom are for a course, check for blocks in the course.
                   4841:         if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
                   4842:             my ($startblock,$endblock,$triggerblock) =
1.1075.2.147  raeburn  4843:                 &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1075.2.73  raeburn  4844:             return ($startblock,$endblock,$triggerblock);
                   4845:         }
                   4846:     } else {
1.490     raeburn  4847:         $udom = $env{'user.domain'};
                   4848:         $uname = $env{'user.name'};
                   4849:     }
                   4850: 
1.502     raeburn  4851:     my $startblock = 0;
                   4852:     my $endblock = 0;
1.1062    raeburn  4853:     my $triggerblock = '';
1.1075.2.160  raeburn  4854:     my %live_courses;
                   4855:     unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
                   4856:         %live_courses = &findallcourses(undef,$uname,$udom);
                   4857:     }
1.474     raeburn  4858: 
1.490     raeburn  4859:     # If uname is for a user, and activity is course-specific, i.e.,
                   4860:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  4861: 
1.490     raeburn  4862:     if (($activity eq 'boards' || $activity eq 'chat' ||
1.1075.2.73  raeburn  4863:          $activity eq 'groups' || $activity eq 'printout') &&
                   4864:         ($env{'request.course.id'})) {
1.490     raeburn  4865:         foreach my $key (keys(%live_courses)) {
                   4866:             if ($key ne $env{'request.course.id'}) {
                   4867:                 delete($live_courses{$key});
                   4868:             }
                   4869:         }
                   4870:     }
                   4871: 
                   4872:     my $otheruser = 0;
                   4873:     my %own_courses;
                   4874:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   4875:         # Resource belongs to user other than current user.
                   4876:         $otheruser = 1;
                   4877:         # Gather courses for current user
                   4878:         %own_courses = 
                   4879:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   4880:     }
                   4881: 
                   4882:     # Gather active course roles - course coordinator, instructor, 
                   4883:     # exam proctor, ta, student, or custom role.
1.474     raeburn  4884: 
                   4885:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  4886:         my ($cdom,$cnum);
                   4887:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   4888:             $cdom = $env{'course.'.$course.'.domain'};
                   4889:             $cnum = $env{'course.'.$course.'.num'};
                   4890:         } else {
1.490     raeburn  4891:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  4892:         }
                   4893:         my $no_ownblock = 0;
                   4894:         my $no_userblock = 0;
1.533     raeburn  4895:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  4896:             # Check if current user has 'evb' priv for this
                   4897:             if (defined($own_courses{$course})) {
                   4898:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   4899:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   4900:                     if ($sec ne 'none') {
                   4901:                         $checkrole .= '/'.$sec;
                   4902:                     }
                   4903:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4904:                         $no_ownblock = 1;
                   4905:                         last;
                   4906:                     }
                   4907:                 }
                   4908:             }
                   4909:             # if they have 'evb' priv and are currently not playing student
                   4910:             next if (($no_ownblock) &&
                   4911:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   4912:         }
1.474     raeburn  4913:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  4914:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  4915:             if ($sec ne 'none') {
1.482     raeburn  4916:                 $checkrole .= '/'.$sec;
1.474     raeburn  4917:             }
1.490     raeburn  4918:             if ($otheruser) {
                   4919:                 # Resource belongs to user other than current user.
                   4920:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  4921:                 my (%allroles,%userroles);
                   4922:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   4923:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   4924:                         my ($trole,$tdom,$tnum,$tsec);
                   4925:                         if ($entry =~ /^cr/) {
                   4926:                             ($trole,$tdom,$tnum,$tsec) = 
                   4927:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   4928:                         } else {
                   4929:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   4930:                         }
                   4931:                         my ($spec,$area,$trest);
                   4932:                         $area = '/'.$tdom.'/'.$tnum;
                   4933:                         $trest = $tnum;
                   4934:                         if ($tsec ne '') {
                   4935:                             $area .= '/'.$tsec;
                   4936:                             $trest .= '/'.$tsec;
                   4937:                         }
                   4938:                         $spec = $trole.'.'.$area;
                   4939:                         if ($trole =~ /^cr/) {
                   4940:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   4941:                                                               $tdom,$spec,$trest,$area);
                   4942:                         } else {
                   4943:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   4944:                                                                 $tdom,$spec,$trest,$area);
                   4945:                         }
                   4946:                     }
1.1075.2.124  raeburn  4947:                     my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058    raeburn  4948:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   4949:                         if ($1) {
                   4950:                             $no_userblock = 1;
                   4951:                             last;
                   4952:                         }
1.486     raeburn  4953:                     }
                   4954:                 }
1.490     raeburn  4955:             } else {
                   4956:                 # Resource belongs to current user
                   4957:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  4958:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   4959:                     $no_ownblock = 1;
                   4960:                     last;
                   4961:                 }
1.474     raeburn  4962:             }
                   4963:         }
                   4964:         # if they have the evb priv and are currently not playing student
1.482     raeburn  4965:         next if (($no_ownblock) &&
1.491     albertel 4966:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  4967:         next if ($no_userblock);
1.474     raeburn  4968: 
1.1075.2.128  raeburn  4969:         # Retrieve blocking times and identity of blocker for course
1.490     raeburn  4970:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  4971:         
1.1062    raeburn  4972:         my ($start,$end,$trigger) = 
1.1075.2.147  raeburn  4973:             &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502     raeburn  4974:         if (($start != 0) && 
                   4975:             (($startblock == 0) || ($startblock > $start))) {
                   4976:             $startblock = $start;
1.1062    raeburn  4977:             if ($trigger ne '') {
                   4978:                 $triggerblock = $trigger;
                   4979:             }
1.502     raeburn  4980:         }
                   4981:         if (($end != 0)  &&
                   4982:             (($endblock == 0) || ($endblock < $end))) {
                   4983:             $endblock = $end;
1.1062    raeburn  4984:             if ($trigger ne '') {
                   4985:                 $triggerblock = $trigger;
                   4986:             }
1.502     raeburn  4987:         }
1.490     raeburn  4988:     }
1.1062    raeburn  4989:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  4990: }
                   4991: 
                   4992: sub get_blocks {
1.1075.2.147  raeburn  4993:     my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490     raeburn  4994:     my $startblock = 0;
                   4995:     my $endblock = 0;
1.1062    raeburn  4996:     my $triggerblock = '';
1.490     raeburn  4997:     my $course = $cdom.'_'.$cnum;
                   4998:     $setters->{$course} = {};
                   4999:     $setters->{$course}{'staff'} = [];
                   5000:     $setters->{$course}{'times'} = [];
1.1062    raeburn  5001:     $setters->{$course}{'triggers'} = [];
                   5002:     my (@blockers,%triggered);
                   5003:     my $now = time;
                   5004:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   5005:     if ($activity eq 'docs') {
1.1075.2.148  raeburn  5006:         my ($blocked,$nosymbcache,$noenccheck);
1.1075.2.147  raeburn  5007:         if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
                   5008:             $blocked = 1;
                   5009:             $nosymbcache = 1;
1.1075.2.148  raeburn  5010:             $noenccheck = 1;
1.1075.2.147  raeburn  5011:         }
1.1075.2.148  raeburn  5012:         @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062    raeburn  5013:         foreach my $block (@blockers) {
                   5014:             if ($block =~ /^firstaccess____(.+)$/) {
                   5015:                 my $item = $1;
                   5016:                 my $type = 'map';
                   5017:                 my $timersymb = $item;
                   5018:                 if ($item eq 'course') {
                   5019:                     $type = 'course';
                   5020:                 } elsif ($item =~ /___\d+___/) {
                   5021:                     $type = 'resource';
                   5022:                 } else {
                   5023:                     $timersymb = &Apache::lonnet::symbread($item);
                   5024:                 }
                   5025:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   5026:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   5027:                 $triggered{$block} = {
                   5028:                                        start => $start,
                   5029:                                        end   => $end,
                   5030:                                        type  => $type,
                   5031:                                      };
                   5032:             }
                   5033:         }
                   5034:     } else {
                   5035:         foreach my $block (keys(%commblocks)) {
                   5036:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   5037:                 my ($start,$end) = ($1,$2);
                   5038:                 if ($start <= time && $end >= time) {
                   5039:                     if (ref($commblocks{$block}) eq 'HASH') {
                   5040:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   5041:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   5042:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   5043:                                     push(@blockers,$block);
                   5044:                                 }
                   5045:                             }
                   5046:                         }
                   5047:                     }
                   5048:                 }
                   5049:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   5050:                 my $item = $1;
                   5051:                 my $timersymb = $item; 
                   5052:                 my $type = 'map';
                   5053:                 if ($item eq 'course') {
                   5054:                     $type = 'course';
                   5055:                 } elsif ($item =~ /___\d+___/) {
                   5056:                     $type = 'resource';
                   5057:                 } else {
                   5058:                     $timersymb = &Apache::lonnet::symbread($item);
                   5059:                 }
                   5060:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   5061:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   5062:                 if ($start && $end) {
                   5063:                     if (($start <= time) && ($end >= time)) {
1.1075.2.158  raeburn  5064:                         if (ref($commblocks{$block}) eq 'HASH') {
                   5065:                             if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   5066:                                 if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   5067:                                     unless(grep(/^\Q$block\E$/,@blockers)) {
                   5068:                                         push(@blockers,$block);
                   5069:                                         $triggered{$block} = {
                   5070:                                                                start => $start,
                   5071:                                                                end   => $end,
                   5072:                                                                type  => $type,
                   5073:                                                              };
                   5074:                                     }
                   5075:                                 }
                   5076:                             }
1.1062    raeburn  5077:                         }
                   5078:                     }
1.490     raeburn  5079:                 }
1.1062    raeburn  5080:             }
                   5081:         }
                   5082:     }
                   5083:     foreach my $blocker (@blockers) {
                   5084:         my ($staff_name,$staff_dom,$title,$blocks) =
                   5085:             &parse_block_record($commblocks{$blocker});
                   5086:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   5087:         my ($start,$end,$triggertype);
                   5088:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   5089:             ($start,$end) = ($1,$2);
                   5090:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   5091:             $start = $triggered{$blocker}{'start'};
                   5092:             $end = $triggered{$blocker}{'end'};
                   5093:             $triggertype = $triggered{$blocker}{'type'};
                   5094:         }
                   5095:         if ($start) {
                   5096:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   5097:             if ($triggertype) {
                   5098:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   5099:             } else {
                   5100:                 push(@{$$setters{$course}{'triggers'}},0);
                   5101:             }
                   5102:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   5103:                 $startblock = $start;
                   5104:                 if ($triggertype) {
                   5105:                     $triggerblock = $blocker;
1.474     raeburn  5106:                 }
                   5107:             }
1.1062    raeburn  5108:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   5109:                $endblock = $end;
                   5110:                if ($triggertype) {
                   5111:                    $triggerblock = $blocker;
                   5112:                }
                   5113:             }
1.474     raeburn  5114:         }
                   5115:     }
1.1062    raeburn  5116:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  5117: }
                   5118: 
                   5119: sub parse_block_record {
                   5120:     my ($record) = @_;
                   5121:     my ($setuname,$setudom,$title,$blocks);
                   5122:     if (ref($record) eq 'HASH') {
                   5123:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   5124:         $title = &unescape($record->{'event'});
                   5125:         $blocks = $record->{'blocks'};
                   5126:     } else {
                   5127:         my @data = split(/:/,$record,3);
                   5128:         if (scalar(@data) eq 2) {
                   5129:             $title = $data[1];
                   5130:             ($setuname,$setudom) = split(/@/,$data[0]);
                   5131:         } else {
                   5132:             ($setuname,$setudom,$title) = @data;
                   5133:         }
                   5134:         $blocks = { 'com' => 'on' };
                   5135:     }
                   5136:     return ($setuname,$setudom,$title,$blocks);
                   5137: }
                   5138: 
1.854     kalberla 5139: sub blocking_status {
1.1075.2.158  raeburn  5140:     my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061    raeburn  5141:     my %setters;
1.890     droeschl 5142: 
1.1061    raeburn  5143: # check for active blocking
1.1075.2.158  raeburn  5144:     if ($clientip eq '') {
                   5145:         $clientip = &Apache::lonnet::get_requestor_ip();
                   5146:     }
                   5147:     my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) = 
                   5148:         &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062    raeburn  5149:     my $blocked = 0;
1.1075.2.158  raeburn  5150:     if (($startblock && $endblock) || ($by_ip)) {
1.1062    raeburn  5151:         $blocked = 1;
                   5152:     }
1.890     droeschl 5153: 
1.1061    raeburn  5154: # caller just wants to know whether a block is active
                   5155:     if (!wantarray) { return $blocked; }
                   5156: 
                   5157: # build a link to a popup window containing the details
                   5158:     my $querystring  = "?activity=$activity";
1.1075.2.158  raeburn  5159: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
                   5160:     if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1075.2.97  raeburn  5161:         $querystring .= "&amp;udom=$udom"      if ($udom =~ /^$match_domain$/);
                   5162:         $querystring .= "&amp;uname=$uname"    if ($uname =~ /^$match_username$/);
1.1062    raeburn  5163:     } elsif ($activity eq 'docs') {
1.1075.2.147  raeburn  5164:         my $showurl = &Apache::lonenc::check_encrypt($url);
                   5165:         $querystring .= '&amp;url='.&HTML::Entities::encode($showurl,'\'&"<>');
                   5166:         if ($symb) {
                   5167:             my $showsymb = &Apache::lonenc::check_encrypt($symb);
                   5168:             $querystring .= '&amp;symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
                   5169:         }
1.1062    raeburn  5170:     }
1.1061    raeburn  5171: 
                   5172:     my $output .= <<'END_MYBLOCK';
                   5173: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   5174:     var options = "width=" + w + ",height=" + h + ",";
                   5175:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   5176:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   5177:     var newWin = window.open(url, wdwName, options);
                   5178:     newWin.focus();
                   5179: }
1.890     droeschl 5180: END_MYBLOCK
1.854     kalberla 5181: 
1.1061    raeburn  5182:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 5183:   
1.1061    raeburn  5184:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  5185:     my $text = &mt('Communication Blocked');
1.1075.2.93  raeburn  5186:     my $class = 'LC_comblock';
1.1062    raeburn  5187:     if ($activity eq 'docs') {
                   5188:         $text = &mt('Content Access Blocked');
1.1075.2.93  raeburn  5189:         $class = '';
1.1063    raeburn  5190:     } elsif ($activity eq 'printout') {
                   5191:         $text = &mt('Printing Blocked');
1.1075.2.97  raeburn  5192:     } elsif ($activity eq 'passwd') {
                   5193:         $text = &mt('Password Changing Blocked');
1.1075.2.158  raeburn  5194:     } elsif ($activity eq 'grades') {
                   5195:         $text = &mt('Gradebook Blocked');
                   5196:     } elsif ($activity eq 'search') {
                   5197:         $text = &mt('Search Blocked');
                   5198:     } elsif ($activity eq 'about') {
                   5199:         $text = &mt('Access to User Information Pages Blocked');
1.1075.2.160  raeburn  5200:     } elsif ($activity eq 'wishlist') {
                   5201:         $text = &mt('Access to Stored Links Blocked');
                   5202:     } elsif ($activity eq 'annotate') {
                   5203:         $text = &mt('Access to Annotations Blocked');
1.1062    raeburn  5204:     }
1.1061    raeburn  5205:     $output .= <<"END_BLOCK";
1.1075.2.93  raeburn  5206: <div class='$class'>
1.869     kalberla 5207:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 5208:   title='$text'>
                   5209:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 5210:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 5211:   title='$text'>$text</a>
1.867     kalberla 5212: </div>
                   5213: 
                   5214: END_BLOCK
1.474     raeburn  5215: 
1.1061    raeburn  5216:     return ($blocked, $output);
1.854     kalberla 5217: }
1.490     raeburn  5218: 
1.60      matthew  5219: ###############################################
                   5220: 
1.682     raeburn  5221: sub check_ip_acc {
1.1075.2.105  raeburn  5222:     my ($acc,$clientip)=@_;
1.682     raeburn  5223:     &Apache::lonxml::debug("acc is $acc");
                   5224:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   5225:         return 1;
                   5226:     }
                   5227:     my $allowed=0;
1.1075.2.144  raeburn  5228:     my $ip;
                   5229:     if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
                   5230:         ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
                   5231:         $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
                   5232:     } else {
1.1075.2.150  raeburn  5233:         my $remote_ip = &Apache::lonnet::get_requestor_ip();
                   5234:         $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1075.2.144  raeburn  5235:     }
1.682     raeburn  5236: 
                   5237:     my $name;
                   5238:     foreach my $pattern (split(',',$acc)) {
                   5239:         $pattern =~ s/^\s*//;
                   5240:         $pattern =~ s/\s*$//;
                   5241:         if ($pattern =~ /\*$/) {
                   5242:             #35.8.*
                   5243:             $pattern=~s/\*//;
                   5244:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   5245:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   5246:             #35.8.3.[34-56]
                   5247:             my $low=$2;
                   5248:             my $high=$3;
                   5249:             $pattern=$1;
                   5250:             if ($ip =~ /^\Q$pattern\E/) {
                   5251:                 my $last=(split(/\./,$ip))[3];
                   5252:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   5253:             }
                   5254:         } elsif ($pattern =~ /^\*/) {
                   5255:             #*.msu.edu
                   5256:             $pattern=~s/\*//;
                   5257:             if (!defined($name)) {
                   5258:                 use Socket;
                   5259:                 my $netaddr=inet_aton($ip);
                   5260:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5261:             }
                   5262:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   5263:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   5264:             #127.0.0.1
                   5265:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   5266:         } else {
                   5267:             #some.name.com
                   5268:             if (!defined($name)) {
                   5269:                 use Socket;
                   5270:                 my $netaddr=inet_aton($ip);
                   5271:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   5272:             }
                   5273:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   5274:         }
                   5275:         if ($allowed) { last; }
                   5276:     }
                   5277:     return $allowed;
                   5278: }
                   5279: 
                   5280: ###############################################
                   5281: 
1.60      matthew  5282: =pod
                   5283: 
1.112     bowersj2 5284: =head1 Domain Template Functions
                   5285: 
                   5286: =over 4
                   5287: 
                   5288: =item * &determinedomain()
1.60      matthew  5289: 
                   5290: Inputs: $domain (usually will be undef)
                   5291: 
1.63      www      5292: Returns: Determines which domain should be used for designs
1.60      matthew  5293: 
                   5294: =cut
1.54      www      5295: 
1.60      matthew  5296: ###############################################
1.63      www      5297: sub determinedomain {
                   5298:     my $domain=shift;
1.531     albertel 5299:     if (! $domain) {
1.60      matthew  5300:         # Determine domain if we have not been given one
1.893     raeburn  5301:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 5302:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   5303:         if ($env{'request.role.domain'}) { 
                   5304:             $domain=$env{'request.role.domain'}; 
1.60      matthew  5305:         }
                   5306:     }
1.63      www      5307:     return $domain;
                   5308: }
                   5309: ###############################################
1.517     raeburn  5310: 
1.518     albertel 5311: sub devalidate_domconfig_cache {
                   5312:     my ($udom)=@_;
                   5313:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   5314: }
                   5315: 
                   5316: # ---------------------- Get domain configuration for a domain
                   5317: sub get_domainconf {
                   5318:     my ($udom) = @_;
                   5319:     my $cachetime=1800;
                   5320:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   5321:     if (defined($cached)) { return %{$result}; }
                   5322: 
                   5323:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  5324: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  5325:     my (%designhash,%legacy);
1.518     albertel 5326:     if (keys(%domconfig) > 0) {
                   5327:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  5328:             if (keys(%{$domconfig{'login'}})) {
                   5329:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  5330:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1075.2.87  raeburn  5331:                         if (($key eq 'loginvia') || ($key eq 'headtag')) {
                   5332:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   5333:                                 foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
                   5334:                                     if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
                   5335:                                         if ($key eq 'loginvia') {
                   5336:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   5337:                                                 my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   5338:                                                 $designhash{$udom.'.login.loginvia'} = $server;
                   5339:                                                 if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   5340:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   5341:                                                 } else {
                   5342:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   5343:                                                 }
1.948     raeburn  5344:                                             }
1.1075.2.87  raeburn  5345:                                         } elsif ($key eq 'headtag') {
                   5346:                                             if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
                   5347:                                                 $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948     raeburn  5348:                                             }
1.946     raeburn  5349:                                         }
1.1075.2.87  raeburn  5350:                                         if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
                   5351:                                             $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
                   5352:                                         }
1.946     raeburn  5353:                                     }
                   5354:                                 }
                   5355:                             }
1.1075.2.158  raeburn  5356:                         } elsif ($key eq 'saml') {
                   5357:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   5358:                                 foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
                   5359:                                     if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
                   5360:                                         $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
                   5361:                                         foreach my $item ('text','img','alt','url','title','notsso') {
                   5362:                                             $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
                   5363:                                         }
                   5364:                                     }
                   5365:                                 }
                   5366:                             }
1.946     raeburn  5367:                         } else {
                   5368:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   5369:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   5370:                                     $domconfig{'login'}{$key}{$img};
                   5371:                             }
1.699     raeburn  5372:                         }
                   5373:                     } else {
                   5374:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   5375:                     }
1.632     raeburn  5376:                 }
                   5377:             } else {
                   5378:                 $legacy{'login'} = 1;
1.518     albertel 5379:             }
1.632     raeburn  5380:         } else {
                   5381:             $legacy{'login'} = 1;
1.518     albertel 5382:         }
                   5383:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  5384:             if (keys(%{$domconfig{'rolecolors'}})) {
                   5385:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   5386:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   5387:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   5388:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   5389:                         }
1.518     albertel 5390:                     }
                   5391:                 }
1.632     raeburn  5392:             } else {
                   5393:                 $legacy{'rolecolors'} = 1;
1.518     albertel 5394:             }
1.632     raeburn  5395:         } else {
                   5396:             $legacy{'rolecolors'} = 1;
1.518     albertel 5397:         }
1.948     raeburn  5398:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   5399:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   5400:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   5401:             }
                   5402:         }
1.632     raeburn  5403:         if (keys(%legacy) > 0) {
                   5404:             my %legacyhash = &get_legacy_domconf($udom);
                   5405:             foreach my $item (keys(%legacyhash)) {
                   5406:                 if ($item =~ /^\Q$udom\E\.login/) {
                   5407:                     if ($legacy{'login'}) { 
                   5408:                         $designhash{$item} = $legacyhash{$item};
                   5409:                     }
                   5410:                 } else {
                   5411:                     if ($legacy{'rolecolors'}) {
                   5412:                         $designhash{$item} = $legacyhash{$item};
                   5413:                     }
1.518     albertel 5414:                 }
                   5415:             }
                   5416:         }
1.632     raeburn  5417:     } else {
                   5418:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 5419:     }
                   5420:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   5421: 				  $cachetime);
                   5422:     return %designhash;
                   5423: }
                   5424: 
1.632     raeburn  5425: sub get_legacy_domconf {
                   5426:     my ($udom) = @_;
                   5427:     my %legacyhash;
                   5428:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   5429:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   5430:     if (-e $designfile) {
1.1075.2.128  raeburn  5431:         if ( open (my $fh,'<',$designfile) ) {
1.632     raeburn  5432:             while (my $line = <$fh>) {
                   5433:                 next if ($line =~ /^\#/);
                   5434:                 chomp($line);
                   5435:                 my ($key,$val)=(split(/\=/,$line));
                   5436:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   5437:             }
                   5438:             close($fh);
                   5439:         }
                   5440:     }
1.1026    raeburn  5441:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  5442:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   5443:     }
                   5444:     return %legacyhash;
                   5445: }
                   5446: 
1.63      www      5447: =pod
                   5448: 
1.112     bowersj2 5449: =item * &domainlogo()
1.63      www      5450: 
                   5451: Inputs: $domain (usually will be undef)
                   5452: 
                   5453: Returns: A link to a domain logo, if the domain logo exists.
                   5454: If the domain logo does not exist, a description of the domain.
                   5455: 
                   5456: =cut
1.112     bowersj2 5457: 
1.63      www      5458: ###############################################
                   5459: sub domainlogo {
1.517     raeburn  5460:     my $domain = &determinedomain(shift);
1.518     albertel 5461:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  5462:     # See if there is a logo
                   5463:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  5464:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 5465:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   5466: 	    if ($imgsrc =~ m{^/res/}) {
                   5467: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   5468: 		&Apache::lonnet::repcopy($local_name);
                   5469: 	    }
                   5470: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.1075.2.162  raeburn  5471:         }
                   5472:         my $alttext = $domain;
                   5473:         if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
                   5474:             $alttext = $designhash{$domain.'.login.alttext_domlogo'};
                   5475:         }
                   5476:         return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514     albertel 5477:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   5478:         return &Apache::lonnet::domain($domain,'description');
1.59      www      5479:     } else {
1.60      matthew  5480:         return '';
1.59      www      5481:     }
                   5482: }
1.63      www      5483: ##############################################
                   5484: 
                   5485: =pod
                   5486: 
1.112     bowersj2 5487: =item * &designparm()
1.63      www      5488: 
                   5489: Inputs: $which parameter; $domain (usually will be undef)
                   5490: 
                   5491: Returns: value of designparamter $which
                   5492: 
                   5493: =cut
1.112     bowersj2 5494: 
1.397     albertel 5495: 
1.400     albertel 5496: ##############################################
1.397     albertel 5497: sub designparm {
                   5498:     my ($which,$domain)=@_;
                   5499:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   5500:         return $env{'environment.color.'.$which};
1.96      www      5501:     }
1.63      www      5502:     $domain=&determinedomain($domain);
1.1016    raeburn  5503:     my %domdesign;
                   5504:     unless ($domain eq 'public') {
                   5505:         %domdesign = &get_domainconf($domain);
                   5506:     }
1.520     raeburn  5507:     my $output;
1.517     raeburn  5508:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   5509:         $output = $domdesign{$domain.'.'.$which};
1.63      www      5510:     } else {
1.520     raeburn  5511:         $output = $defaultdesign{$which};
                   5512:     }
                   5513:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  5514:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 5515:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   5516:             if ($output =~ m{^/res/}) {
                   5517:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   5518:                 &Apache::lonnet::repcopy($local_name);
                   5519:             }
1.520     raeburn  5520:             $output = &lonhttpdurl($output);
                   5521:         }
1.63      www      5522:     }
1.520     raeburn  5523:     return $output;
1.63      www      5524: }
1.59      www      5525: 
1.822     bisitz   5526: ##############################################
                   5527: =pod
                   5528: 
1.832     bisitz   5529: =item * &authorspace()
                   5530: 
1.1028    raeburn  5531: Inputs: $url (usually will be undef).
1.832     bisitz   5532: 
1.1075.2.40  raeburn  5533: Returns: Path to Authoring Space containing the resource or 
1.1028    raeburn  5534:          directory being viewed (or for which action is being taken). 
                   5535:          If $url is provided, and begins /priv/<domain>/<uname>
                   5536:          the path will be that portion of the $context argument.
                   5537:          Otherwise the path will be for the author space of the current
                   5538:          user when the current role is author, or for that of the 
                   5539:          co-author/assistant co-author space when the current role 
                   5540:          is co-author or assistant co-author.
1.832     bisitz   5541: 
                   5542: =cut
                   5543: 
                   5544: sub authorspace {
1.1028    raeburn  5545:     my ($url) = @_;
                   5546:     if ($url ne '') {
                   5547:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   5548:            return $1;
                   5549:         }
                   5550:     }
1.832     bisitz   5551:     my $caname = '';
1.1024    www      5552:     my $cadom = '';
1.1028    raeburn  5553:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      5554:         ($cadom,$caname) =
1.832     bisitz   5555:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  5556:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   5557:         $caname = $env{'user.name'};
1.1024    www      5558:         $cadom = $env{'user.domain'};
1.832     bisitz   5559:     }
1.1028    raeburn  5560:     if (($caname ne '') && ($cadom ne '')) {
                   5561:         return "/priv/$cadom/$caname/";
                   5562:     }
                   5563:     return;
1.832     bisitz   5564: }
                   5565: 
                   5566: ##############################################
                   5567: =pod
                   5568: 
1.822     bisitz   5569: =item * &head_subbox()
                   5570: 
                   5571: Inputs: $content (contains HTML code with page functions, etc.)
                   5572: 
                   5573: Returns: HTML div with $content
                   5574:          To be included in page header
                   5575: 
                   5576: =cut
                   5577: 
                   5578: sub head_subbox {
                   5579:     my ($content)=@_;
                   5580:     my $output =
1.993     raeburn  5581:         '<div class="LC_head_subbox">'
1.822     bisitz   5582:        .$content
                   5583:        .'</div>'
                   5584: }
                   5585: 
                   5586: ##############################################
                   5587: =pod
                   5588: 
                   5589: =item * &CSTR_pageheader()
                   5590: 
1.1026    raeburn  5591: Input: (optional) filename from which breadcrumb trail is built.
                   5592:        In most cases no input as needed, as $env{'request.filename'}
                   5593:        is appropriate for use in building the breadcrumb trail.
1.822     bisitz   5594: 
                   5595: Returns: HTML div with CSTR path and recent box
1.1075.2.40  raeburn  5596:          To be included on Authoring Space pages
1.822     bisitz   5597: 
                   5598: =cut
                   5599: 
                   5600: sub CSTR_pageheader {
1.1026    raeburn  5601:     my ($trailfile) = @_;
                   5602:     if ($trailfile eq '') {
                   5603:         $trailfile = $env{'request.filename'};
                   5604:     }
                   5605: 
                   5606: # this is for resources; directories have customtitle, and crumbs
                   5607: # and select recent are created in lonpubdir.pm
                   5608: 
                   5609:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      5610:     my ($udom,$uname,$thisdisfn)=
1.1075.2.29  raeburn  5611:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  5612:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   5613:     $formaction =~ s{/+}{/}g;
1.822     bisitz   5614: 
                   5615:     my $parentpath = '';
                   5616:     my $lastitem = '';
                   5617:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   5618:         $parentpath = $1;
                   5619:         $lastitem = $2;
                   5620:     } else {
                   5621:         $lastitem = $thisdisfn;
                   5622:     }
1.921     bisitz   5623: 
                   5624:     my $output =
1.822     bisitz   5625:          '<div>'
                   5626:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1075.2.40  raeburn  5627:         .'<b>'.&mt('Authoring Space:').'</b> '
1.822     bisitz   5628:         .'<form name="dirs" method="post" action="'.$formaction
1.921     bisitz   5629:         .'" target="_top">' #FIXME lonpubdir: target="_parent"
1.1024    www      5630:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv/'.$udom,undef,undef);
1.921     bisitz   5631: 
                   5632:     if ($lastitem) {
                   5633:         $output .=
                   5634:              '<span class="LC_filename">'
                   5635:             .$lastitem
                   5636:             .'</span>';
                   5637:     }
                   5638:     $output .=
                   5639:          '<br />'
1.822     bisitz   5640:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   5641:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   5642:         .'</form>'
                   5643:         .&Apache::lonmenu::constspaceform()
                   5644:         .'</div>';
1.921     bisitz   5645: 
                   5646:     return $output;
1.822     bisitz   5647: }
                   5648: 
1.60      matthew  5649: ###############################################
                   5650: ###############################################
                   5651: 
                   5652: =pod
                   5653: 
1.112     bowersj2 5654: =back
                   5655: 
1.549     albertel 5656: =head1 HTML Helpers
1.112     bowersj2 5657: 
                   5658: =over 4
                   5659: 
                   5660: =item * &bodytag()
1.60      matthew  5661: 
                   5662: Returns a uniform header for LON-CAPA web pages.
                   5663: 
                   5664: Inputs: 
                   5665: 
1.112     bowersj2 5666: =over 4
                   5667: 
                   5668: =item * $title, A title to be displayed on the page.
                   5669: 
                   5670: =item * $function, the current role (can be undef).
                   5671: 
                   5672: =item * $addentries, extra parameters for the <body> tag.
                   5673: 
                   5674: =item * $bodyonly, if defined, only return the <body> tag.
                   5675: 
                   5676: =item * $domain, if defined, force a given domain.
                   5677: 
                   5678: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      5679:             text interface only)
1.60      matthew  5680: 
1.814     bisitz   5681: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   5682:                      navigational links
1.317     albertel 5683: 
1.338     albertel 5684: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   5685: 
1.1075.2.12  raeburn  5686: =item * $no_inline_link, if true and in remote mode, don't show the
                   5687:          'Switch To Inline Menu' link
                   5688: 
1.460     albertel 5689: =item * $args, optional argument valid values are
                   5690:             no_auto_mt_title -> prevents &mt()ing the title arg
1.1075.2.133  raeburn  5691:             use_absolute     -> for external resource or syllabus, this will
                   5692:                                 contain https://<hostname> if server uses
                   5693:                                 https (as per hosts.tab), but request is for http
                   5694:             hostname         -> hostname, from $r->hostname().
1.460     albertel 5695: 
1.1075.2.15  raeburn  5696: =item * $advtoolsref, optional argument, ref to an array containing
                   5697:             inlineremote items to be added in "Functions" menu below
                   5698:             breadcrumbs.
                   5699: 
1.112     bowersj2 5700: =back
                   5701: 
1.60      matthew  5702: Returns: A uniform header for LON-CAPA web pages.  
                   5703: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   5704: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   5705: other decorations will be returned.
                   5706: 
                   5707: =cut
                   5708: 
1.54      www      5709: sub bodytag {
1.831     bisitz   5710:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1075.2.15  raeburn  5711:         $no_nav_bar,$bgcolor,$no_inline_link,$args,$advtoolsref)=@_;
1.339     albertel 5712: 
1.954     raeburn  5713:     my $public;
                   5714:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   5715:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   5716:         $public = 1;
                   5717:     }
1.460     albertel 5718:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.52  raeburn  5719:     my $httphost = $args->{'use_absolute'};
1.1075.2.133  raeburn  5720:     my $hostname = $args->{'hostname'};
1.339     albertel 5721: 
1.183     matthew  5722:     $function = &get_users_function() if (!$function);
1.339     albertel 5723:     my $img =    &designparm($function.'.img',$domain);
                   5724:     my $font =   &designparm($function.'.font',$domain);
                   5725:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   5726: 
1.803     bisitz   5727:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 5728: 		   'bgcolor' => $pgbg,
1.339     albertel 5729: 		   'text'    => $font,
                   5730:                    'alink'   => &designparm($function.'.alink',$domain),
                   5731: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   5732: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 5733:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 5734: 
1.63      www      5735:  # role and realm
1.1075.2.68  raeburn  5736:     my ($role,$realm) = split(m{\./},$env{'request.role'},2);
                   5737:     if ($realm) {
                   5738:         $realm = '/'.$realm;
                   5739:     }
1.1075.2.159  raeburn  5740:     if ($role eq 'ca') {
1.479     albertel 5741:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 5742:         $realm = &plainname($rname,$rdom);
1.378     raeburn  5743:     } 
1.55      www      5744: # realm
1.1075.2.158  raeburn  5745:     my ($cid,$sec);
1.258     albertel 5746:     if ($env{'request.course.id'}) {
1.1075.2.158  raeburn  5747:         $cid = $env{'request.course.id'};
                   5748:         if ($env{'request.course.sec'}) {
                   5749:             $sec = $env{'request.course.sec'};
                   5750:         }
                   5751:     } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
                   5752:         if (&Apache::lonnet::is_course($1,$2)) {
                   5753:             $cid = $1.'_'.$2;
                   5754:             $sec = $3;
                   5755:         }
                   5756:     }
                   5757:     if ($cid) {
1.378     raeburn  5758:         if ($env{'request.role'} !~ /^cr/) {
                   5759:             $role = &Apache::lonnet::plaintext($role,&course_type());
1.1075.2.115  raeburn  5760:         } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1075.2.121  raeburn  5761:             if ($env{'request.role.desc'}) {
                   5762:                 $role = $env{'request.role.desc'};
                   5763:             } else {
                   5764:                 $role = &mt('Helpdesk[_1]','&nbsp;'.$2);
                   5765:             }
1.1075.2.115  raeburn  5766:         } else {
                   5767:             $role = (split(/\//,$role,4))[-1];
1.378     raeburn  5768:         }
1.1075.2.158  raeburn  5769:         if ($sec) {
                   5770:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$sec;
1.898     raeburn  5771:         }   
1.1075.2.158  raeburn  5772: 	$realm = $env{'course.'.$cid.'.description'};
1.378     raeburn  5773:     } else {
                   5774:         $role = &Apache::lonnet::plaintext($role);
1.54      www      5775:     }
1.433     albertel 5776: 
1.359     albertel 5777:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 5778: 
1.438     albertel 5779:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 5780: 
1.101     www      5781: # construct main body tag
1.359     albertel 5782:     my $bodytag = "<body $extra_body_attr>".
1.1075.2.100  raeburn  5783: 	&Apache::lontexconvert::init_math_support();
1.252     albertel 5784: 
1.1075.2.38  raeburn  5785:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   5786: 
                   5787:     if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60      matthew  5788:         return $bodytag;
1.1075.2.38  raeburn  5789:     }
1.359     albertel 5790: 
1.954     raeburn  5791:     if ($public) {
1.433     albertel 5792: 	undef($role);
                   5793:     }
1.1075.2.158  raeburn  5794: 
1.762     bisitz   5795:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 5796:     #
                   5797:     # Extra info if you are the DC
                   5798:     my $dc_info = '';
1.1075.2.159  raeburn  5799:     if (($env{'user.adv'}) && ($env{'request.course.id'}) &&
1.1075.2.158  raeburn  5800:         (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917     raeburn  5801:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      5802:         $dc_info =~ s/\s+$//;
1.359     albertel 5803:     }
                   5804: 
1.1075.2.108  raeburn  5805:     $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.903     droeschl 5806: 
1.1075.2.13  raeburn  5807:     if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   5808: 
1.1075.2.38  raeburn  5809: 
                   5810: 
1.1075.2.21  raeburn  5811:     my $funclist;
                   5812:     if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} ne 'construct')) {
1.1075.2.52  raeburn  5813:         $bodytag .= Apache::lonhtmlcommon::scripttag(Apache::lonmenu::utilityfunctions($httphost), 'start')."\n".
1.1075.2.21  raeburn  5814:                     Apache::lonmenu::serverform();
                   5815:         my $forbodytag;
                   5816:         &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5817:                                             $forcereg,$args->{'group'},
                   5818:                                             $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5819:                                             $advtoolsref,'','',\$forbodytag);
1.1075.2.21  raeburn  5820:         unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5821:             $funclist = $forbodytag;
                   5822:         }
1.1075.2.172! raeburn  5823:         $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
1.1075.2.21  raeburn  5824:     } else {
1.903     droeschl 5825: 
                   5826:         #    if ($env{'request.state'} eq 'construct') {
                   5827:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   5828:         #    }
                   5829: 
1.1075.2.172! raeburn  5830:         my $need_endlcint;
        !          5831:         unless ($args->{'switchserver'}) {
        !          5832:             $bodytag .= Apache::lonhtmlcommon::scripttag(
        !          5833:                 Apache::lonmenu::utilityfunctions($httphost), 'start');
        !          5834:             $need_endlcint = 1;
        !          5835:         }
1.359     albertel 5836: 
1.1075.2.171  raeburn  5837:         if (($env{'environment.remote'} eq 'on') && ($env{'request.state'} eq 'construct')) {
                   5838:             unless ($env{'form.inhibitmenu'}) {
                   5839:                 $bodytag .= &inline_for_remote($public,$role,$realm,$dc_info,$no_inline_link);
                   5840:             }
                   5841:         } else {
                   5842:             my ($left,$right) = Apache::lonmenu::primary_menu($args->{'links_disabled'});
1.1075.2.2  raeburn  5843: 
1.1075.2.171  raeburn  5844:             if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
                   5845:                 if ($dc_info) {
                   5846:                     $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   5847:                 }
                   5848:                 $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
                   5849:                                <em>$realm</em> $dc_info</div>|;
1.1075.2.172! raeburn  5850:                 if ($need_endlcint) {
        !          5851:                     $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
        !          5852:                 }
1.1075.2.171  raeburn  5853:                 return $bodytag;
1.1075.2.1  raeburn  5854:             }
1.894     droeschl 5855: 
1.1075.2.171  raeburn  5856:             unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   5857:                 $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
                   5858:             }
1.916     droeschl 5859: 
1.1075.2.171  raeburn  5860:             $bodytag .= $right;
1.852     droeschl 5861: 
1.1075.2.171  raeburn  5862:             if ($dc_info) {
                   5863:                 $dc_info = &dc_courseid_toggle($dc_info);
                   5864:             }
                   5865:             $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917     raeburn  5866:         }
1.916     droeschl 5867: 
1.1075.2.61  raeburn  5868:         #if directed to not display the secondary menu, don't.
                   5869:         if ($args->{'no_secondary_menu'}) {
1.1075.2.172! raeburn  5870:             if ($need_endlcint) {
        !          5871:                 $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
        !          5872:             }
1.1075.2.61  raeburn  5873:             return $bodytag;
                   5874:         }
1.903     droeschl 5875:         #don't show menus for public users
1.954     raeburn  5876:         if (!$public){
1.1075.2.171  raeburn  5877:             unless (($env{'environment.remote'} eq 'on') &&
                   5878:                      ($env{'request.state'} eq 'construct')) {
                   5879:                 $bodytag .= Apache::lonmenu::secondary_menu($httphost,$args->{'links_disabled'});
                   5880:             }
1.903     droeschl 5881:             $bodytag .= Apache::lonmenu::serverform();
1.1075.2.172! raeburn  5882:             if ($need_endlcint) {
        !          5883:                 $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
        !          5884:             }
1.920     raeburn  5885:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5886:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1075.2.133  raeburn  5887:                                 $args->{'bread_crumbs'},'','',$hostname);
1.1075.2.116  raeburn  5888:             } elsif ($forcereg) {
1.1075.2.22  raeburn  5889:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1075.2.116  raeburn  5890:                                                             $args->{'group'},
1.1075.2.161  raeburn  5891:                                                             $args->{'hide_buttons'},
                   5892:                                                             $hostname);
1.1075.2.15  raeburn  5893:             } else {
1.1075.2.21  raeburn  5894:                 my $forbodytag;
                   5895:                 &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5896:                                                     $forcereg,$args->{'group'},
                   5897:                                                     $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5898:                                                     $advtoolsref,'',$hostname,
                   5899:                                                     \$forbodytag);
1.1075.2.21  raeburn  5900:                 unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5901:                     $bodytag .= $forbodytag;
                   5902:                 }
1.920     raeburn  5903:             }
1.1075.2.172! raeburn  5904:         } else {
        !          5905:             # this is to separate menu from content when there's no secondary
1.903     droeschl 5906:             # menu. Especially needed for public accessible ressources.
                   5907:             $bodytag .= '<hr style="clear:both" />';
1.1075.2.172! raeburn  5908:             if ($need_endlcint) {
        !          5909:                 $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
        !          5910:             }
1.235     raeburn  5911:         }
1.903     droeschl 5912: 
1.235     raeburn  5913:         return $bodytag;
1.1075.2.12  raeburn  5914:     }
                   5915: 
                   5916: #
                   5917: # Top frame rendering, Remote is up
                   5918: #
                   5919: 
1.1075.2.60  raeburn  5920:     my $help=($no_inline_link?''
                   5921:               :&Apache::loncommon::top_nav_help('Help'));
                   5922: 
1.1075.2.12  raeburn  5923:     # Explicit link to get inline menu
                   5924:     my $menu= ($no_inline_link?''
                   5925:                :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
                   5926: 
                   5927:     if ($dc_info) {
                   5928:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   5929:     }
                   5930: 
1.1075.2.38  raeburn  5931:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   5932:     unless ($public) {
                   5933:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5934:                                 undef,'LC_menubuttons_link');
                   5935:     }
                   5936: 
1.1075.2.12  raeburn  5937:     unless ($env{'form.inhibitmenu'}) {
1.1075.2.171  raeburn  5938:         $bodytag .= &inline_for_remote($public,$role,$realm,$dc_info,$no_inline_link);
1.1075.2.12  raeburn  5939:     }
1.1075.2.21  raeburn  5940:     return $bodytag."\n".$funclist;
1.182     matthew  5941: }
                   5942: 
1.1075.2.171  raeburn  5943: sub inline_for_remote {
                   5944:     my ($public,$role,$realm,$dc_info,$no_inline_link) = @_;
                   5945:     my $help=($no_inline_link?''
                   5946:               :&Apache::loncommon::top_nav_help('Help'));
                   5947: 
                   5948:     # Explicit link to get inline menu
                   5949:     my $menu= ($no_inline_link?''
                   5950:                :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
                   5951: 
                   5952:     if ($dc_info) {
                   5953:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   5954:     }
                   5955: 
                   5956:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   5957:     unless ($public) {
                   5958:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5959:                                 undef,'LC_menubuttons_link');
                   5960:     }
                   5961: 
                   5962:     return qq|<div id="LC_nav_bar">$name $role</div>
                   5963:               <ol class="LC_primary_menu LC_floatright LC_right">
                   5964:               <li>$help</li>
                   5965:               <li>$menu</li>
                   5966:               </ol><div id="LC_realm"> $realm $dc_info</div>|;
                   5967: }
                   5968: 
1.917     raeburn  5969: sub dc_courseid_toggle {
                   5970:     my ($dc_info) = @_;
1.980     raeburn  5971:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5972:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5973:            &mt('(More ...)').'</a></span>'.
                   5974:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5975: }
                   5976: 
1.330     albertel 5977: sub make_attr_string {
                   5978:     my ($register,$attr_ref) = @_;
                   5979: 
                   5980:     if ($attr_ref && !ref($attr_ref)) {
                   5981: 	die("addentries Must be a hash ref ".
                   5982: 	    join(':',caller(1))." ".
                   5983: 	    join(':',caller(0))." ");
                   5984:     }
                   5985: 
                   5986:     if ($register) {
1.339     albertel 5987: 	my ($on_load,$on_unload);
                   5988: 	foreach my $key (keys(%{$attr_ref})) {
                   5989: 	    if      (lc($key) eq 'onload') {
                   5990: 		$on_load.=$attr_ref->{$key}.';';
                   5991: 		delete($attr_ref->{$key});
                   5992: 
                   5993: 	    } elsif (lc($key) eq 'onunload') {
                   5994: 		$on_unload.=$attr_ref->{$key}.';';
                   5995: 		delete($attr_ref->{$key});
                   5996: 	    }
                   5997: 	}
1.1075.2.12  raeburn  5998:         if ($env{'environment.remote'} eq 'on') {
                   5999:             $attr_ref->{'onload'}  =
                   6000:                 &Apache::lonmenu::loadevents().  $on_load;
                   6001:             $attr_ref->{'onunload'}=
                   6002:                 &Apache::lonmenu::unloadevents().$on_unload;
                   6003:         } else {  
                   6004: 	    $attr_ref->{'onload'}  = $on_load;
                   6005: 	    $attr_ref->{'onunload'}= $on_unload;
                   6006:         }
1.330     albertel 6007:     }
1.339     albertel 6008: 
1.330     albertel 6009:     my $attr_string;
1.1075.2.56  raeburn  6010:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 6011: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   6012:     }
                   6013:     return $attr_string;
                   6014: }
                   6015: 
                   6016: 
1.182     matthew  6017: ###############################################
1.251     albertel 6018: ###############################################
                   6019: 
                   6020: =pod
                   6021: 
                   6022: =item * &endbodytag()
                   6023: 
                   6024: Returns a uniform footer for LON-CAPA web pages.
                   6025: 
1.635     raeburn  6026: Inputs: 1 - optional reference to an args hash
                   6027: If in the hash, key for noredirectlink has a value which evaluates to true,
                   6028: a 'Continue' link is not displayed if the page contains an
                   6029: internal redirect in the <head></head> section,
                   6030: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 6031: 
                   6032: =cut
                   6033: 
                   6034: sub endbodytag {
1.635     raeburn  6035:     my ($args) = @_;
1.1075.2.6  raeburn  6036:     my $endbodytag;
                   6037:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   6038:         $endbodytag='</body>';
                   6039:     }
1.315     albertel 6040:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  6041:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   6042: 	    $endbodytag=
                   6043: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   6044: 	        &mt('Continue').'</a>'.
                   6045: 	        $endbodytag;
                   6046:         }
1.315     albertel 6047:     }
1.1075.2.165  raeburn  6048:     if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
                   6049:         $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
                   6050:     }
1.251     albertel 6051:     return $endbodytag;
                   6052: }
                   6053: 
1.352     albertel 6054: =pod
                   6055: 
                   6056: =item * &standard_css()
                   6057: 
                   6058: Returns a style sheet
                   6059: 
                   6060: Inputs: (all optional)
                   6061:             domain         -> force to color decorate a page for a specific
                   6062:                                domain
                   6063:             function       -> force usage of a specific rolish color scheme
                   6064:             bgcolor        -> override the default page bgcolor
                   6065: 
                   6066: =cut
                   6067: 
1.343     albertel 6068: sub standard_css {
1.345     albertel 6069:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 6070:     $function  = &get_users_function() if (!$function);
                   6071:     my $img    = &designparm($function.'.img',   $domain);
                   6072:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   6073:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 6074:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 6075: #second colour for later usage
1.345     albertel 6076:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 6077:     my $pgbg_or_bgcolor =
                   6078: 	         $bgcolor ||
1.352     albertel 6079: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 6080:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 6081:     my $alink  = &designparm($function.'.alink', $domain);
                   6082:     my $vlink  = &designparm($function.'.vlink', $domain);
                   6083:     my $link   = &designparm($function.'.link',  $domain);
                   6084: 
1.602     albertel 6085:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 6086:     my $mono                 = 'monospace';
1.850     bisitz   6087:     my $data_table_head      = $sidebg;
                   6088:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   6089:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 6090:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 6091:     my $data_table_highlight = '#FFFF00';
1.352     albertel 6092:     my $mail_new             = '#FFBB77';
                   6093:     my $mail_new_hover       = '#DD9955';
                   6094:     my $mail_read            = '#BBBB77';
                   6095:     my $mail_read_hover      = '#999944';
                   6096:     my $mail_replied         = '#AAAA88';
                   6097:     my $mail_replied_hover   = '#888855';
                   6098:     my $mail_other           = '#99BBBB';
                   6099:     my $mail_other_hover     = '#669999';
1.391     albertel 6100:     my $table_header         = '#DDDDDD';
1.489     raeburn  6101:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   6102:     my $lg_border_color      = '#C8C8C8';
1.952     onken    6103:     my $button_hover         = '#BF2317';
1.392     albertel 6104: 
1.608     albertel 6105:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   6106:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   6107:                                              : '0 3px 0 4px';
1.448     albertel 6108: 
1.523     albertel 6109: 
1.343     albertel 6110:     return <<END;
1.947     droeschl 6111: 
                   6112: /* needed for iframe to allow 100% height in FF */
                   6113: body, html { 
                   6114:     margin: 0;
                   6115:     padding: 0 0.5%;
                   6116:     height: 99%; /* to avoid scrollbars */
                   6117: }
                   6118: 
1.795     www      6119: body {
1.911     bisitz   6120:   font-family: $sans;
                   6121:   line-height:130%;
                   6122:   font-size:0.83em;
                   6123:   color:$font;
1.795     www      6124: }
                   6125: 
1.959     onken    6126: a:focus,
                   6127: a:focus img {
1.795     www      6128:   color: red;
                   6129: }
1.698     harmsja  6130: 
1.911     bisitz   6131: form, .inline {
                   6132:   display: inline;
1.795     www      6133: }
1.721     harmsja  6134: 
1.795     www      6135: .LC_right {
1.911     bisitz   6136:   text-align:right;
1.795     www      6137: }
                   6138: 
                   6139: .LC_middle {
1.911     bisitz   6140:   vertical-align:middle;
1.795     www      6141: }
1.721     harmsja  6142: 
1.1075.2.38  raeburn  6143: .LC_floatleft {
                   6144:   float: left;
                   6145: }
                   6146: 
                   6147: .LC_floatright {
                   6148:   float: right;
                   6149: }
                   6150: 
1.911     bisitz   6151: .LC_400Box {
                   6152:   width:400px;
                   6153: }
1.721     harmsja  6154: 
1.947     droeschl 6155: .LC_iframecontainer {
                   6156:     width: 98%;
                   6157:     margin: 0;
                   6158:     position: fixed;
                   6159:     top: 8.5em;
                   6160:     bottom: 0;
                   6161: }
                   6162: 
                   6163: .LC_iframecontainer iframe{
                   6164:     border: none;
                   6165:     width: 100%;
                   6166:     height: 100%;
                   6167: }
                   6168: 
1.778     bisitz   6169: .LC_filename {
                   6170:   font-family: $mono;
                   6171:   white-space:pre;
1.921     bisitz   6172:   font-size: 120%;
1.778     bisitz   6173: }
                   6174: 
                   6175: .LC_fileicon {
                   6176:   border: none;
                   6177:   height: 1.3em;
                   6178:   vertical-align: text-bottom;
                   6179:   margin-right: 0.3em;
                   6180:   text-decoration:none;
                   6181: }
                   6182: 
1.1008    www      6183: .LC_setting {
                   6184:   text-decoration:underline;
                   6185: }
                   6186: 
1.350     albertel 6187: .LC_error {
                   6188:   color: red;
                   6189: }
1.795     www      6190: 
1.1075.2.15  raeburn  6191: .LC_warning {
                   6192:   color: darkorange;
                   6193: }
                   6194: 
1.457     albertel 6195: .LC_diff_removed {
1.733     bisitz   6196:   color: red;
1.394     albertel 6197: }
1.532     albertel 6198: 
                   6199: .LC_info,
1.457     albertel 6200: .LC_success,
                   6201: .LC_diff_added {
1.350     albertel 6202:   color: green;
                   6203: }
1.795     www      6204: 
1.802     bisitz   6205: div.LC_confirm_box {
                   6206:   background-color: #FAFAFA;
                   6207:   border: 1px solid $lg_border_color;
                   6208:   margin-right: 0;
                   6209:   padding: 5px;
                   6210: }
                   6211: 
                   6212: div.LC_confirm_box .LC_error img,
                   6213: div.LC_confirm_box .LC_success img {
                   6214:   vertical-align: middle;
                   6215: }
                   6216: 
1.1075.2.108  raeburn  6217: .LC_maxwidth {
                   6218:   max-width: 100%;
                   6219:   height: auto;
                   6220: }
                   6221: 
                   6222: .LC_textsize_mobile {
                   6223:   \@media only screen and (max-device-width: 480px) {
                   6224:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   6225:   }
                   6226: }
                   6227: 
1.440     albertel 6228: .LC_icon {
1.771     droeschl 6229:   border: none;
1.790     droeschl 6230:   vertical-align: middle;
1.771     droeschl 6231: }
                   6232: 
1.543     albertel 6233: .LC_docs_spacer {
                   6234:   width: 25px;
                   6235:   height: 1px;
1.771     droeschl 6236:   border: none;
1.543     albertel 6237: }
1.346     albertel 6238: 
1.532     albertel 6239: .LC_internal_info {
1.735     bisitz   6240:   color: #999999;
1.532     albertel 6241: }
                   6242: 
1.794     www      6243: .LC_discussion {
1.1050    www      6244:   background: $data_table_dark;
1.911     bisitz   6245:   border: 1px solid black;
                   6246:   margin: 2px;
1.794     www      6247: }
                   6248: 
                   6249: .LC_disc_action_left {
1.1050    www      6250:   background: $sidebg;
1.911     bisitz   6251:   text-align: left;
1.1050    www      6252:   padding: 4px;
                   6253:   margin: 2px;
1.794     www      6254: }
                   6255: 
                   6256: .LC_disc_action_right {
1.1050    www      6257:   background: $sidebg;
1.911     bisitz   6258:   text-align: right;
1.1050    www      6259:   padding: 4px;
                   6260:   margin: 2px;
1.794     www      6261: }
                   6262: 
                   6263: .LC_disc_new_item {
1.911     bisitz   6264:   background: white;
                   6265:   border: 2px solid red;
1.1050    www      6266:   margin: 4px;
                   6267:   padding: 4px;
1.794     www      6268: }
                   6269: 
                   6270: .LC_disc_old_item {
1.911     bisitz   6271:   background: white;
1.1050    www      6272:   margin: 4px;
                   6273:   padding: 4px;
1.794     www      6274: }
                   6275: 
1.458     albertel 6276: table.LC_pastsubmission {
                   6277:   border: 1px solid black;
                   6278:   margin: 2px;
                   6279: }
                   6280: 
1.924     bisitz   6281: table#LC_menubuttons {
1.345     albertel 6282:   width: 100%;
                   6283:   background: $pgbg;
1.392     albertel 6284:   border: 2px;
1.402     albertel 6285:   border-collapse: separate;
1.803     bisitz   6286:   padding: 0;
1.345     albertel 6287: }
1.392     albertel 6288: 
1.801     tempelho 6289: table#LC_title_bar a {
                   6290:   color: $fontmenu;
                   6291: }
1.836     bisitz   6292: 
1.807     droeschl 6293: table#LC_title_bar {
1.819     tempelho 6294:   clear: both;
1.836     bisitz   6295:   display: none;
1.807     droeschl 6296: }
                   6297: 
1.795     www      6298: table#LC_title_bar,
1.933     droeschl 6299: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 6300: table#LC_title_bar.LC_with_remote {
1.359     albertel 6301:   width: 100%;
1.392     albertel 6302:   border-color: $pgbg;
                   6303:   border-style: solid;
                   6304:   border-width: $border;
1.379     albertel 6305:   background: $pgbg;
1.801     tempelho 6306:   color: $fontmenu;
1.392     albertel 6307:   border-collapse: collapse;
1.803     bisitz   6308:   padding: 0;
1.819     tempelho 6309:   margin: 0;
1.359     albertel 6310: }
1.795     www      6311: 
1.933     droeschl 6312: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 6313:     margin: 0;
                   6314:     padding: 0;
1.933     droeschl 6315:     position: relative;
                   6316:     list-style: none;
1.913     droeschl 6317: }
1.933     droeschl 6318: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 6319:     display: inline;
                   6320: }
1.933     droeschl 6321: 
                   6322: .LC_breadcrumb_tools_navigation {
1.913     droeschl 6323:     padding: 0;
1.933     droeschl 6324:     margin: 0;
                   6325:     float: left;
1.913     droeschl 6326: }
1.933     droeschl 6327: .LC_breadcrumb_tools_tools {
                   6328:     padding: 0;
                   6329:     margin: 0;
1.913     droeschl 6330:     float: right;
                   6331: }
                   6332: 
1.359     albertel 6333: table#LC_title_bar td {
                   6334:   background: $tabbg;
                   6335: }
1.795     www      6336: 
1.911     bisitz   6337: table#LC_menubuttons img {
1.803     bisitz   6338:   border: none;
1.346     albertel 6339: }
1.795     www      6340: 
1.842     droeschl 6341: .LC_breadcrumbs_component {
1.911     bisitz   6342:   float: right;
                   6343:   margin: 0 1em;
1.357     albertel 6344: }
1.842     droeschl 6345: .LC_breadcrumbs_component img {
1.911     bisitz   6346:   vertical-align: middle;
1.777     tempelho 6347: }
1.795     www      6348: 
1.1075.2.108  raeburn  6349: .LC_breadcrumbs_hoverable {
                   6350:   background: $sidebg;
                   6351: }
                   6352: 
1.383     albertel 6353: td.LC_table_cell_checkbox {
                   6354:   text-align: center;
                   6355: }
1.795     www      6356: 
                   6357: .LC_fontsize_small {
1.911     bisitz   6358:   font-size: 70%;
1.705     tempelho 6359: }
                   6360: 
1.844     bisitz   6361: #LC_breadcrumbs {
1.911     bisitz   6362:   clear:both;
                   6363:   background: $sidebg;
                   6364:   border-bottom: 1px solid $lg_border_color;
                   6365:   line-height: 2.5em;
1.933     droeschl 6366:   overflow: hidden;
1.911     bisitz   6367:   margin: 0;
                   6368:   padding: 0;
1.995     raeburn  6369:   text-align: left;
1.819     tempelho 6370: }
1.862     bisitz   6371: 
1.1075.2.16  raeburn  6372: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   6373:   clear:both;
                   6374:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 6375:   border: 1px solid $sidebg;
1.1075.2.16  raeburn  6376:   margin: 0 0 10px 0;
1.966     bisitz   6377:   padding: 3px;
1.995     raeburn  6378:   text-align: left;
1.822     bisitz   6379: }
                   6380: 
1.795     www      6381: .LC_fontsize_medium {
1.911     bisitz   6382:   font-size: 85%;
1.705     tempelho 6383: }
                   6384: 
1.795     www      6385: .LC_fontsize_large {
1.911     bisitz   6386:   font-size: 120%;
1.705     tempelho 6387: }
                   6388: 
1.346     albertel 6389: .LC_menubuttons_inline_text {
                   6390:   color: $font;
1.698     harmsja  6391:   font-size: 90%;
1.701     harmsja  6392:   padding-left:3px;
1.346     albertel 6393: }
                   6394: 
1.934     droeschl 6395: .LC_menubuttons_inline_text img{
                   6396:   vertical-align: middle;
                   6397: }
                   6398: 
1.1051    www      6399: li.LC_menubuttons_inline_text img {
1.951     onken    6400:   cursor:pointer;
1.1002    droeschl 6401:   text-decoration: none;
1.951     onken    6402: }
                   6403: 
1.526     www      6404: .LC_menubuttons_link {
                   6405:   text-decoration: none;
                   6406: }
1.795     www      6407: 
1.522     albertel 6408: .LC_menubuttons_category {
1.521     www      6409:   color: $font;
1.526     www      6410:   background: $pgbg;
1.521     www      6411:   font-size: larger;
                   6412:   font-weight: bold;
                   6413: }
                   6414: 
1.346     albertel 6415: td.LC_menubuttons_text {
1.911     bisitz   6416:   color: $font;
1.346     albertel 6417: }
1.706     harmsja  6418: 
1.346     albertel 6419: .LC_current_location {
                   6420:   background: $tabbg;
                   6421: }
1.795     www      6422: 
1.1075.2.134  raeburn  6423: td.LC_zero_height {
                   6424:   line-height: 0;
                   6425:   cellpadding: 0;
                   6426: }
                   6427: 
1.938     bisitz   6428: table.LC_data_table {
1.347     albertel 6429:   border: 1px solid #000000;
1.402     albertel 6430:   border-collapse: separate;
1.426     albertel 6431:   border-spacing: 1px;
1.610     albertel 6432:   background: $pgbg;
1.347     albertel 6433: }
1.795     www      6434: 
1.422     albertel 6435: .LC_data_table_dense {
                   6436:   font-size: small;
                   6437: }
1.795     www      6438: 
1.507     raeburn  6439: table.LC_nested_outer {
                   6440:   border: 1px solid #000000;
1.589     raeburn  6441:   border-collapse: collapse;
1.803     bisitz   6442:   border-spacing: 0;
1.507     raeburn  6443:   width: 100%;
                   6444: }
1.795     www      6445: 
1.879     raeburn  6446: table.LC_innerpickbox,
1.507     raeburn  6447: table.LC_nested {
1.803     bisitz   6448:   border: none;
1.589     raeburn  6449:   border-collapse: collapse;
1.803     bisitz   6450:   border-spacing: 0;
1.507     raeburn  6451:   width: 100%;
                   6452: }
1.795     www      6453: 
1.911     bisitz   6454: table.LC_data_table tr th,
                   6455: table.LC_calendar tr th,
1.879     raeburn  6456: table.LC_prior_tries tr th,
                   6457: table.LC_innerpickbox tr th {
1.349     albertel 6458:   font-weight: bold;
                   6459:   background-color: $data_table_head;
1.801     tempelho 6460:   color:$fontmenu;
1.701     harmsja  6461:   font-size:90%;
1.347     albertel 6462: }
1.795     www      6463: 
1.879     raeburn  6464: table.LC_innerpickbox tr th,
                   6465: table.LC_innerpickbox tr td {
                   6466:   vertical-align: top;
                   6467: }
                   6468: 
1.711     raeburn  6469: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6470:   background-color: #CCCCCC;
1.711     raeburn  6471:   font-weight: bold;
                   6472:   text-align: left;
                   6473: }
1.795     www      6474: 
1.912     bisitz   6475: table.LC_data_table tr.LC_odd_row > td {
                   6476:   background-color: $data_table_light;
                   6477:   padding: 2px;
                   6478:   vertical-align: top;
                   6479: }
                   6480: 
1.809     bisitz   6481: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6482:   background-color: $data_table_light;
1.912     bisitz   6483:   vertical-align: top;
                   6484: }
                   6485: 
                   6486: table.LC_data_table tr.LC_even_row > td {
                   6487:   background-color: $data_table_dark;
1.425     albertel 6488:   padding: 2px;
1.900     bisitz   6489:   vertical-align: top;
1.347     albertel 6490: }
1.795     www      6491: 
1.809     bisitz   6492: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6493:   background-color: $data_table_dark;
1.900     bisitz   6494:   vertical-align: top;
1.347     albertel 6495: }
1.795     www      6496: 
1.425     albertel 6497: table.LC_data_table tr.LC_data_table_highlight td {
                   6498:   background-color: $data_table_darker;
                   6499: }
1.795     www      6500: 
1.639     raeburn  6501: table.LC_data_table tr td.LC_leftcol_header {
                   6502:   background-color: $data_table_head;
                   6503:   font-weight: bold;
                   6504: }
1.795     www      6505: 
1.451     albertel 6506: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6507: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6508:   font-weight: bold;
                   6509:   font-style: italic;
                   6510:   text-align: center;
                   6511:   padding: 8px;
1.347     albertel 6512: }
1.795     www      6513: 
1.1075.2.30  raeburn  6514: table.LC_data_table tr.LC_empty_row td,
                   6515: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6516:   background-color: $sidebg;
                   6517: }
                   6518: 
                   6519: table.LC_nested tr.LC_empty_row td {
                   6520:   background-color: #FFFFFF;
                   6521: }
                   6522: 
1.890     droeschl 6523: table.LC_caption {
                   6524: }
                   6525: 
1.507     raeburn  6526: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6527:   padding: 4ex
                   6528: }
1.795     www      6529: 
1.507     raeburn  6530: table.LC_nested_outer tr th {
                   6531:   font-weight: bold;
1.801     tempelho 6532:   color:$fontmenu;
1.507     raeburn  6533:   background-color: $data_table_head;
1.701     harmsja  6534:   font-size: small;
1.507     raeburn  6535:   border-bottom: 1px solid #000000;
                   6536: }
1.795     www      6537: 
1.507     raeburn  6538: table.LC_nested_outer tr td.LC_subheader {
                   6539:   background-color: $data_table_head;
                   6540:   font-weight: bold;
                   6541:   font-size: small;
                   6542:   border-bottom: 1px solid #000000;
                   6543:   text-align: right;
1.451     albertel 6544: }
1.795     www      6545: 
1.507     raeburn  6546: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6547:   background-color: #CCCCCC;
1.451     albertel 6548:   font-weight: bold;
                   6549:   font-size: small;
1.507     raeburn  6550:   text-align: center;
                   6551: }
1.795     www      6552: 
1.589     raeburn  6553: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6554: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6555:   text-align: left;
1.451     albertel 6556: }
1.795     www      6557: 
1.507     raeburn  6558: table.LC_nested td {
1.735     bisitz   6559:   background-color: #FFFFFF;
1.451     albertel 6560:   font-size: small;
1.507     raeburn  6561: }
1.795     www      6562: 
1.507     raeburn  6563: table.LC_nested_outer tr th.LC_right_item,
                   6564: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6565: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6566: table.LC_nested tr td.LC_right_item {
1.451     albertel 6567:   text-align: right;
                   6568: }
                   6569: 
1.507     raeburn  6570: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6571:   background-color: #EEEEEE;
1.451     albertel 6572: }
                   6573: 
1.473     raeburn  6574: table.LC_createuser {
                   6575: }
                   6576: 
                   6577: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6578:   font-size: small;
1.473     raeburn  6579: }
                   6580: 
                   6581: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6582:   background-color: #CCCCCC;
1.473     raeburn  6583:   font-weight: bold;
                   6584:   text-align: center;
                   6585: }
                   6586: 
1.349     albertel 6587: table.LC_calendar {
                   6588:   border: 1px solid #000000;
                   6589:   border-collapse: collapse;
1.917     raeburn  6590:   width: 98%;
1.349     albertel 6591: }
1.795     www      6592: 
1.349     albertel 6593: table.LC_calendar_pickdate {
                   6594:   font-size: xx-small;
                   6595: }
1.795     www      6596: 
1.349     albertel 6597: table.LC_calendar tr td {
                   6598:   border: 1px solid #000000;
                   6599:   vertical-align: top;
1.917     raeburn  6600:   width: 14%;
1.349     albertel 6601: }
1.795     www      6602: 
1.349     albertel 6603: table.LC_calendar tr td.LC_calendar_day_empty {
                   6604:   background-color: $data_table_dark;
                   6605: }
1.795     www      6606: 
1.779     bisitz   6607: table.LC_calendar tr td.LC_calendar_day_current {
                   6608:   background-color: $data_table_highlight;
1.777     tempelho 6609: }
1.795     www      6610: 
1.938     bisitz   6611: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6612:   background-color: $mail_new;
                   6613: }
1.795     www      6614: 
1.938     bisitz   6615: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6616:   background-color: $mail_new_hover;
                   6617: }
1.795     www      6618: 
1.938     bisitz   6619: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6620:   background-color: $mail_read;
                   6621: }
1.795     www      6622: 
1.938     bisitz   6623: /*
                   6624: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6625:   background-color: $mail_read_hover;
                   6626: }
1.938     bisitz   6627: */
1.795     www      6628: 
1.938     bisitz   6629: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6630:   background-color: $mail_replied;
                   6631: }
1.795     www      6632: 
1.938     bisitz   6633: /*
                   6634: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6635:   background-color: $mail_replied_hover;
                   6636: }
1.938     bisitz   6637: */
1.795     www      6638: 
1.938     bisitz   6639: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6640:   background-color: $mail_other;
                   6641: }
1.795     www      6642: 
1.938     bisitz   6643: /*
                   6644: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6645:   background-color: $mail_other_hover;
                   6646: }
1.938     bisitz   6647: */
1.494     raeburn  6648: 
1.777     tempelho 6649: table.LC_data_table tr > td.LC_browser_file,
                   6650: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6651:   background: #AAEE77;
1.389     albertel 6652: }
1.795     www      6653: 
1.777     tempelho 6654: table.LC_data_table tr > td.LC_browser_file_locked,
                   6655: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6656:   background: #FFAA99;
1.387     albertel 6657: }
1.795     www      6658: 
1.777     tempelho 6659: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6660:   background: #888888;
1.779     bisitz   6661: }
1.795     www      6662: 
1.777     tempelho 6663: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6664: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6665:   background: #F8F866;
1.777     tempelho 6666: }
1.795     www      6667: 
1.696     bisitz   6668: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6669:   background: #E0E8FF;
1.387     albertel 6670: }
1.696     bisitz   6671: 
1.707     bisitz   6672: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6673:   /* background: #77FF77; */
1.707     bisitz   6674: }
1.795     www      6675: 
1.707     bisitz   6676: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6677:   border-right: 8px solid #FFFF77;
1.707     bisitz   6678: }
1.795     www      6679: 
1.707     bisitz   6680: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6681:   border-right: 8px solid #FFAA77;
1.707     bisitz   6682: }
1.795     www      6683: 
1.707     bisitz   6684: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6685:   border-right: 8px solid #FF7777;
1.707     bisitz   6686: }
1.795     www      6687: 
1.707     bisitz   6688: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6689:   border-right: 8px solid #AAFF77;
1.707     bisitz   6690: }
1.795     www      6691: 
1.707     bisitz   6692: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6693:   border-right: 8px solid #11CC55;
1.707     bisitz   6694: }
                   6695: 
1.388     albertel 6696: span.LC_current_location {
1.701     harmsja  6697:   font-size:larger;
1.388     albertel 6698:   background: $pgbg;
                   6699: }
1.387     albertel 6700: 
1.1029    www      6701: span.LC_current_nav_location {
                   6702:   font-weight:bold;
                   6703:   background: $sidebg;
                   6704: }
                   6705: 
1.395     albertel 6706: span.LC_parm_menu_item {
                   6707:   font-size: larger;
                   6708: }
1.795     www      6709: 
1.395     albertel 6710: span.LC_parm_scope_all {
                   6711:   color: red;
                   6712: }
1.795     www      6713: 
1.395     albertel 6714: span.LC_parm_scope_folder {
                   6715:   color: green;
                   6716: }
1.795     www      6717: 
1.395     albertel 6718: span.LC_parm_scope_resource {
                   6719:   color: orange;
                   6720: }
1.795     www      6721: 
1.395     albertel 6722: span.LC_parm_part {
                   6723:   color: blue;
                   6724: }
1.795     www      6725: 
1.911     bisitz   6726: span.LC_parm_folder,
                   6727: span.LC_parm_symb {
1.395     albertel 6728:   font-size: x-small;
                   6729:   font-family: $mono;
                   6730:   color: #AAAAAA;
                   6731: }
                   6732: 
1.977     bisitz   6733: ul.LC_parm_parmlist li {
                   6734:   display: inline-block;
                   6735:   padding: 0.3em 0.8em;
                   6736:   vertical-align: top;
                   6737:   width: 150px;
                   6738:   border-top:1px solid $lg_border_color;
                   6739: }
                   6740: 
1.795     www      6741: td.LC_parm_overview_level_menu,
                   6742: td.LC_parm_overview_map_menu,
                   6743: td.LC_parm_overview_parm_selectors,
                   6744: td.LC_parm_overview_restrictions  {
1.396     albertel 6745:   border: 1px solid black;
                   6746:   border-collapse: collapse;
                   6747: }
1.795     www      6748: 
1.396     albertel 6749: table.LC_parm_overview_restrictions td {
                   6750:   border-width: 1px 4px 1px 4px;
                   6751:   border-style: solid;
                   6752:   border-color: $pgbg;
                   6753:   text-align: center;
                   6754: }
1.795     www      6755: 
1.396     albertel 6756: table.LC_parm_overview_restrictions th {
                   6757:   background: $tabbg;
                   6758:   border-width: 1px 4px 1px 4px;
                   6759:   border-style: solid;
                   6760:   border-color: $pgbg;
                   6761: }
1.795     www      6762: 
1.398     albertel 6763: table#LC_helpmenu {
1.803     bisitz   6764:   border: none;
1.398     albertel 6765:   height: 55px;
1.803     bisitz   6766:   border-spacing: 0;
1.398     albertel 6767: }
                   6768: 
                   6769: table#LC_helpmenu fieldset legend {
                   6770:   font-size: larger;
                   6771: }
1.795     www      6772: 
1.397     albertel 6773: table#LC_helpmenu_links {
                   6774:   width: 100%;
                   6775:   border: 1px solid black;
                   6776:   background: $pgbg;
1.803     bisitz   6777:   padding: 0;
1.397     albertel 6778:   border-spacing: 1px;
                   6779: }
1.795     www      6780: 
1.397     albertel 6781: table#LC_helpmenu_links tr td {
                   6782:   padding: 1px;
                   6783:   background: $tabbg;
1.399     albertel 6784:   text-align: center;
                   6785:   font-weight: bold;
1.397     albertel 6786: }
1.396     albertel 6787: 
1.795     www      6788: table#LC_helpmenu_links a:link,
                   6789: table#LC_helpmenu_links a:visited,
1.397     albertel 6790: table#LC_helpmenu_links a:active {
                   6791:   text-decoration: none;
                   6792:   color: $font;
                   6793: }
1.795     www      6794: 
1.397     albertel 6795: table#LC_helpmenu_links a:hover {
                   6796:   text-decoration: underline;
                   6797:   color: $vlink;
                   6798: }
1.396     albertel 6799: 
1.417     albertel 6800: .LC_chrt_popup_exists {
                   6801:   border: 1px solid #339933;
                   6802:   margin: -1px;
                   6803: }
1.795     www      6804: 
1.417     albertel 6805: .LC_chrt_popup_up {
                   6806:   border: 1px solid yellow;
                   6807:   margin: -1px;
                   6808: }
1.795     www      6809: 
1.417     albertel 6810: .LC_chrt_popup {
                   6811:   border: 1px solid #8888FF;
                   6812:   background: #CCCCFF;
                   6813: }
1.795     www      6814: 
1.421     albertel 6815: table.LC_pick_box {
                   6816:   border-collapse: separate;
                   6817:   background: white;
                   6818:   border: 1px solid black;
                   6819:   border-spacing: 1px;
                   6820: }
1.795     www      6821: 
1.421     albertel 6822: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6823:   background: $sidebg;
1.421     albertel 6824:   font-weight: bold;
1.900     bisitz   6825:   text-align: left;
1.740     bisitz   6826:   vertical-align: top;
1.421     albertel 6827:   width: 184px;
                   6828:   padding: 8px;
                   6829: }
1.795     www      6830: 
1.579     raeburn  6831: table.LC_pick_box td.LC_pick_box_value {
                   6832:   text-align: left;
                   6833:   padding: 8px;
                   6834: }
1.795     www      6835: 
1.579     raeburn  6836: table.LC_pick_box td.LC_pick_box_select {
                   6837:   text-align: left;
                   6838:   padding: 8px;
                   6839: }
1.795     www      6840: 
1.424     albertel 6841: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6842:   padding: 0;
1.421     albertel 6843:   height: 1px;
                   6844:   background: black;
                   6845: }
1.795     www      6846: 
1.421     albertel 6847: table.LC_pick_box td.LC_pick_box_submit {
                   6848:   text-align: right;
                   6849: }
1.795     www      6850: 
1.579     raeburn  6851: table.LC_pick_box td.LC_evenrow_value {
                   6852:   text-align: left;
                   6853:   padding: 8px;
                   6854:   background-color: $data_table_light;
                   6855: }
1.795     www      6856: 
1.579     raeburn  6857: table.LC_pick_box td.LC_oddrow_value {
                   6858:   text-align: left;
                   6859:   padding: 8px;
                   6860:   background-color: $data_table_light;
                   6861: }
1.795     www      6862: 
1.579     raeburn  6863: span.LC_helpform_receipt_cat {
                   6864:   font-weight: bold;
                   6865: }
1.795     www      6866: 
1.424     albertel 6867: table.LC_group_priv_box {
                   6868:   background: white;
                   6869:   border: 1px solid black;
                   6870:   border-spacing: 1px;
                   6871: }
1.795     www      6872: 
1.424     albertel 6873: table.LC_group_priv_box td.LC_pick_box_title {
                   6874:   background: $tabbg;
                   6875:   font-weight: bold;
                   6876:   text-align: right;
                   6877:   width: 184px;
                   6878: }
1.795     www      6879: 
1.424     albertel 6880: table.LC_group_priv_box td.LC_groups_fixed {
                   6881:   background: $data_table_light;
                   6882:   text-align: center;
                   6883: }
1.795     www      6884: 
1.424     albertel 6885: table.LC_group_priv_box td.LC_groups_optional {
                   6886:   background: $data_table_dark;
                   6887:   text-align: center;
                   6888: }
1.795     www      6889: 
1.424     albertel 6890: table.LC_group_priv_box td.LC_groups_functionality {
                   6891:   background: $data_table_darker;
                   6892:   text-align: center;
                   6893:   font-weight: bold;
                   6894: }
1.795     www      6895: 
1.424     albertel 6896: table.LC_group_priv td {
                   6897:   text-align: left;
1.803     bisitz   6898:   padding: 0;
1.424     albertel 6899: }
                   6900: 
                   6901: .LC_navbuttons {
                   6902:   margin: 2ex 0ex 2ex 0ex;
                   6903: }
1.795     www      6904: 
1.423     albertel 6905: .LC_topic_bar {
                   6906:   font-weight: bold;
                   6907:   background: $tabbg;
1.918     wenzelju 6908:   margin: 1em 0em 1em 2em;
1.805     bisitz   6909:   padding: 3px;
1.918     wenzelju 6910:   font-size: 1.2em;
1.423     albertel 6911: }
1.795     www      6912: 
1.423     albertel 6913: .LC_topic_bar span {
1.918     wenzelju 6914:   left: 0.5em;
                   6915:   position: absolute;
1.423     albertel 6916:   vertical-align: middle;
1.918     wenzelju 6917:   font-size: 1.2em;
1.423     albertel 6918: }
1.795     www      6919: 
1.423     albertel 6920: table.LC_course_group_status {
                   6921:   margin: 20px;
                   6922: }
1.795     www      6923: 
1.423     albertel 6924: table.LC_status_selector td {
                   6925:   vertical-align: top;
                   6926:   text-align: center;
1.424     albertel 6927:   padding: 4px;
                   6928: }
1.795     www      6929: 
1.599     albertel 6930: div.LC_feedback_link {
1.616     albertel 6931:   clear: both;
1.829     kalberla 6932:   background: $sidebg;
1.779     bisitz   6933:   width: 100%;
1.829     kalberla 6934:   padding-bottom: 10px;
                   6935:   border: 1px $tabbg solid;
1.833     kalberla 6936:   height: 22px;
                   6937:   line-height: 22px;
                   6938:   padding-top: 5px;
                   6939: }
                   6940: 
                   6941: div.LC_feedback_link img {
                   6942:   height: 22px;
1.867     kalberla 6943:   vertical-align:middle;
1.829     kalberla 6944: }
                   6945: 
1.911     bisitz   6946: div.LC_feedback_link a {
1.829     kalberla 6947:   text-decoration: none;
1.489     raeburn  6948: }
1.795     www      6949: 
1.867     kalberla 6950: div.LC_comblock {
1.911     bisitz   6951:   display:inline;
1.867     kalberla 6952:   color:$font;
                   6953:   font-size:90%;
                   6954: }
                   6955: 
                   6956: div.LC_feedback_link div.LC_comblock {
                   6957:   padding-left:5px;
                   6958: }
                   6959: 
                   6960: div.LC_feedback_link div.LC_comblock a {
                   6961:   color:$font;
                   6962: }
                   6963: 
1.489     raeburn  6964: span.LC_feedback_link {
1.858     bisitz   6965:   /* background: $feedback_link_bg; */
1.599     albertel 6966:   font-size: larger;
                   6967: }
1.795     www      6968: 
1.599     albertel 6969: span.LC_message_link {
1.858     bisitz   6970:   /* background: $feedback_link_bg; */
1.599     albertel 6971:   font-size: larger;
                   6972:   position: absolute;
                   6973:   right: 1em;
1.489     raeburn  6974: }
1.421     albertel 6975: 
1.515     albertel 6976: table.LC_prior_tries {
1.524     albertel 6977:   border: 1px solid #000000;
                   6978:   border-collapse: separate;
                   6979:   border-spacing: 1px;
1.515     albertel 6980: }
1.523     albertel 6981: 
1.515     albertel 6982: table.LC_prior_tries td {
1.524     albertel 6983:   padding: 2px;
1.515     albertel 6984: }
1.523     albertel 6985: 
                   6986: .LC_answer_correct {
1.795     www      6987:   background: lightgreen;
                   6988:   color: darkgreen;
                   6989:   padding: 6px;
1.523     albertel 6990: }
1.795     www      6991: 
1.523     albertel 6992: .LC_answer_charged_try {
1.797     www      6993:   background: #FFAAAA;
1.795     www      6994:   color: darkred;
                   6995:   padding: 6px;
1.523     albertel 6996: }
1.795     www      6997: 
1.779     bisitz   6998: .LC_answer_not_charged_try,
1.523     albertel 6999: .LC_answer_no_grade,
                   7000: .LC_answer_late {
1.795     www      7001:   background: lightyellow;
1.523     albertel 7002:   color: black;
1.795     www      7003:   padding: 6px;
1.523     albertel 7004: }
1.795     www      7005: 
1.523     albertel 7006: .LC_answer_previous {
1.795     www      7007:   background: lightblue;
                   7008:   color: darkblue;
                   7009:   padding: 6px;
1.523     albertel 7010: }
1.795     www      7011: 
1.779     bisitz   7012: .LC_answer_no_message {
1.777     tempelho 7013:   background: #FFFFFF;
                   7014:   color: black;
1.795     www      7015:   padding: 6px;
1.779     bisitz   7016: }
1.795     www      7017: 
1.1075.2.140  raeburn  7018: .LC_answer_unknown,
                   7019: .LC_answer_warning {
1.779     bisitz   7020:   background: orange;
                   7021:   color: black;
1.795     www      7022:   padding: 6px;
1.777     tempelho 7023: }
1.795     www      7024: 
1.529     albertel 7025: span.LC_prior_numerical,
                   7026: span.LC_prior_string,
                   7027: span.LC_prior_custom,
                   7028: span.LC_prior_reaction,
                   7029: span.LC_prior_math {
1.925     bisitz   7030:   font-family: $mono;
1.523     albertel 7031:   white-space: pre;
                   7032: }
                   7033: 
1.525     albertel 7034: span.LC_prior_string {
1.925     bisitz   7035:   font-family: $mono;
1.525     albertel 7036:   white-space: pre;
                   7037: }
                   7038: 
1.523     albertel 7039: table.LC_prior_option {
                   7040:   width: 100%;
                   7041:   border-collapse: collapse;
                   7042: }
1.795     www      7043: 
1.911     bisitz   7044: table.LC_prior_rank,
1.795     www      7045: table.LC_prior_match {
1.528     albertel 7046:   border-collapse: collapse;
                   7047: }
1.795     www      7048: 
1.528     albertel 7049: table.LC_prior_option tr td,
                   7050: table.LC_prior_rank tr td,
                   7051: table.LC_prior_match tr td {
1.524     albertel 7052:   border: 1px solid #000000;
1.515     albertel 7053: }
                   7054: 
1.855     bisitz   7055: .LC_nobreak {
1.544     albertel 7056:   white-space: nowrap;
1.519     raeburn  7057: }
                   7058: 
1.576     raeburn  7059: span.LC_cusr_emph {
                   7060:   font-style: italic;
                   7061: }
                   7062: 
1.633     raeburn  7063: span.LC_cusr_subheading {
                   7064:   font-weight: normal;
                   7065:   font-size: 85%;
                   7066: }
                   7067: 
1.861     bisitz   7068: div.LC_docs_entry_move {
1.859     bisitz   7069:   border: 1px solid #BBBBBB;
1.545     albertel 7070:   background: #DDDDDD;
1.861     bisitz   7071:   width: 22px;
1.859     bisitz   7072:   padding: 1px;
                   7073:   margin: 0;
1.545     albertel 7074: }
                   7075: 
1.861     bisitz   7076: table.LC_data_table tr > td.LC_docs_entry_commands,
                   7077: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 7078:   font-size: x-small;
                   7079: }
1.795     www      7080: 
1.861     bisitz   7081: .LC_docs_entry_parameter {
                   7082:   white-space: nowrap;
                   7083: }
                   7084: 
1.544     albertel 7085: .LC_docs_copy {
1.545     albertel 7086:   color: #000099;
1.544     albertel 7087: }
1.795     www      7088: 
1.544     albertel 7089: .LC_docs_cut {
1.545     albertel 7090:   color: #550044;
1.544     albertel 7091: }
1.795     www      7092: 
1.544     albertel 7093: .LC_docs_rename {
1.545     albertel 7094:   color: #009900;
1.544     albertel 7095: }
1.795     www      7096: 
1.544     albertel 7097: .LC_docs_remove {
1.545     albertel 7098:   color: #990000;
                   7099: }
                   7100: 
1.1075.2.134  raeburn  7101: .LC_domprefs_email,
1.547     albertel 7102: .LC_docs_reinit_warn,
                   7103: .LC_docs_ext_edit {
                   7104:   font-size: x-small;
                   7105: }
                   7106: 
1.545     albertel 7107: table.LC_docs_adddocs td,
                   7108: table.LC_docs_adddocs th {
                   7109:   border: 1px solid #BBBBBB;
                   7110:   padding: 4px;
                   7111:   background: #DDDDDD;
1.543     albertel 7112: }
                   7113: 
1.584     albertel 7114: table.LC_sty_begin {
                   7115:   background: #BBFFBB;
                   7116: }
1.795     www      7117: 
1.584     albertel 7118: table.LC_sty_end {
                   7119:   background: #FFBBBB;
                   7120: }
                   7121: 
1.589     raeburn  7122: table.LC_double_column {
1.803     bisitz   7123:   border-width: 0;
1.589     raeburn  7124:   border-collapse: collapse;
                   7125:   width: 100%;
                   7126:   padding: 2px;
                   7127: }
                   7128: 
                   7129: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  7130:   top: 2px;
1.589     raeburn  7131:   left: 2px;
                   7132:   width: 47%;
                   7133:   vertical-align: top;
                   7134: }
                   7135: 
                   7136: table.LC_double_column tr td.LC_right_col {
                   7137:   top: 2px;
1.779     bisitz   7138:   right: 2px;
1.589     raeburn  7139:   width: 47%;
                   7140:   vertical-align: top;
                   7141: }
                   7142: 
1.591     raeburn  7143: div.LC_left_float {
                   7144:   float: left;
                   7145:   padding-right: 5%;
1.597     albertel 7146:   padding-bottom: 4px;
1.591     raeburn  7147: }
                   7148: 
                   7149: div.LC_clear_float_header {
1.597     albertel 7150:   padding-bottom: 2px;
1.591     raeburn  7151: }
                   7152: 
                   7153: div.LC_clear_float_footer {
1.597     albertel 7154:   padding-top: 10px;
1.591     raeburn  7155:   clear: both;
                   7156: }
                   7157: 
1.597     albertel 7158: div.LC_grade_show_user {
1.941     bisitz   7159: /*  border-left: 5px solid $sidebg; */
                   7160:   border-top: 5px solid #000000;
                   7161:   margin: 50px 0 0 0;
1.936     bisitz   7162:   padding: 15px 0 5px 10px;
1.597     albertel 7163: }
1.795     www      7164: 
1.936     bisitz   7165: div.LC_grade_show_user_odd_row {
1.941     bisitz   7166: /*  border-left: 5px solid #000000; */
                   7167: }
                   7168: 
                   7169: div.LC_grade_show_user div.LC_Box {
                   7170:   margin-right: 50px;
1.597     albertel 7171: }
                   7172: 
                   7173: div.LC_grade_submissions,
                   7174: div.LC_grade_message_center,
1.936     bisitz   7175: div.LC_grade_info_links {
1.597     albertel 7176:   margin: 5px;
                   7177:   width: 99%;
                   7178:   background: #FFFFFF;
                   7179: }
1.795     www      7180: 
1.597     albertel 7181: div.LC_grade_submissions_header,
1.936     bisitz   7182: div.LC_grade_message_center_header {
1.705     tempelho 7183:   font-weight: bold;
                   7184:   font-size: large;
1.597     albertel 7185: }
1.795     www      7186: 
1.597     albertel 7187: div.LC_grade_submissions_body,
1.936     bisitz   7188: div.LC_grade_message_center_body {
1.597     albertel 7189:   border: 1px solid black;
                   7190:   width: 99%;
                   7191:   background: #FFFFFF;
                   7192: }
1.795     www      7193: 
1.613     albertel 7194: table.LC_scantron_action {
                   7195:   width: 100%;
                   7196: }
1.795     www      7197: 
1.613     albertel 7198: table.LC_scantron_action tr th {
1.698     harmsja  7199:   font-weight:bold;
                   7200:   font-style:normal;
1.613     albertel 7201: }
1.795     www      7202: 
1.779     bisitz   7203: .LC_edit_problem_header,
1.614     albertel 7204: div.LC_edit_problem_footer {
1.705     tempelho 7205:   font-weight: normal;
                   7206:   font-size:  medium;
1.602     albertel 7207:   margin: 2px;
1.1060    bisitz   7208:   background-color: $sidebg;
1.600     albertel 7209: }
1.795     www      7210: 
1.600     albertel 7211: div.LC_edit_problem_header,
1.602     albertel 7212: div.LC_edit_problem_header div,
1.614     albertel 7213: div.LC_edit_problem_footer,
                   7214: div.LC_edit_problem_footer div,
1.602     albertel 7215: div.LC_edit_problem_editxml_header,
                   7216: div.LC_edit_problem_editxml_header div {
1.1075.2.112  raeburn  7217:   z-index: 100;
1.600     albertel 7218: }
1.795     www      7219: 
1.600     albertel 7220: div.LC_edit_problem_header_title {
1.705     tempelho 7221:   font-weight: bold;
                   7222:   font-size: larger;
1.602     albertel 7223:   background: $tabbg;
                   7224:   padding: 3px;
1.1060    bisitz   7225:   margin: 0 0 5px 0;
1.602     albertel 7226: }
1.795     www      7227: 
1.602     albertel 7228: table.LC_edit_problem_header_title {
                   7229:   width: 100%;
1.600     albertel 7230:   background: $tabbg;
1.602     albertel 7231: }
                   7232: 
1.1075.2.112  raeburn  7233: div.LC_edit_actionbar {
                   7234:     background-color: $sidebg;
                   7235:     margin: 0;
                   7236:     padding: 0;
                   7237:     line-height: 200%;
1.602     albertel 7238: }
1.795     www      7239: 
1.1075.2.112  raeburn  7240: div.LC_edit_actionbar div{
                   7241:     padding: 0;
                   7242:     margin: 0;
                   7243:     display: inline-block;
1.600     albertel 7244: }
1.795     www      7245: 
1.1075.2.34  raeburn  7246: .LC_edit_opt {
                   7247:   padding-left: 1em;
                   7248:   white-space: nowrap;
                   7249: }
                   7250: 
1.1075.2.57  raeburn  7251: .LC_edit_problem_latexhelper{
                   7252:     text-align: right;
                   7253: }
                   7254: 
                   7255: #LC_edit_problem_colorful div{
                   7256:     margin-left: 40px;
                   7257: }
                   7258: 
1.1075.2.112  raeburn  7259: #LC_edit_problem_codemirror div{
                   7260:     margin-left: 0px;
                   7261: }
                   7262: 
1.911     bisitz   7263: img.stift {
1.803     bisitz   7264:   border-width: 0;
                   7265:   vertical-align: middle;
1.677     riegler  7266: }
1.680     riegler  7267: 
1.923     bisitz   7268: table td.LC_mainmenu_col_fieldset {
1.680     riegler  7269:   vertical-align: top;
1.777     tempelho 7270: }
1.795     www      7271: 
1.716     raeburn  7272: div.LC_createcourse {
1.911     bisitz   7273:   margin: 10px 10px 10px 10px;
1.716     raeburn  7274: }
                   7275: 
1.917     raeburn  7276: .LC_dccid {
1.1075.2.38  raeburn  7277:   float: right;
1.917     raeburn  7278:   margin: 0.2em 0 0 0;
                   7279:   padding: 0;
                   7280:   font-size: 90%;
                   7281:   display:none;
                   7282: }
                   7283: 
1.897     wenzelju 7284: ol.LC_primary_menu a:hover,
1.721     harmsja  7285: ol#LC_MenuBreadcrumbs a:hover,
                   7286: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 7287: ul#LC_secondary_menu a:hover,
1.721     harmsja  7288: .LC_FormSectionClearButton input:hover
1.795     www      7289: ul.LC_TabContent   li:hover a {
1.952     onken    7290:   color:$button_hover;
1.911     bisitz   7291:   text-decoration:none;
1.693     droeschl 7292: }
                   7293: 
1.779     bisitz   7294: h1 {
1.911     bisitz   7295:   padding: 0;
                   7296:   line-height:130%;
1.693     droeschl 7297: }
1.698     harmsja  7298: 
1.911     bisitz   7299: h2,
                   7300: h3,
                   7301: h4,
                   7302: h5,
                   7303: h6 {
                   7304:   margin: 5px 0 5px 0;
                   7305:   padding: 0;
                   7306:   line-height:130%;
1.693     droeschl 7307: }
1.795     www      7308: 
                   7309: .LC_hcell {
1.911     bisitz   7310:   padding:3px 15px 3px 15px;
                   7311:   margin: 0;
                   7312:   background-color:$tabbg;
                   7313:   color:$fontmenu;
                   7314:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 7315: }
1.795     www      7316: 
1.840     bisitz   7317: .LC_Box > .LC_hcell {
1.911     bisitz   7318:   margin: 0 -10px 10px -10px;
1.835     bisitz   7319: }
                   7320: 
1.721     harmsja  7321: .LC_noBorder {
1.911     bisitz   7322:   border: 0;
1.698     harmsja  7323: }
1.693     droeschl 7324: 
1.721     harmsja  7325: .LC_FormSectionClearButton input {
1.911     bisitz   7326:   background-color:transparent;
                   7327:   border: none;
                   7328:   cursor:pointer;
                   7329:   text-decoration:underline;
1.693     droeschl 7330: }
1.763     bisitz   7331: 
                   7332: .LC_help_open_topic {
1.911     bisitz   7333:   color: #FFFFFF;
                   7334:   background-color: #EEEEFF;
                   7335:   margin: 1px;
                   7336:   padding: 4px;
                   7337:   border: 1px solid #000033;
                   7338:   white-space: nowrap;
                   7339:   /* vertical-align: middle; */
1.759     neumanie 7340: }
1.693     droeschl 7341: 
1.911     bisitz   7342: dl,
                   7343: ul,
                   7344: div,
                   7345: fieldset {
                   7346:   margin: 10px 10px 10px 0;
                   7347:   /* overflow: hidden; */
1.693     droeschl 7348: }
1.795     www      7349: 
1.1075.2.90  raeburn  7350: article.geogebraweb div {
                   7351:     margin: 0;
                   7352: }
                   7353: 
1.838     bisitz   7354: fieldset > legend {
1.911     bisitz   7355:   font-weight: bold;
                   7356:   padding: 0 5px 0 5px;
1.838     bisitz   7357: }
                   7358: 
1.813     bisitz   7359: #LC_nav_bar {
1.911     bisitz   7360:   float: left;
1.995     raeburn  7361:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   7362:   margin: 0 0 2px 0;
1.807     droeschl 7363: }
                   7364: 
1.916     droeschl 7365: #LC_realm {
                   7366:   margin: 0.2em 0 0 0;
                   7367:   padding: 0;
                   7368:   font-weight: bold;
                   7369:   text-align: center;
1.995     raeburn  7370:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 7371: }
                   7372: 
1.911     bisitz   7373: #LC_nav_bar em {
                   7374:   font-weight: bold;
                   7375:   font-style: normal;
1.807     droeschl 7376: }
                   7377: 
1.897     wenzelju 7378: ol.LC_primary_menu {
1.934     droeschl 7379:   margin: 0;
1.1075.2.2  raeburn  7380:   padding: 0;
1.807     droeschl 7381: }
                   7382: 
1.852     droeschl 7383: ol#LC_PathBreadcrumbs {
1.911     bisitz   7384:   margin: 0;
1.693     droeschl 7385: }
                   7386: 
1.897     wenzelju 7387: ol.LC_primary_menu li {
1.1075.2.2  raeburn  7388:   color: RGB(80, 80, 80);
                   7389:   vertical-align: middle;
                   7390:   text-align: left;
                   7391:   list-style: none;
1.1075.2.112  raeburn  7392:   position: relative;
1.1075.2.2  raeburn  7393:   float: left;
1.1075.2.112  raeburn  7394:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   7395:   line-height: 1.5em;
1.1075.2.2  raeburn  7396: }
                   7397: 
1.1075.2.113  raeburn  7398: ol.LC_primary_menu li a, 
1.1075.2.112  raeburn  7399: ol.LC_primary_menu li p {
1.1075.2.2  raeburn  7400:   display: block;
                   7401:   margin: 0;
                   7402:   padding: 0 5px 0 10px;
                   7403:   text-decoration: none;
                   7404: }
                   7405: 
1.1075.2.112  raeburn  7406: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   7407:   display: inline-block;
                   7408:   width: 95%;
                   7409:   text-align: left;
                   7410: }
                   7411: 
                   7412: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   7413:   display: inline-block;
                   7414:   width: 5%;
                   7415:   float: right;
                   7416:   text-align: right;
                   7417:   font-size: 70%;
                   7418: }
                   7419: 
                   7420: ol.LC_primary_menu ul {
1.1075.2.2  raeburn  7421:   display: none;
1.1075.2.112  raeburn  7422:   width: 15em;
1.1075.2.2  raeburn  7423:   background-color: $data_table_light;
1.1075.2.112  raeburn  7424:   position: absolute;
                   7425:   top: 100%;
                   7426: }
                   7427: 
                   7428: ol.LC_primary_menu ul ul {
                   7429:   left: 100%;
                   7430:   top: 0;
1.1075.2.2  raeburn  7431: }
                   7432: 
1.1075.2.112  raeburn  7433: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2  raeburn  7434:   display: block;
                   7435:   position: absolute;
                   7436:   margin: 0;
                   7437:   padding: 0;
1.1075.2.5  raeburn  7438:   z-index: 2;
1.1075.2.2  raeburn  7439: }
                   7440: 
                   7441: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112  raeburn  7442: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2  raeburn  7443:   font-size: 90%;
1.911     bisitz   7444:   vertical-align: top;
1.1075.2.2  raeburn  7445:   float: none;
1.1075.2.5  raeburn  7446:   border-left: 1px solid black;
                   7447:   border-right: 1px solid black;
1.1075.2.112  raeburn  7448: /* A dark bottom border to visualize different menu options;
                   7449: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7450:   border-bottom: 1px solid $data_table_dark;
1.1075.2.2  raeburn  7451: }
                   7452: 
1.1075.2.112  raeburn  7453: ol.LC_primary_menu li li p:hover {
                   7454:   color:$button_hover;
                   7455:   text-decoration:none;
                   7456:   background-color:$data_table_dark;
1.1075.2.2  raeburn  7457: }
                   7458: 
                   7459: ol.LC_primary_menu li li a:hover {
                   7460:    color:$button_hover;
                   7461:    background-color:$data_table_dark;
1.693     droeschl 7462: }
                   7463: 
1.1075.2.112  raeburn  7464: /* Font-size equal to the size of the predecessors*/
                   7465: ol.LC_primary_menu li:hover li li {
                   7466:   font-size: 100%;
                   7467: }
                   7468: 
1.897     wenzelju 7469: ol.LC_primary_menu li img {
1.911     bisitz   7470:   vertical-align: bottom;
1.934     droeschl 7471:   height: 1.1em;
1.1075.2.3  raeburn  7472:   margin: 0.2em 0 0 0;
1.693     droeschl 7473: }
                   7474: 
1.897     wenzelju 7475: ol.LC_primary_menu a {
1.911     bisitz   7476:   color: RGB(80, 80, 80);
                   7477:   text-decoration: none;
1.693     droeschl 7478: }
1.795     www      7479: 
1.949     droeschl 7480: ol.LC_primary_menu a.LC_new_message {
                   7481:   font-weight:bold;
                   7482:   color: darkred;
                   7483: }
                   7484: 
1.975     raeburn  7485: ol.LC_docs_parameters {
                   7486:   margin-left: 0;
                   7487:   padding: 0;
                   7488:   list-style: none;
                   7489: }
                   7490: 
                   7491: ol.LC_docs_parameters li {
                   7492:   margin: 0;
                   7493:   padding-right: 20px;
                   7494:   display: inline;
                   7495: }
                   7496: 
1.976     raeburn  7497: ol.LC_docs_parameters li:before {
                   7498:   content: "\\002022 \\0020";
                   7499: }
                   7500: 
                   7501: li.LC_docs_parameters_title {
                   7502:   font-weight: bold;
                   7503: }
                   7504: 
                   7505: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7506:   content: "";
                   7507: }
                   7508: 
1.897     wenzelju 7509: ul#LC_secondary_menu {
1.1075.2.23  raeburn  7510:   clear: right;
1.911     bisitz   7511:   color: $fontmenu;
                   7512:   background: $tabbg;
                   7513:   list-style: none;
                   7514:   padding: 0;
                   7515:   margin: 0;
                   7516:   width: 100%;
1.995     raeburn  7517:   text-align: left;
1.1075.2.4  raeburn  7518:   float: left;
1.808     droeschl 7519: }
                   7520: 
1.897     wenzelju 7521: ul#LC_secondary_menu li {
1.911     bisitz   7522:   font-weight: bold;
                   7523:   line-height: 1.8em;
                   7524:   border-right: 1px solid black;
1.1075.2.4  raeburn  7525:   float: left;
                   7526: }
                   7527: 
                   7528: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7529:   background-color: $data_table_light;
                   7530: }
                   7531: 
                   7532: ul#LC_secondary_menu li a {
                   7533:   padding: 0 0.8em;
                   7534: }
                   7535: 
                   7536: ul#LC_secondary_menu li ul {
                   7537:   display: none;
                   7538: }
                   7539: 
                   7540: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7541:   display: block;
                   7542:   position: absolute;
                   7543:   margin: 0;
                   7544:   padding: 0;
                   7545:   list-style:none;
                   7546:   float: none;
                   7547:   background-color: $data_table_light;
1.1075.2.5  raeburn  7548:   z-index: 2;
1.1075.2.10  raeburn  7549:   margin-left: -1px;
1.1075.2.4  raeburn  7550: }
                   7551: 
                   7552: ul#LC_secondary_menu li ul li {
                   7553:   font-size: 90%;
                   7554:   vertical-align: top;
                   7555:   border-left: 1px solid black;
                   7556:   border-right: 1px solid black;
1.1075.2.33  raeburn  7557:   background-color: $data_table_light;
1.1075.2.4  raeburn  7558:   list-style:none;
                   7559:   float: none;
                   7560: }
                   7561: 
                   7562: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7563:   background-color: $data_table_dark;
1.807     droeschl 7564: }
                   7565: 
1.847     tempelho 7566: ul.LC_TabContent {
1.911     bisitz   7567:   display:block;
                   7568:   background: $sidebg;
                   7569:   border-bottom: solid 1px $lg_border_color;
                   7570:   list-style:none;
1.1020    raeburn  7571:   margin: -1px -10px 0 -10px;
1.911     bisitz   7572:   padding: 0;
1.693     droeschl 7573: }
                   7574: 
1.795     www      7575: ul.LC_TabContent li,
                   7576: ul.LC_TabContentBigger li {
1.911     bisitz   7577:   float:left;
1.741     harmsja  7578: }
1.795     www      7579: 
1.897     wenzelju 7580: ul#LC_secondary_menu li a {
1.911     bisitz   7581:   color: $fontmenu;
                   7582:   text-decoration: none;
1.693     droeschl 7583: }
1.795     www      7584: 
1.721     harmsja  7585: ul.LC_TabContent {
1.952     onken    7586:   min-height:20px;
1.721     harmsja  7587: }
1.795     www      7588: 
                   7589: ul.LC_TabContent li {
1.911     bisitz   7590:   vertical-align:middle;
1.959     onken    7591:   padding: 0 16px 0 10px;
1.911     bisitz   7592:   background-color:$tabbg;
                   7593:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7594:   border-left: solid 1px $font;
1.721     harmsja  7595: }
1.795     www      7596: 
1.847     tempelho 7597: ul.LC_TabContent .right {
1.911     bisitz   7598:   float:right;
1.847     tempelho 7599: }
                   7600: 
1.911     bisitz   7601: ul.LC_TabContent li a,
                   7602: ul.LC_TabContent li {
                   7603:   color:rgb(47,47,47);
                   7604:   text-decoration:none;
                   7605:   font-size:95%;
                   7606:   font-weight:bold;
1.952     onken    7607:   min-height:20px;
                   7608: }
                   7609: 
1.959     onken    7610: ul.LC_TabContent li a:hover,
                   7611: ul.LC_TabContent li a:focus {
1.952     onken    7612:   color: $button_hover;
1.959     onken    7613:   background:none;
                   7614:   outline:none;
1.952     onken    7615: }
                   7616: 
                   7617: ul.LC_TabContent li:hover {
                   7618:   color: $button_hover;
                   7619:   cursor:pointer;
1.721     harmsja  7620: }
1.795     www      7621: 
1.911     bisitz   7622: ul.LC_TabContent li.active {
1.952     onken    7623:   color: $font;
1.911     bisitz   7624:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7625:   border-bottom:solid 1px #FFFFFF;
                   7626:   cursor: default;
1.744     ehlerst  7627: }
1.795     www      7628: 
1.959     onken    7629: ul.LC_TabContent li.active a {
                   7630:   color:$font;
                   7631:   background:#FFFFFF;
                   7632:   outline: none;
                   7633: }
1.1047    raeburn  7634: 
                   7635: ul.LC_TabContent li.goback {
                   7636:   float: left;
                   7637:   border-left: none;
                   7638: }
                   7639: 
1.870     tempelho 7640: #maincoursedoc {
1.911     bisitz   7641:   clear:both;
1.870     tempelho 7642: }
                   7643: 
                   7644: ul.LC_TabContentBigger {
1.911     bisitz   7645:   display:block;
                   7646:   list-style:none;
                   7647:   padding: 0;
1.870     tempelho 7648: }
                   7649: 
1.795     www      7650: ul.LC_TabContentBigger li {
1.911     bisitz   7651:   vertical-align:bottom;
                   7652:   height: 30px;
                   7653:   font-size:110%;
                   7654:   font-weight:bold;
                   7655:   color: #737373;
1.841     tempelho 7656: }
                   7657: 
1.957     onken    7658: ul.LC_TabContentBigger li.active {
                   7659:   position: relative;
                   7660:   top: 1px;
                   7661: }
                   7662: 
1.870     tempelho 7663: ul.LC_TabContentBigger li a {
1.911     bisitz   7664:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7665:   height: 30px;
                   7666:   line-height: 30px;
                   7667:   text-align: center;
                   7668:   display: block;
                   7669:   text-decoration: none;
1.958     onken    7670:   outline: none;  
1.741     harmsja  7671: }
1.795     www      7672: 
1.870     tempelho 7673: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7674:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7675:   color:$font;
1.744     ehlerst  7676: }
1.795     www      7677: 
1.870     tempelho 7678: ul.LC_TabContentBigger li b {
1.911     bisitz   7679:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7680:   display: block;
                   7681:   float: left;
                   7682:   padding: 0 30px;
1.957     onken    7683:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7684: }
                   7685: 
1.956     onken    7686: ul.LC_TabContentBigger li:hover b {
                   7687:   color:$button_hover;
                   7688: }
                   7689: 
1.870     tempelho 7690: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7691:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7692:   color:$font;
1.957     onken    7693:   border: 0;
1.741     harmsja  7694: }
1.693     droeschl 7695: 
1.870     tempelho 7696: 
1.862     bisitz   7697: ul.LC_CourseBreadcrumbs {
                   7698:   background: $sidebg;
1.1020    raeburn  7699:   height: 2em;
1.862     bisitz   7700:   padding-left: 10px;
1.1020    raeburn  7701:   margin: 0;
1.862     bisitz   7702:   list-style-position: inside;
                   7703: }
                   7704: 
1.911     bisitz   7705: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7706: ol#LC_PathBreadcrumbs {
1.911     bisitz   7707:   padding-left: 10px;
                   7708:   margin: 0;
1.933     droeschl 7709:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7710: }
                   7711: 
1.911     bisitz   7712: ol#LC_MenuBreadcrumbs li,
                   7713: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7714: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7715:   display: inline;
1.933     droeschl 7716:   white-space: normal;  
1.693     droeschl 7717: }
                   7718: 
1.823     bisitz   7719: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7720: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7721:   text-decoration: none;
                   7722:   font-size:90%;
1.693     droeschl 7723: }
1.795     www      7724: 
1.969     droeschl 7725: ol#LC_MenuBreadcrumbs h1 {
                   7726:   display: inline;
                   7727:   font-size: 90%;
                   7728:   line-height: 2.5em;
                   7729:   margin: 0;
                   7730:   padding: 0;
                   7731: }
                   7732: 
1.795     www      7733: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7734:   text-decoration:none;
                   7735:   font-size:100%;
                   7736:   font-weight:bold;
1.693     droeschl 7737: }
1.795     www      7738: 
1.840     bisitz   7739: .LC_Box {
1.911     bisitz   7740:   border: solid 1px $lg_border_color;
                   7741:   padding: 0 10px 10px 10px;
1.746     neumanie 7742: }
1.795     www      7743: 
1.1020    raeburn  7744: .LC_DocsBox {
                   7745:   border: solid 1px $lg_border_color;
                   7746:   padding: 0 0 10px 10px;
                   7747: }
                   7748: 
1.795     www      7749: .LC_AboutMe_Image {
1.911     bisitz   7750:   float:left;
                   7751:   margin-right:10px;
1.747     neumanie 7752: }
1.795     www      7753: 
                   7754: .LC_Clear_AboutMe_Image {
1.911     bisitz   7755:   clear:left;
1.747     neumanie 7756: }
1.795     www      7757: 
1.721     harmsja  7758: dl.LC_ListStyleClean dt {
1.911     bisitz   7759:   padding-right: 5px;
                   7760:   display: table-header-group;
1.693     droeschl 7761: }
                   7762: 
1.721     harmsja  7763: dl.LC_ListStyleClean dd {
1.911     bisitz   7764:   display: table-row;
1.693     droeschl 7765: }
                   7766: 
1.721     harmsja  7767: .LC_ListStyleClean,
                   7768: .LC_ListStyleSimple,
                   7769: .LC_ListStyleNormal,
1.795     www      7770: .LC_ListStyleSpecial {
1.911     bisitz   7771:   /* display:block; */
                   7772:   list-style-position: inside;
                   7773:   list-style-type: none;
                   7774:   overflow: hidden;
                   7775:   padding: 0;
1.693     droeschl 7776: }
                   7777: 
1.721     harmsja  7778: .LC_ListStyleSimple li,
                   7779: .LC_ListStyleSimple dd,
                   7780: .LC_ListStyleNormal li,
                   7781: .LC_ListStyleNormal dd,
                   7782: .LC_ListStyleSpecial li,
1.795     www      7783: .LC_ListStyleSpecial dd {
1.911     bisitz   7784:   margin: 0;
                   7785:   padding: 5px 5px 5px 10px;
                   7786:   clear: both;
1.693     droeschl 7787: }
                   7788: 
1.721     harmsja  7789: .LC_ListStyleClean li,
                   7790: .LC_ListStyleClean dd {
1.911     bisitz   7791:   padding-top: 0;
                   7792:   padding-bottom: 0;
1.693     droeschl 7793: }
                   7794: 
1.721     harmsja  7795: .LC_ListStyleSimple dd,
1.795     www      7796: .LC_ListStyleSimple li {
1.911     bisitz   7797:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 7798: }
                   7799: 
1.721     harmsja  7800: .LC_ListStyleSpecial li,
                   7801: .LC_ListStyleSpecial dd {
1.911     bisitz   7802:   list-style-type: none;
                   7803:   background-color: RGB(220, 220, 220);
                   7804:   margin-bottom: 4px;
1.693     droeschl 7805: }
                   7806: 
1.721     harmsja  7807: table.LC_SimpleTable {
1.911     bisitz   7808:   margin:5px;
                   7809:   border:solid 1px $lg_border_color;
1.795     www      7810: }
1.693     droeschl 7811: 
1.721     harmsja  7812: table.LC_SimpleTable tr {
1.911     bisitz   7813:   padding: 0;
                   7814:   border:solid 1px $lg_border_color;
1.693     droeschl 7815: }
1.795     www      7816: 
                   7817: table.LC_SimpleTable thead {
1.911     bisitz   7818:   background:rgb(220,220,220);
1.693     droeschl 7819: }
                   7820: 
1.721     harmsja  7821: div.LC_columnSection {
1.911     bisitz   7822:   display: block;
                   7823:   clear: both;
                   7824:   overflow: hidden;
                   7825:   margin: 0;
1.693     droeschl 7826: }
                   7827: 
1.721     harmsja  7828: div.LC_columnSection>* {
1.911     bisitz   7829:   float: left;
                   7830:   margin: 10px 20px 10px 0;
                   7831:   overflow:hidden;
1.693     droeschl 7832: }
1.721     harmsja  7833: 
1.795     www      7834: table em {
1.911     bisitz   7835:   font-weight: bold;
                   7836:   font-style: normal;
1.748     schulted 7837: }
1.795     www      7838: 
1.779     bisitz   7839: table.LC_tableBrowseRes,
1.795     www      7840: table.LC_tableOfContent {
1.911     bisitz   7841:   border:none;
                   7842:   border-spacing: 1px;
                   7843:   padding: 3px;
                   7844:   background-color: #FFFFFF;
                   7845:   font-size: 90%;
1.753     droeschl 7846: }
1.789     droeschl 7847: 
1.911     bisitz   7848: table.LC_tableOfContent {
                   7849:   border-collapse: collapse;
1.789     droeschl 7850: }
                   7851: 
1.771     droeschl 7852: table.LC_tableBrowseRes a,
1.768     schulted 7853: table.LC_tableOfContent a {
1.911     bisitz   7854:   background-color: transparent;
                   7855:   text-decoration: none;
1.753     droeschl 7856: }
                   7857: 
1.795     www      7858: table.LC_tableOfContent img {
1.911     bisitz   7859:   border: none;
                   7860:   height: 1.3em;
                   7861:   vertical-align: text-bottom;
                   7862:   margin-right: 0.3em;
1.753     droeschl 7863: }
1.757     schulted 7864: 
1.795     www      7865: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7866:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7867: }
                   7868: 
1.795     www      7869: a#LC_content_toolbar_everything {
1.911     bisitz   7870:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7871: }
                   7872: 
1.795     www      7873: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7874:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7875: }
                   7876: 
1.795     www      7877: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7878:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7879: }
                   7880: 
1.795     www      7881: a#LC_content_toolbar_changefolder {
1.911     bisitz   7882:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7883: }
                   7884: 
1.795     www      7885: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7886:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7887: }
                   7888: 
1.1043    raeburn  7889: a#LC_content_toolbar_edittoplevel {
                   7890:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7891: }
                   7892: 
1.795     www      7893: ul#LC_toolbar li a:hover {
1.911     bisitz   7894:   background-position: bottom center;
1.757     schulted 7895: }
                   7896: 
1.795     www      7897: ul#LC_toolbar {
1.911     bisitz   7898:   padding: 0;
                   7899:   margin: 2px;
                   7900:   list-style:none;
                   7901:   position:relative;
                   7902:   background-color:white;
1.1075.2.9  raeburn  7903:   overflow: auto;
1.757     schulted 7904: }
                   7905: 
1.795     www      7906: ul#LC_toolbar li {
1.911     bisitz   7907:   border:1px solid white;
                   7908:   padding: 0;
                   7909:   margin: 0;
                   7910:   float: left;
                   7911:   display:inline;
                   7912:   vertical-align:middle;
1.1075.2.9  raeburn  7913:   white-space: nowrap;
1.911     bisitz   7914: }
1.757     schulted 7915: 
1.783     amueller 7916: 
1.795     www      7917: a.LC_toolbarItem {
1.911     bisitz   7918:   display:block;
                   7919:   padding: 0;
                   7920:   margin: 0;
                   7921:   height: 32px;
                   7922:   width: 32px;
                   7923:   color:white;
                   7924:   border: none;
                   7925:   background-repeat:no-repeat;
                   7926:   background-color:transparent;
1.757     schulted 7927: }
                   7928: 
1.915     droeschl 7929: ul.LC_funclist {
                   7930:     margin: 0;
                   7931:     padding: 0.5em 1em 0.5em 0;
                   7932: }
                   7933: 
1.933     droeschl 7934: ul.LC_funclist > li:first-child {
                   7935:     font-weight:bold; 
                   7936:     margin-left:0.8em;
                   7937: }
                   7938: 
1.915     droeschl 7939: ul.LC_funclist + ul.LC_funclist {
                   7940:     /* 
                   7941:        left border as a seperator if we have more than
                   7942:        one list 
                   7943:     */
                   7944:     border-left: 1px solid $sidebg;
                   7945:     /* 
                   7946:        this hides the left border behind the border of the 
                   7947:        outer box if element is wrapped to the next 'line' 
                   7948:     */
                   7949:     margin-left: -1px;
                   7950: }
                   7951: 
1.843     bisitz   7952: ul.LC_funclist li {
1.915     droeschl 7953:   display: inline;
1.782     bisitz   7954:   white-space: nowrap;
1.915     droeschl 7955:   margin: 0 0 0 25px;
                   7956:   line-height: 150%;
1.782     bisitz   7957: }
                   7958: 
1.974     wenzelju 7959: .LC_hidden {
                   7960:   display: none;
                   7961: }
                   7962: 
1.1030    www      7963: .LCmodal-overlay {
                   7964: 		position:fixed;
                   7965: 		top:0;
                   7966: 		right:0;
                   7967: 		bottom:0;
                   7968: 		left:0;
                   7969: 		height:100%;
                   7970: 		width:100%;
                   7971: 		margin:0;
                   7972: 		padding:0;
                   7973: 		background:#999;
                   7974: 		opacity:.75;
                   7975: 		filter: alpha(opacity=75);
                   7976: 		-moz-opacity: 0.75;
                   7977: 		z-index:101;
                   7978: }
                   7979: 
                   7980: * html .LCmodal-overlay {   
                   7981: 		position: absolute;
                   7982: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7983: }
                   7984: 
                   7985: .LCmodal-window {
                   7986: 		position:fixed;
                   7987: 		top:50%;
                   7988: 		left:50%;
                   7989: 		margin:0;
                   7990: 		padding:0;
                   7991: 		z-index:102;
                   7992: 	}
                   7993: 
                   7994: * html .LCmodal-window {
                   7995: 		position:absolute;
                   7996: }
                   7997: 
                   7998: .LCclose-window {
                   7999: 		position:absolute;
                   8000: 		width:32px;
                   8001: 		height:32px;
                   8002: 		right:8px;
                   8003: 		top:8px;
                   8004: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   8005: 		text-indent:-99999px;
                   8006: 		overflow:hidden;
                   8007: 		cursor:pointer;
                   8008: }
                   8009: 
1.1075.2.158  raeburn  8010: .LCisDisabled {
                   8011:   cursor: not-allowed;
                   8012:   opacity: 0.5;
                   8013: }
                   8014: 
                   8015: a[aria-disabled="true"] {
                   8016:   color: currentColor;
                   8017:   display: inline-block;  /* For IE11/ MS Edge bug */
                   8018:   pointer-events: none;
                   8019:   text-decoration: none;
                   8020: }
                   8021: 
1.1075.2.141  raeburn  8022: pre.LC_wordwrap {
                   8023:   white-space: pre-wrap;
                   8024:   white-space: -moz-pre-wrap;
                   8025:   white-space: -pre-wrap;
                   8026:   white-space: -o-pre-wrap;
                   8027:   word-wrap: break-word;
                   8028: }
                   8029: 
1.1075.2.17  raeburn  8030: /*
                   8031:   styles used by TTH when "Default set of options to pass to tth/m
                   8032:   when converting TeX" in course settings has been set
                   8033: 
                   8034:   option passed: -t
                   8035: 
                   8036: */
                   8037: 
                   8038: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   8039: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   8040: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   8041: td div.norm {line-height:normal;}
                   8042: 
                   8043: /*
                   8044:   option passed -y3
                   8045: */
                   8046: 
                   8047: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   8048: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   8049: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   8050: 
1.1075.2.121  raeburn  8051: #LC_minitab_header {
                   8052:   float:left;
                   8053:   width:100%;
                   8054:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   8055:   font-size:93%;
                   8056:   line-height:normal;
                   8057:   margin: 0.5em 0 0.5em 0;
                   8058: }
                   8059: #LC_minitab_header ul {
                   8060:   margin:0;
                   8061:   padding:10px 10px 0;
                   8062:   list-style:none;
                   8063: }
                   8064: #LC_minitab_header li {
                   8065:   float:left;
                   8066:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   8067:   margin:0;
                   8068:   padding:0 0 0 9px;
                   8069: }
                   8070: #LC_minitab_header a {
                   8071:   display:block;
                   8072:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   8073:   padding:5px 15px 4px 6px;
                   8074: }
                   8075: #LC_minitab_header #LC_current_minitab {
                   8076:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   8077: }
                   8078: #LC_minitab_header #LC_current_minitab a {
                   8079:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   8080:   padding-bottom:5px;
                   8081: }
                   8082: 
                   8083: 
1.343     albertel 8084: END
                   8085: }
                   8086: 
1.306     albertel 8087: =pod
                   8088: 
                   8089: =item * &headtag()
                   8090: 
                   8091: Returns a uniform footer for LON-CAPA web pages.
                   8092: 
1.307     albertel 8093: Inputs: $title - optional title for the head
                   8094:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 8095:         $args - optional arguments
1.319     albertel 8096:             force_register - if is true call registerurl so the remote is 
                   8097:                              informed
1.415     albertel 8098:             redirect       -> array ref of
                   8099:                                    1- seconds before redirect occurs
                   8100:                                    2- url to redirect to
                   8101:                                    3- whether the side effect should occur
1.315     albertel 8102:                            (side effect of setting 
                   8103:                                $env{'internal.head.redirect'} to the url 
                   8104:                                redirected too)
1.1075.2.166  raeburn  8105:                                    4- whether encrypt check should be skipped
1.352     albertel 8106:             domain         -> force to color decorate a page for a specific
                   8107:                                domain
                   8108:             function       -> force usage of a specific rolish color scheme
                   8109:             bgcolor        -> override the default page bgcolor
1.460     albertel 8110:             no_auto_mt_title
                   8111:                            -> prevent &mt()ing the title arg
1.464     albertel 8112: 
1.306     albertel 8113: =cut
                   8114: 
                   8115: sub headtag {
1.313     albertel 8116:     my ($title,$head_extra,$args) = @_;
1.306     albertel 8117:     
1.363     albertel 8118:     my $function = $args->{'function'} || &get_users_function();
                   8119:     my $domain   = $args->{'domain'}   || &determinedomain();
                   8120:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1075.2.52  raeburn  8121:     my $httphost = $args->{'use_absolute'};
1.418     albertel 8122:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 8123: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 8124: 		   #time(),
1.418     albertel 8125: 		   $env{'environment.color.timestamp'},
1.363     albertel 8126: 		   $function,$domain,$bgcolor);
                   8127: 
1.369     www      8128:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 8129: 
1.308     albertel 8130:     my $result =
                   8131: 	'<head>'.
1.1075.2.56  raeburn  8132: 	&font_settings($args);
1.319     albertel 8133: 
1.1075.2.72  raeburn  8134:     my $inhibitprint;
                   8135:     if ($args->{'print_suppress'}) {
                   8136:         $inhibitprint = &print_suppression();
                   8137:     }
1.1064    raeburn  8138: 
1.1075.2.172! raeburn  8139:     if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461     albertel 8140: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   8141:     }
1.1075.2.12  raeburn  8142:     if ($args->{'force_register'}) {
                   8143:         $result .= &Apache::lonmenu::registerurl(1);
1.319     albertel 8144:     }
1.436     albertel 8145:     if (!$args->{'no_nav_bar'} 
                   8146: 	&& !$args->{'only_body'}
1.1075.2.172! raeburn  8147: 	&& !$args->{'frameset'}
        !          8148: 	&& !$args->{'switchserver'}) {
1.1075.2.52  raeburn  8149: 	$result .= &help_menu_js($httphost);
1.1032    www      8150:         $result.=&modal_window();
1.1038    www      8151:         $result.=&togglebox_script();
1.1034    www      8152:         $result.=&wishlist_window();
1.1041    www      8153:         $result.=&LCprogressbarUpdate_script();
1.1034    www      8154:     } else {
                   8155:         if ($args->{'add_modal'}) {
                   8156:            $result.=&modal_window();
                   8157:         }
                   8158:         if ($args->{'add_wishlist'}) {
                   8159:            $result.=&wishlist_window();
                   8160:         }
1.1038    www      8161:         if ($args->{'add_togglebox'}) {
                   8162:            $result.=&togglebox_script();
                   8163:         }
1.1041    www      8164:         if ($args->{'add_progressbar'}) {
                   8165:            $result.=&LCprogressbarUpdate_script();
                   8166:         }
1.436     albertel 8167:     }
1.314     albertel 8168:     if (ref($args->{'redirect'})) {
1.1075.2.166  raeburn  8169: 	my ($time,$url,$inhibit_continue,$skip_enc_check) = @{$args->{'redirect'}};
                   8170:         if (!$skip_enc_check) {
                   8171:             $url = &Apache::lonenc::check_encrypt($url);
                   8172:         }
1.414     albertel 8173: 	if (!$inhibit_continue) {
                   8174: 	    $env{'internal.head.redirect'} = $url;
                   8175: 	}
1.313     albertel 8176: 	$result.=<<ADDMETA
                   8177: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 8178: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 8179: ADDMETA
1.1075.2.89  raeburn  8180:     } else {
                   8181:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   8182:             my $requrl = $env{'request.uri'};
                   8183:             if ($requrl eq '') {
                   8184:                 $requrl = $ENV{'REQUEST_URI'};
                   8185:                 $requrl =~ s/\?.+$//;
                   8186:             }
                   8187:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   8188:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   8189:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   8190:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   8191:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   8192:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1075.2.145  raeburn  8193:                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1075.2.151  raeburn  8194:                     my ($offload,$offloadoth);
1.1075.2.89  raeburn  8195:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   8196:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1075.2.145  raeburn  8197:                             $offload = 1;
1.1075.2.151  raeburn  8198:                             if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8199:                                 (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8200:                                 unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8201:                                     $offloadoth = 1;
                   8202:                                     $dom_in_use = $env{'user.domain'};
                   8203:                                 }
                   8204:                             }
1.1075.2.145  raeburn  8205:                         }
                   8206:                     }
                   8207:                     unless ($offload) {
                   8208:                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   8209:                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   8210:                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8211:                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8212:                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8213:                                         $offload = 1;
1.1075.2.151  raeburn  8214:                                         $offloadoth = 1;
1.1075.2.145  raeburn  8215:                                         $dom_in_use = $env{'user.domain'};
                   8216:                                     }
1.1075.2.89  raeburn  8217:                                 }
1.1075.2.145  raeburn  8218:                             }
                   8219:                         }
                   8220:                     }
                   8221:                     if ($offload) {
1.1075.2.158  raeburn  8222:                         my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1075.2.151  raeburn  8223:                         if (($newserver eq '') && ($offloadoth)) {
                   8224:                             my @domains = &Apache::lonnet::current_machine_domains();
                   8225:                             if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) { 
                   8226:                                 ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
                   8227:                             }
                   8228:                         }
1.1075.2.145  raeburn  8229:                         if (($newserver) && ($newserver ne $lonhost)) {
                   8230:                             my $numsec = 5;
                   8231:                             my $timeout = $numsec * 1000;
                   8232:                             my ($newurl,$locknum,%locks,$msg);
                   8233:                             if ($env{'request.role.adv'}) {
                   8234:                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   8235:                             }
                   8236:                             my $disable_submit = 0;
                   8237:                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   8238:                                 $disable_submit = 1;
                   8239:                             }
                   8240:                             if ($locknum) {
                   8241:                                 my @lockinfo = sort(values(%locks));
1.1075.2.153  raeburn  8242:                                 $msg = &mt('Once the following tasks are complete:')." \n".
1.1075.2.145  raeburn  8243:                                        join(", ",sort(values(%locks)))."\n";
                   8244:                                 if (&show_course()) {
                   8245:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
1.1075.2.89  raeburn  8246:                                 } else {
1.1075.2.145  raeburn  8247:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
                   8248:                                 }
                   8249:                             } else {
                   8250:                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   8251:                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   8252:                                 }
                   8253:                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   8254:                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   8255:                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   8256:                                     $newurl .= '&role='.$env{'request.role'};
                   8257:                                 }
                   8258:                                 if ($env{'request.symb'}) {
                   8259:                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   8260:                                     if ($shownsymb =~ m{^/enc/}) {
                   8261:                                         my $reqdmajor = 2;
                   8262:                                         my $reqdminor = 11;
                   8263:                                         my $reqdsubminor = 3;
                   8264:                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   8265:                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   8266:                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   8267:                                         if (($major eq '' && $minor eq '') ||
                   8268:                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   8269:                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   8270:                                              ($reqdsubminor > $subminor))))) {
                   8271:                                             undef($shownsymb);
                   8272:                                         }
1.1075.2.89  raeburn  8273:                                     }
1.1075.2.145  raeburn  8274:                                     if ($shownsymb) {
                   8275:                                         &js_escape(\$shownsymb);
                   8276:                                         $newurl .= '&symb='.$shownsymb;
1.1075.2.89  raeburn  8277:                                     }
1.1075.2.145  raeburn  8278:                                 } else {
                   8279:                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   8280:                                     &js_escape(\$shownurl);
                   8281:                                     $newurl .= '&origurl='.$shownurl;
1.1075.2.89  raeburn  8282:                                 }
1.1075.2.145  raeburn  8283:                             }
                   8284:                             &js_escape(\$msg);
                   8285:                             $result.=<<OFFLOAD
1.1075.2.89  raeburn  8286: <meta http-equiv="pragma" content="no-cache" />
                   8287: <script type="text/javascript">
1.1075.2.92  raeburn  8288: // <![CDATA[
1.1075.2.89  raeburn  8289: function LC_Offload_Now() {
                   8290:     var dest = "$newurl";
                   8291:     if (dest != '') {
                   8292:         window.location.href="$newurl";
                   8293:     }
                   8294: }
1.1075.2.92  raeburn  8295: \$(document).ready(function () {
                   8296:     window.alert('$msg');
                   8297:     if ($disable_submit) {
1.1075.2.89  raeburn  8298:         \$(".LC_hwk_submit").prop("disabled", true);
                   8299:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92  raeburn  8300:     }
                   8301:     setTimeout('LC_Offload_Now()', $timeout);
                   8302: });
                   8303: // ]]>
1.1075.2.89  raeburn  8304: </script>
                   8305: OFFLOAD
                   8306:                         }
                   8307:                     }
                   8308:                 }
                   8309:             }
                   8310:         }
1.313     albertel 8311:     }
1.306     albertel 8312:     if (!defined($title)) {
                   8313: 	$title = 'The LearningOnline Network with CAPA';
                   8314:     }
1.460     albertel 8315:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.168  raeburn  8316:     if ($title =~ /^LON-CAPA\s+/) {
                   8317:         $result .= '<title> '.$title.'</title>';
                   8318:     } else {
                   8319:         $result .= '<title> LON-CAPA '.$title.'</title>';
                   8320:     }
                   8321:     $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1075.2.61  raeburn  8322:     if (!$args->{'frameset'}) {
                   8323:         $result .= ' /';
                   8324:     }
                   8325:     $result .= '>'
1.1064    raeburn  8326:         .$inhibitprint
1.414     albertel 8327: 	.$head_extra;
1.1075.2.108  raeburn  8328:     my $clientmobile;
                   8329:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   8330:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   8331:     } else {
                   8332:         $clientmobile = $env{'browser.mobile'};
                   8333:     }
                   8334:     if ($clientmobile) {
1.1075.2.42  raeburn  8335:         $result .= '
                   8336: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   8337: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   8338:     }
1.1075.2.126  raeburn  8339:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 8340:     return $result.'</head>';
1.306     albertel 8341: }
                   8342: 
                   8343: =pod
                   8344: 
1.340     albertel 8345: =item * &font_settings()
                   8346: 
                   8347: Returns neccessary <meta> to set the proper encoding
                   8348: 
1.1075.2.56  raeburn  8349: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 8350: 
                   8351: =cut
                   8352: 
                   8353: sub font_settings {
1.1075.2.56  raeburn  8354:     my ($args) = @_;
1.340     albertel 8355:     my $headerstring='';
1.1075.2.56  raeburn  8356:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   8357:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340     albertel 8358: 	$headerstring.=
1.1075.2.61  raeburn  8359: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   8360:         if (!$args->{'frameset'}) {
                   8361:             $headerstring.= ' /';
                   8362:         }
                   8363:         $headerstring .= '>'."\n";
1.340     albertel 8364:     }
                   8365:     return $headerstring;
                   8366: }
                   8367: 
1.341     albertel 8368: =pod
                   8369: 
1.1064    raeburn  8370: =item * &print_suppression()
                   8371: 
                   8372: In course context returns css which causes the body to be blank when media="print",
                   8373: if printout generation is unavailable for the current resource.
                   8374: 
                   8375: This could be because:
                   8376: 
                   8377: (a) printstartdate is in the future
                   8378: 
                   8379: (b) printenddate is in the past
                   8380: 
                   8381: (c) there is an active exam block with "printout"
                   8382: functionality blocked
                   8383: 
                   8384: Users with pav, pfo or evb privileges are exempt.
                   8385: 
                   8386: Inputs: none
                   8387: 
                   8388: =cut
                   8389: 
                   8390: 
                   8391: sub print_suppression {
                   8392:     my $noprint;
                   8393:     if ($env{'request.course.id'}) {
                   8394:         my $scope = $env{'request.course.id'};
                   8395:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8396:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   8397:             return;
                   8398:         }
                   8399:         if ($env{'request.course.sec'} ne '') {
                   8400:             $scope .= "/$env{'request.course.sec'}";
                   8401:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8402:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  8403:                 return;
1.1064    raeburn  8404:             }
                   8405:         }
                   8406:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8407:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.158  raeburn  8408:         my $clientip = &Apache::lonnet::get_requestor_ip();
                   8409:         my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064    raeburn  8410:         if ($blocked) {
                   8411:             my $checkrole = "cm./$cdom/$cnum";
                   8412:             if ($env{'request.course.sec'} ne '') {
                   8413:                 $checkrole .= "/$env{'request.course.sec'}";
                   8414:             }
                   8415:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   8416:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   8417:                 $noprint = 1;
                   8418:             }
                   8419:         }
                   8420:         unless ($noprint) {
                   8421:             my $symb = &Apache::lonnet::symbread();
                   8422:             if ($symb ne '') {
                   8423:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   8424:                 if (ref($navmap)) {
                   8425:                     my $res = $navmap->getBySymb($symb);
                   8426:                     if (ref($res)) {
                   8427:                         if (!$res->resprintable()) {
                   8428:                             $noprint = 1;
                   8429:                         }
                   8430:                     }
                   8431:                 }
                   8432:             }
                   8433:         }
                   8434:         if ($noprint) {
                   8435:             return <<"ENDSTYLE";
                   8436: <style type="text/css" media="print">
                   8437:     body { display:none }
                   8438: </style>
                   8439: ENDSTYLE
                   8440:         }
                   8441:     }
                   8442:     return;
                   8443: }
                   8444: 
                   8445: =pod
                   8446: 
1.341     albertel 8447: =item * &xml_begin()
                   8448: 
                   8449: Returns the needed doctype and <html>
                   8450: 
                   8451: Inputs: none
                   8452: 
                   8453: =cut
                   8454: 
                   8455: sub xml_begin {
1.1075.2.61  raeburn  8456:     my ($is_frameset) = @_;
1.341     albertel 8457:     my $output='';
                   8458: 
                   8459:     if ($env{'browser.mathml'}) {
                   8460: 	$output='<?xml version="1.0"?>'
                   8461:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   8462: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   8463:             
                   8464: #	    .'<!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">] >'
                   8465: 	    .'<!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">'
                   8466:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   8467: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61  raeburn  8468:     } elsif ($is_frameset) {
                   8469:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   8470:                 '<html>'."\n";
1.341     albertel 8471:     } else {
1.1075.2.61  raeburn  8472: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   8473:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 8474:     }
                   8475:     return $output;
                   8476: }
1.340     albertel 8477: 
                   8478: =pod
                   8479: 
1.306     albertel 8480: =item * &start_page()
                   8481: 
                   8482: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   8483: 
1.648     raeburn  8484: Inputs:
                   8485: 
                   8486: =over 4
                   8487: 
                   8488: $title - optional title for the page
                   8489: 
                   8490: $head_extra - optional extra HTML to incude inside the <head>
                   8491: 
                   8492: $args - additional optional args supported are:
                   8493: 
                   8494: =over 8
                   8495: 
                   8496:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 8497:                                     arg on
1.814     bisitz   8498:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  8499:              add_entries    -> additional attributes to add to the  <body>
                   8500:              domain         -> force to color decorate a page for a 
1.317     albertel 8501:                                     specific domain
1.648     raeburn  8502:              function       -> force usage of a specific rolish color
1.317     albertel 8503:                                     scheme
1.648     raeburn  8504:              redirect       -> see &headtag()
                   8505:              bgcolor        -> override the default page bg color
                   8506:              js_ready       -> return a string ready for being used in 
1.317     albertel 8507:                                     a javascript writeln
1.648     raeburn  8508:              html_encode    -> return a string ready for being used in 
1.320     albertel 8509:                                     a html attribute
1.648     raeburn  8510:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 8511:                                     $forcereg arg
1.648     raeburn  8512:              frameset       -> if true will start with a <frameset>
1.330     albertel 8513:                                     rather than <body>
1.648     raeburn  8514:              skip_phases    -> hash ref of 
1.338     albertel 8515:                                     head -> skip the <html><head> generation
                   8516:                                     body -> skip all <body> generation
1.1075.2.12  raeburn  8517:              no_inline_link -> if true and in remote mode, don't show the
                   8518:                                     'Switch To Inline Menu' link
1.648     raeburn  8519:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 8520:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  8521:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1075.2.123  raeburn  8522:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   8523:                                     to lonhtmlcommon::breadcrumbs
1.1075.2.15  raeburn  8524:              group          -> includes the current group, if page is for a
                   8525:                                specific group
1.1075.2.133  raeburn  8526:              use_absolute   -> for request for external resource or syllabus, this
                   8527:                                will contain https://<hostname> if server uses
                   8528:                                https (as per hosts.tab), but request is for http
                   8529:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.1075.2.158  raeburn  8530:              links_disabled -> Links in primary and secondary menus are disabled
                   8531:                                (Can enable them once page has loaded - see lonroles.pm
                   8532:                                for an example).
1.361     albertel 8533: 
1.648     raeburn  8534: =back
1.460     albertel 8535: 
1.648     raeburn  8536: =back
1.562     albertel 8537: 
1.306     albertel 8538: =cut
                   8539: 
                   8540: sub start_page {
1.309     albertel 8541:     my ($title,$head_extra,$args) = @_;
1.318     albertel 8542:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 8543: 
1.315     albertel 8544:     $env{'internal.start_page'}++;
1.1075.2.15  raeburn  8545:     my ($result,@advtools);
1.964     droeschl 8546: 
1.338     albertel 8547:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62  raeburn  8548:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 8549:     }
                   8550:     
                   8551:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   8552: 	if ($args->{'frameset'}) {
                   8553: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   8554: 						$args->{'add_entries'});
                   8555: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8556:         } else {
                   8557:             $result .=
                   8558:                 &bodytag($title, 
                   8559:                          $args->{'function'},       $args->{'add_entries'},
                   8560:                          $args->{'only_body'},      $args->{'domain'},
                   8561:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12  raeburn  8562:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
1.1075.2.15  raeburn  8563:                          $args,                     \@advtools);
1.831     bisitz   8564:         }
1.330     albertel 8565:     }
1.338     albertel 8566: 
1.315     albertel 8567:     if ($args->{'js_ready'}) {
1.713     kaisler  8568: 		$result = &js_ready($result);
1.315     albertel 8569:     }
1.320     albertel 8570:     if ($args->{'html_encode'}) {
1.713     kaisler  8571: 		$result = &html_encode($result);
                   8572:     }
                   8573: 
1.813     bisitz   8574:     # Preparation for new and consistent functionlist at top of screen
                   8575:     # if ($args->{'functionlist'}) {
                   8576:     #            $result .= &build_functionlist();
                   8577:     #}
                   8578: 
1.964     droeschl 8579:     # Don't add anything more if only_body wanted or in const space
                   8580:     return $result if    $args->{'only_body'} 
                   8581:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8582: 
                   8583:     #Breadcrumbs
1.758     kaisler  8584:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   8585: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8586: 		#if any br links exists, add them to the breadcrumbs
                   8587: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8588: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8589: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8590: 			}
                   8591: 		}
1.1075.2.19  raeburn  8592:                 # if @advtools array contains items add then to the breadcrumbs
                   8593:                 if (@advtools > 0) {
                   8594:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8595:                 }
1.1075.2.123  raeburn  8596:                 my $menulink;
                   8597:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   8598:                 if (exists($args->{'bread_crumbs_nomenu'})) {
                   8599:                     $menulink = 0;
                   8600:                 } else {
                   8601:                     undef($menulink);
                   8602:                 }
1.758     kaisler  8603: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8604: 		if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123  raeburn  8605: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.758     kaisler  8606: 		}else{
1.1075.2.123  raeburn  8607: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  8608: 		}
1.1075.2.24  raeburn  8609:     } elsif (($env{'environment.remote'} eq 'on') &&
                   8610:              ($env{'form.inhibitmenu'} ne 'yes') &&
                   8611:              ($env{'request.noversionuri'} =~ m{^/res/}) &&
                   8612:              ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21  raeburn  8613:         $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320     albertel 8614:     }
1.315     albertel 8615:     return $result;
1.306     albertel 8616: }
                   8617: 
                   8618: sub end_page {
1.315     albertel 8619:     my ($args) = @_;
                   8620:     $env{'internal.end_page'}++;
1.330     albertel 8621:     my $result;
1.335     albertel 8622:     if ($args->{'discussion'}) {
                   8623: 	my ($target,$parser);
                   8624: 	if (ref($args->{'discussion'})) {
                   8625: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8626: 				$args->{'discussion'}{'parser'});
                   8627: 	}
                   8628: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8629:     }
1.330     albertel 8630:     if ($args->{'frameset'}) {
                   8631: 	$result .= '</frameset>';
                   8632:     } else {
1.635     raeburn  8633: 	$result .= &endbodytag($args);
1.330     albertel 8634:     }
1.1075.2.6  raeburn  8635:     unless ($args->{'notbody'}) {
                   8636:         $result .= "\n</html>";
                   8637:     }
1.330     albertel 8638: 
1.315     albertel 8639:     if ($args->{'js_ready'}) {
1.317     albertel 8640: 	$result = &js_ready($result);
1.315     albertel 8641:     }
1.335     albertel 8642: 
1.320     albertel 8643:     if ($args->{'html_encode'}) {
                   8644: 	$result = &html_encode($result);
                   8645:     }
1.335     albertel 8646: 
1.315     albertel 8647:     return $result;
                   8648: }
                   8649: 
1.1034    www      8650: sub wishlist_window {
                   8651:     return(<<'ENDWISHLIST');
1.1046    raeburn  8652: <script type="text/javascript">
1.1034    www      8653: // <![CDATA[
                   8654: // <!-- BEGIN LON-CAPA Internal
                   8655: function set_wishlistlink(title, path) {
                   8656:     if (!title) {
                   8657:         title = document.title;
                   8658:         title = title.replace(/^LON-CAPA /,'');
                   8659:     }
1.1075.2.65  raeburn  8660:     title = encodeURIComponent(title);
1.1075.2.83  raeburn  8661:     title = title.replace("'","\\\'");
1.1034    www      8662:     if (!path) {
                   8663:         path = location.pathname;
                   8664:     }
1.1075.2.65  raeburn  8665:     path = encodeURIComponent(path);
1.1075.2.83  raeburn  8666:     path = path.replace("'","\\\'");
1.1034    www      8667:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   8668:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   8669: }
                   8670: // END LON-CAPA Internal -->
                   8671: // ]]>
                   8672: </script>
                   8673: ENDWISHLIST
                   8674: }
                   8675: 
1.1030    www      8676: sub modal_window {
                   8677:     return(<<'ENDMODAL');
1.1046    raeburn  8678: <script type="text/javascript">
1.1030    www      8679: // <![CDATA[
                   8680: // <!-- BEGIN LON-CAPA Internal
                   8681: var modalWindow = {
                   8682: 	parent:"body",
                   8683: 	windowId:null,
                   8684: 	content:null,
                   8685: 	width:null,
                   8686: 	height:null,
                   8687: 	close:function()
                   8688: 	{
                   8689: 	        $(".LCmodal-window").remove();
                   8690: 	        $(".LCmodal-overlay").remove();
                   8691: 	},
                   8692: 	open:function()
                   8693: 	{
                   8694: 		var modal = "";
                   8695: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   8696: 		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;\">";
                   8697: 		modal += this.content;
                   8698: 		modal += "</div>";	
                   8699: 
                   8700: 		$(this.parent).append(modal);
                   8701: 
                   8702: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   8703: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   8704: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   8705: 	}
                   8706: };
1.1075.2.42  raeburn  8707: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      8708: 	{
1.1075.2.119  raeburn  8709:                 source = source.replace(/'/g,"&#39;");
1.1030    www      8710: 		modalWindow.windowId = "myModal";
                   8711: 		modalWindow.width = width;
                   8712: 		modalWindow.height = height;
1.1075.2.80  raeburn  8713: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      8714: 		modalWindow.open();
1.1075.2.87  raeburn  8715: 	};
1.1030    www      8716: // END LON-CAPA Internal -->
                   8717: // ]]>
                   8718: </script>
                   8719: ENDMODAL
                   8720: }
                   8721: 
                   8722: sub modal_link {
1.1075.2.42  raeburn  8723:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      8724:     unless ($width) { $width=480; }
                   8725:     unless ($height) { $height=400; }
1.1031    www      8726:     unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42  raeburn  8727:     unless ($transparency) { $transparency='true'; }
                   8728: 
1.1074    raeburn  8729:     my $target_attr;
                   8730:     if (defined($target)) {
                   8731:         $target_attr = 'target="'.$target.'"';
                   8732:     }
                   8733:     return <<"ENDLINK";
1.1075.2.143  raeburn  8734: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  8735: ENDLINK
1.1030    www      8736: }
                   8737: 
1.1032    www      8738: sub modal_adhoc_script {
1.1075.2.155  raeburn  8739:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
                   8740:     my $mathjax;
                   8741:     if ($possmathjax) {
                   8742:         $mathjax = <<'ENDJAX';
                   8743:                if (typeof MathJax == 'object') {
                   8744:                    MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
                   8745:                }
                   8746: ENDJAX
                   8747:     }
1.1032    www      8748:     return (<<ENDADHOC);
1.1046    raeburn  8749: <script type="text/javascript">
1.1032    www      8750: // <![CDATA[
                   8751:         var $funcname = function()
                   8752:         {
                   8753:                 modalWindow.windowId = "myModal";
                   8754:                 modalWindow.width = $width;
                   8755:                 modalWindow.height = $height;
                   8756:                 modalWindow.content = '$content';
                   8757:                 modalWindow.open();
1.1075.2.155  raeburn  8758:                 $mathjax
1.1032    www      8759:         };  
                   8760: // ]]>
                   8761: </script>
                   8762: ENDADHOC
                   8763: }
                   8764: 
1.1041    www      8765: sub modal_adhoc_inner {
1.1075.2.155  raeburn  8766:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041    www      8767:     my $innerwidth=$width-20;
                   8768:     $content=&js_ready(
1.1042    www      8769:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  8770:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8771:                  $content.
1.1041    www      8772:                  &end_scrollbox().
1.1075.2.42  raeburn  8773:                  &end_page()
1.1041    www      8774:              );
1.1075.2.155  raeburn  8775:     return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041    www      8776: }
                   8777: 
                   8778: sub modal_adhoc_window {
1.1075.2.155  raeburn  8779:     my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
                   8780:     return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041    www      8781:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8782: }
                   8783: 
                   8784: sub modal_adhoc_launch {
                   8785:     my ($funcname,$width,$height,$content)=@_;
                   8786:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8787: <script type="text/javascript">
                   8788: // <![CDATA[
                   8789: $funcname();
                   8790: // ]]>
                   8791: </script>
                   8792: ENDLAUNCH
                   8793: }
                   8794: 
                   8795: sub modal_adhoc_close {
                   8796:     return (<<ENDCLOSE);
                   8797: <script type="text/javascript">
                   8798: // <![CDATA[
                   8799: modalWindow.close();
                   8800: // ]]>
                   8801: </script>
                   8802: ENDCLOSE
                   8803: }
                   8804: 
1.1038    www      8805: sub togglebox_script {
                   8806:    return(<<ENDTOGGLE);
                   8807: <script type="text/javascript"> 
                   8808: // <![CDATA[
                   8809: function LCtoggleDisplay(id,hidetext,showtext) {
                   8810:    link = document.getElementById(id + "link").childNodes[0];
                   8811:    with (document.getElementById(id).style) {
                   8812:       if (display == "none" ) {
                   8813:           display = "inline";
                   8814:           link.nodeValue = hidetext;
                   8815:         } else {
                   8816:           display = "none";
                   8817:           link.nodeValue = showtext;
                   8818:        }
                   8819:    }
                   8820: }
                   8821: // ]]>
                   8822: </script>
                   8823: ENDTOGGLE
                   8824: }
                   8825: 
1.1039    www      8826: sub start_togglebox {
                   8827:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   8828:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   8829:     unless ($showtext) { $showtext=&mt('show'); }
                   8830:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   8831:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   8832:     return &start_data_table().
                   8833:            &start_data_table_header_row().
                   8834:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   8835:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   8836:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   8837:            &end_data_table_header_row().
                   8838:            '<tr id="'.$id.'" style="display:none""><td>';
                   8839: }
                   8840: 
                   8841: sub end_togglebox {
                   8842:     return '</td></tr>'.&end_data_table();
                   8843: }
                   8844: 
1.1041    www      8845: sub LCprogressbar_script {
1.1075.2.130  raeburn  8846:    my ($id,$number_to_do)=@_;
                   8847:    if ($number_to_do) {
                   8848:        return(<<ENDPROGRESS);
1.1041    www      8849: <script type="text/javascript">
                   8850: // <![CDATA[
1.1045    www      8851: \$('#progressbar$id').progressbar({
1.1041    www      8852:   value: 0,
                   8853:   change: function(event, ui) {
                   8854:     var newVal = \$(this).progressbar('option', 'value');
                   8855:     \$('.pblabel', this).text(LCprogressTxt);
                   8856:   }
                   8857: });
                   8858: // ]]>
                   8859: </script>
                   8860: ENDPROGRESS
1.1075.2.130  raeburn  8861:    } else {
                   8862:        return(<<ENDPROGRESS);
                   8863: <script type="text/javascript">
                   8864: // <![CDATA[
                   8865: \$('#progressbar$id').progressbar({
                   8866:   value: false,
                   8867:   create: function(event, ui) {
                   8868:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   8869:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   8870:   }
                   8871: });
                   8872: // ]]>
                   8873: </script>
                   8874: ENDPROGRESS
                   8875:    }
1.1041    www      8876: }
                   8877: 
                   8878: sub LCprogressbarUpdate_script {
                   8879:    return(<<ENDPROGRESSUPDATE);
                   8880: <style type="text/css">
                   8881: .ui-progressbar { position:relative; }
1.1075.2.130  raeburn  8882: .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      8883: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   8884: </style>
                   8885: <script type="text/javascript">
                   8886: // <![CDATA[
1.1045    www      8887: var LCprogressTxt='---';
                   8888: 
1.1075.2.130  raeburn  8889: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      8890:    LCprogressTxt=progresstext;
1.1075.2.130  raeburn  8891:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   8892:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   8893:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
                   8894:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   8895:    } else {
                   8896:        \$('#progressbar'+id).progressbar('value',percent);
                   8897:    }
1.1041    www      8898: }
                   8899: // ]]>
                   8900: </script>
                   8901: ENDPROGRESSUPDATE
                   8902: }
                   8903: 
1.1042    www      8904: my $LClastpercent;
1.1045    www      8905: my $LCidcnt;
                   8906: my $LCcurrentid;
1.1042    www      8907: 
1.1041    www      8908: sub LCprogressbar {
1.1075.2.130  raeburn  8909:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      8910:     $LClastpercent=0;
1.1045    www      8911:     $LCidcnt++;
                   8912:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130  raeburn  8913:     my ($starting,$content);
                   8914:     if ($number_to_do) {
                   8915:         $starting=&mt('Starting');
                   8916:         $content=(<<ENDPROGBAR);
                   8917: $preamble
1.1045    www      8918:   <div id="progressbar$LCcurrentid">
1.1041    www      8919:     <span class="pblabel">$starting</span>
                   8920:   </div>
                   8921: ENDPROGBAR
1.1075.2.130  raeburn  8922:     } else {
                   8923:         $starting=&mt('Loading...');
                   8924:         $LClastpercent='false';
                   8925:         $content=(<<ENDPROGBAR);
                   8926: $preamble
                   8927:   <div id="progressbar$LCcurrentid">
                   8928:       <div class="progress-label">$starting</div>
                   8929:   </div>
                   8930: ENDPROGBAR
                   8931:     }
                   8932:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      8933: }
                   8934: 
                   8935: sub LCprogressbarUpdate {
1.1075.2.130  raeburn  8936:     my ($r,$val,$text,$number_to_do)=@_;
                   8937:     if ($number_to_do) {
                   8938:         unless ($val) { 
                   8939:             if ($LClastpercent) {
                   8940:                 $val=$LClastpercent;
                   8941:             } else {
                   8942:                 $val=0;
                   8943:             }
                   8944:         }
                   8945:         if ($val<0) { $val=0; }
                   8946:         if ($val>100) { $val=0; }
                   8947:         $LClastpercent=$val;
                   8948:         unless ($text) { $text=$val.'%'; }
                   8949:     } else {
                   8950:         $val = 'false';
1.1042    www      8951:     }
1.1041    www      8952:     $text=&js_ready($text);
1.1044    www      8953:     &r_print($r,<<ENDUPDATE);
1.1041    www      8954: <script type="text/javascript">
                   8955: // <![CDATA[
1.1075.2.130  raeburn  8956: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      8957: // ]]>
                   8958: </script>
                   8959: ENDUPDATE
1.1035    www      8960: }
                   8961: 
1.1042    www      8962: sub LCprogressbarClose {
                   8963:     my ($r)=@_;
                   8964:     $LClastpercent=0;
1.1044    www      8965:     &r_print($r,<<ENDCLOSE);
1.1042    www      8966: <script type="text/javascript">
                   8967: // <![CDATA[
1.1045    www      8968: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      8969: // ]]>
                   8970: </script>
                   8971: ENDCLOSE
1.1044    www      8972: }
                   8973: 
                   8974: sub r_print {
                   8975:     my ($r,$to_print)=@_;
                   8976:     if ($r) {
                   8977:       $r->print($to_print);
                   8978:       $r->rflush();
                   8979:     } else {
                   8980:       print($to_print);
                   8981:     }
1.1042    www      8982: }
                   8983: 
1.320     albertel 8984: sub html_encode {
                   8985:     my ($result) = @_;
                   8986: 
1.322     albertel 8987:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 8988:     
                   8989:     return $result;
                   8990: }
1.1044    www      8991: 
1.317     albertel 8992: sub js_ready {
                   8993:     my ($result) = @_;
                   8994: 
1.323     albertel 8995:     $result =~ s/[\n\r]/ /xmsg;
                   8996:     $result =~ s/\\/\\\\/xmsg;
                   8997:     $result =~ s/'/\\'/xmsg;
1.372     albertel 8998:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 8999:     
                   9000:     return $result;
                   9001: }
                   9002: 
1.315     albertel 9003: sub validate_page {
                   9004:     if (  exists($env{'internal.start_page'})
1.316     albertel 9005: 	  &&     $env{'internal.start_page'} > 1) {
                   9006: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 9007: 				 $env{'internal.start_page'}.' '.
1.316     albertel 9008: 				 $ENV{'request.filename'});
1.315     albertel 9009:     }
                   9010:     if (  exists($env{'internal.end_page'})
1.316     albertel 9011: 	  &&     $env{'internal.end_page'} > 1) {
                   9012: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 9013: 				 $env{'internal.end_page'}.' '.
1.316     albertel 9014: 				 $env{'request.filename'});
1.315     albertel 9015:     }
                   9016:     if (     exists($env{'internal.start_page'})
                   9017: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 9018: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   9019: 				 $env{'request.filename'});
1.315     albertel 9020:     }
                   9021:     if (   ! exists($env{'internal.start_page'})
                   9022: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 9023: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   9024: 				 $env{'request.filename'});
1.315     albertel 9025:     }
1.306     albertel 9026: }
1.315     albertel 9027: 
1.996     www      9028: 
                   9029: sub start_scrollbox {
1.1075.2.56  raeburn  9030:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  9031:     unless ($outerwidth) { $outerwidth='520px'; }
                   9032:     unless ($width) { $width='500px'; }
                   9033:     unless ($height) { $height='200px'; }
1.1075    raeburn  9034:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  9035:     if ($id ne '') {
1.1075.2.42  raeburn  9036:         $table_id = ' id="table_'.$id.'"';
                   9037:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  9038:     }
1.1075    raeburn  9039:     if ($bgcolor ne '') {
                   9040:         $tdcol = "background-color: $bgcolor;";
                   9041:     }
1.1075.2.42  raeburn  9042:     my $nicescroll_js;
                   9043:     if ($env{'browser.mobile'}) {
                   9044:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   9045:     }
1.1075    raeburn  9046:     return <<"END";
1.1075.2.42  raeburn  9047: $nicescroll_js
                   9048: 
                   9049: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  9050: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  9051: END
1.996     www      9052: }
                   9053: 
                   9054: sub end_scrollbox {
1.1036    www      9055:     return '</div></td></tr></table>';
1.996     www      9056: }
                   9057: 
1.1075.2.42  raeburn  9058: sub nicescroll_javascript {
                   9059:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   9060:     my %options;
                   9061:     if (ref($cursor) eq 'HASH') {
                   9062:         %options = %{$cursor};
                   9063:     }
                   9064:     unless ($options{'railalign'} =~ /^left|right$/) {
                   9065:         $options{'railalign'} = 'left';
                   9066:     }
                   9067:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9068:         my $function  = &get_users_function();
                   9069:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   9070:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9071:             $options{'cursorcolor'} = '#00F';
                   9072:         }
                   9073:     }
                   9074:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   9075:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   9076:             $options{'cursoropacity'}='1.0';
                   9077:         }
                   9078:     } else {
                   9079:         $options{'cursoropacity'}='1.0';
                   9080:     }
                   9081:     if ($options{'cursorfixedheight'} eq 'none') {
                   9082:         delete($options{'cursorfixedheight'});
                   9083:     } else {
                   9084:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   9085:     }
                   9086:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   9087:         delete($options{'railoffset'});
                   9088:     }
                   9089:     my @niceoptions;
                   9090:     while (my($key,$value) = each(%options)) {
                   9091:         if ($value =~ /^\{.+\}$/) {
                   9092:             push(@niceoptions,$key.':'.$value);
                   9093:         } else {
                   9094:             push(@niceoptions,$key.':"'.$value.'"');
                   9095:         }
                   9096:     }
                   9097:     my $nicescroll_js = '
                   9098: $(document).ready(
                   9099:       function() {
                   9100:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   9101:       }
                   9102: );
                   9103: ';
                   9104:     if ($framecheck) {
                   9105:         $nicescroll_js .= '
                   9106: function expand_div(caller) {
                   9107:     if (top === self) {
                   9108:         document.getElementById("'.$id.'").style.width = "auto";
                   9109:         document.getElementById("'.$id.'").style.height = "auto";
                   9110:     } else {
                   9111:         try {
                   9112:             if (parent.frames) {
                   9113:                 if (parent.frames.length > 1) {
                   9114:                     var framesrc = parent.frames[1].location.href;
                   9115:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   9116:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   9117:                         document.getElementById("'.$id.'").style.width = "auto";
                   9118:                         document.getElementById("'.$id.'").style.height = "auto";
                   9119:                     }
                   9120:                 }
                   9121:             }
                   9122:         } catch (e) {
                   9123:             return;
                   9124:         }
                   9125:     }
                   9126:     return;
                   9127: }
                   9128: ';
                   9129:     }
                   9130:     if ($needjsready) {
                   9131:         $nicescroll_js = '
                   9132: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   9133:     } else {
                   9134:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   9135:     }
                   9136:     return $nicescroll_js;
                   9137: }
                   9138: 
1.318     albertel 9139: sub simple_error_page {
1.1075.2.49  raeburn  9140:     my ($r,$title,$msg,$args) = @_;
                   9141:     if (ref($args) eq 'HASH') {
                   9142:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   9143:     } else {
                   9144:         $msg = &mt($msg);
                   9145:     }
                   9146: 
1.318     albertel 9147:     my $page =
                   9148: 	&Apache::loncommon::start_page($title).
1.1075.2.49  raeburn  9149: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 9150: 	&Apache::loncommon::end_page();
                   9151:     if (ref($r)) {
                   9152: 	$r->print($page);
1.327     albertel 9153: 	return;
1.318     albertel 9154:     }
                   9155:     return $page;
                   9156: }
1.347     albertel 9157: 
                   9158: {
1.610     albertel 9159:     my @row_count;
1.961     onken    9160: 
                   9161:     sub start_data_table_count {
                   9162:         unshift(@row_count, 0);
                   9163:         return;
                   9164:     }
                   9165: 
                   9166:     sub end_data_table_count {
                   9167:         shift(@row_count);
                   9168:         return;
                   9169:     }
                   9170: 
1.347     albertel 9171:     sub start_data_table {
1.1018    raeburn  9172: 	my ($add_class,$id) = @_;
1.422     albertel 9173: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  9174:         my $table_id;
                   9175:         if (defined($id)) {
                   9176:             $table_id = ' id="'.$id.'"';
                   9177:         }
1.961     onken    9178: 	&start_data_table_count();
1.1018    raeburn  9179: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 9180:     }
                   9181: 
                   9182:     sub end_data_table {
1.961     onken    9183: 	&end_data_table_count();
1.389     albertel 9184: 	return '</table>'."\n";;
1.347     albertel 9185:     }
                   9186: 
                   9187:     sub start_data_table_row {
1.974     wenzelju 9188: 	my ($add_class, $id) = @_;
1.610     albertel 9189: 	$row_count[0]++;
                   9190: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   9191: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 9192:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9193:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 9194:     }
1.471     banghart 9195:     
                   9196:     sub continue_data_table_row {
1.974     wenzelju 9197: 	my ($add_class, $id) = @_;
1.610     albertel 9198: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 9199: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   9200:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9201:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 9202:     }
1.347     albertel 9203: 
                   9204:     sub end_data_table_row {
1.389     albertel 9205: 	return '</tr>'."\n";;
1.347     albertel 9206:     }
1.367     www      9207: 
1.421     albertel 9208:     sub start_data_table_empty_row {
1.707     bisitz   9209: #	$row_count[0]++;
1.421     albertel 9210: 	return  '<tr class="LC_empty_row" >'."\n";;
                   9211:     }
                   9212: 
                   9213:     sub end_data_table_empty_row {
                   9214: 	return '</tr>'."\n";;
                   9215:     }
                   9216: 
1.367     www      9217:     sub start_data_table_header_row {
1.389     albertel 9218: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      9219:     }
                   9220: 
                   9221:     sub end_data_table_header_row {
1.389     albertel 9222: 	return '</tr>'."\n";;
1.367     www      9223:     }
1.890     droeschl 9224: 
                   9225:     sub data_table_caption {
                   9226:         my $caption = shift;
                   9227:         return "<caption class=\"LC_caption\">$caption</caption>";
                   9228:     }
1.347     albertel 9229: }
                   9230: 
1.548     albertel 9231: =pod
                   9232: 
                   9233: =item * &inhibit_menu_check($arg)
                   9234: 
                   9235: Checks for a inhibitmenu state and generates output to preserve it
                   9236: 
                   9237: Inputs:         $arg - can be any of
                   9238:                      - undef - in which case the return value is a string 
                   9239:                                to add  into arguments list of a uri
                   9240:                      - 'input' - in which case the return value is a HTML
                   9241:                                  <form> <input> field of type hidden to
                   9242:                                  preserve the value
                   9243:                      - a url - in which case the return value is the url with
                   9244:                                the neccesary cgi args added to preserve the
                   9245:                                inhibitmenu state
                   9246:                      - a ref to a url - no return value, but the string is
                   9247:                                         updated to include the neccessary cgi
                   9248:                                         args to preserve the inhibitmenu state
                   9249: 
                   9250: =cut
                   9251: 
                   9252: sub inhibit_menu_check {
                   9253:     my ($arg) = @_;
                   9254:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   9255:     if ($arg eq 'input') {
                   9256: 	if ($env{'form.inhibitmenu'}) {
                   9257: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   9258: 	} else {
                   9259: 	    return
                   9260: 	}
                   9261:     }
                   9262:     if ($env{'form.inhibitmenu'}) {
                   9263: 	if (ref($arg)) {
                   9264: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9265: 	} elsif ($arg eq '') {
                   9266: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   9267: 	} else {
                   9268: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9269: 	}
                   9270:     }
                   9271:     if (!ref($arg)) {
                   9272: 	return $arg;
                   9273:     }
                   9274: }
                   9275: 
1.251     albertel 9276: ###############################################
1.182     matthew  9277: 
                   9278: =pod
                   9279: 
1.549     albertel 9280: =back
                   9281: 
                   9282: =head1 User Information Routines
                   9283: 
                   9284: =over 4
                   9285: 
1.405     albertel 9286: =item * &get_users_function()
1.182     matthew  9287: 
                   9288: Used by &bodytag to determine the current users primary role.
                   9289: Returns either 'student','coordinator','admin', or 'author'.
                   9290: 
                   9291: =cut
                   9292: 
                   9293: ###############################################
                   9294: sub get_users_function {
1.815     tempelho 9295:     my $function = 'norole';
1.818     tempelho 9296:     if ($env{'request.role'}=~/^(st)/) {
                   9297:         $function='student';
                   9298:     }
1.907     raeburn  9299:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  9300:         $function='coordinator';
                   9301:     }
1.258     albertel 9302:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  9303:         $function='admin';
                   9304:     }
1.826     bisitz   9305:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  9306:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  9307:         $function='author';
                   9308:     }
                   9309:     return $function;
1.54      www      9310: }
1.99      www      9311: 
                   9312: ###############################################
                   9313: 
1.233     raeburn  9314: =pod
                   9315: 
1.821     raeburn  9316: =item * &show_course()
                   9317: 
                   9318: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   9319: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   9320: 
                   9321: Inputs:
                   9322: None
                   9323: 
                   9324: Outputs:
                   9325: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   9326: 
                   9327: =cut
                   9328: 
                   9329: ###############################################
                   9330: sub show_course {
                   9331:     my $course = !$env{'user.adv'};
                   9332:     if (!$env{'user.adv'}) {
                   9333:         foreach my $env (keys(%env)) {
                   9334:             next if ($env !~ m/^user\.priv\./);
                   9335:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   9336:                 $course = 0;
                   9337:                 last;
                   9338:             }
                   9339:         }
                   9340:     }
                   9341:     return $course;
                   9342: }
                   9343: 
                   9344: ###############################################
                   9345: 
                   9346: =pod
                   9347: 
1.542     raeburn  9348: =item * &check_user_status()
1.274     raeburn  9349: 
                   9350: Determines current status of supplied role for a
                   9351: specific user. Roles can be active, previous or future.
                   9352: 
                   9353: Inputs: 
                   9354: user's domain, user's username, course's domain,
1.375     raeburn  9355: course's number, optional section ID.
1.274     raeburn  9356: 
                   9357: Outputs:
                   9358: role status: active, previous or future. 
                   9359: 
                   9360: =cut
                   9361: 
                   9362: sub check_user_status {
1.412     raeburn  9363:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  9364:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  9365:     my @uroles = keys(%userinfo);
1.274     raeburn  9366:     my $srchstr;
                   9367:     my $active_chk = 'none';
1.412     raeburn  9368:     my $now = time;
1.274     raeburn  9369:     if (@uroles > 0) {
1.908     raeburn  9370:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  9371:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   9372:         } else {
1.412     raeburn  9373:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   9374:         }
                   9375:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  9376:             my $role_end = 0;
                   9377:             my $role_start = 0;
                   9378:             $active_chk = 'active';
1.412     raeburn  9379:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   9380:                 $role_end = $1;
                   9381:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   9382:                     $role_start = $1;
1.274     raeburn  9383:                 }
                   9384:             }
                   9385:             if ($role_start > 0) {
1.412     raeburn  9386:                 if ($now < $role_start) {
1.274     raeburn  9387:                     $active_chk = 'future';
                   9388:                 }
                   9389:             }
                   9390:             if ($role_end > 0) {
1.412     raeburn  9391:                 if ($now > $role_end) {
1.274     raeburn  9392:                     $active_chk = 'previous';
                   9393:                 }
                   9394:             }
                   9395:         }
                   9396:     }
                   9397:     return $active_chk;
                   9398: }
                   9399: 
                   9400: ###############################################
                   9401: 
                   9402: =pod
                   9403: 
1.405     albertel 9404: =item * &get_sections()
1.233     raeburn  9405: 
                   9406: Determines all the sections for a course including
                   9407: sections with students and sections containing other roles.
1.419     raeburn  9408: Incoming parameters: 
                   9409: 
                   9410: 1. domain
                   9411: 2. course number 
                   9412: 3. reference to array containing roles for which sections should 
                   9413: be gathered (optional).
                   9414: 4. reference to array containing status types for which sections 
                   9415: should be gathered (optional).
                   9416: 
                   9417: If the third argument is undefined, sections are gathered for any role. 
                   9418: If the fourth argument is undefined, sections are gathered for any status.
                   9419: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  9420:  
1.374     raeburn  9421: Returns section hash (keys are section IDs, values are
                   9422: number of users in each section), subject to the
1.419     raeburn  9423: optional roles filter, optional status filter 
1.233     raeburn  9424: 
                   9425: =cut
                   9426: 
                   9427: ###############################################
                   9428: sub get_sections {
1.419     raeburn  9429:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 9430:     if (!defined($cdom) || !defined($cnum)) {
                   9431:         my $cid =  $env{'request.course.id'};
                   9432: 
                   9433: 	return if (!defined($cid));
                   9434: 
                   9435:         $cdom = $env{'course.'.$cid.'.domain'};
                   9436:         $cnum = $env{'course.'.$cid.'.num'};
                   9437:     }
                   9438: 
                   9439:     my %sectioncount;
1.419     raeburn  9440:     my $now = time;
1.240     albertel 9441: 
1.1075.2.33  raeburn  9442:     my $check_students = 1;
                   9443:     my $only_students = 0;
                   9444:     if (ref($possible_roles) eq 'ARRAY') {
                   9445:         if (grep(/^st$/,@{$possible_roles})) {
                   9446:             if (@{$possible_roles} == 1) {
                   9447:                 $only_students = 1;
                   9448:             }
                   9449:         } else {
                   9450:             $check_students = 0;
                   9451:         }
                   9452:     }
                   9453: 
                   9454:     if ($check_students) {
1.276     albertel 9455: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 9456: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   9457: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  9458:         my $start_index = &Apache::loncoursedata::CL_START();
                   9459:         my $end_index = &Apache::loncoursedata::CL_END();
                   9460:         my $status;
1.366     albertel 9461: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  9462: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   9463: 				                     $data->[$status_index],
                   9464:                                                      $data->[$start_index],
                   9465:                                                      $data->[$end_index]);
                   9466:             if ($stu_status eq 'Active') {
                   9467:                 $status = 'active';
                   9468:             } elsif ($end < $now) {
                   9469:                 $status = 'previous';
                   9470:             } elsif ($start > $now) {
                   9471:                 $status = 'future';
                   9472:             } 
                   9473: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   9474:                 if ((!defined($possible_status)) || (($status ne '') && 
                   9475:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   9476: 		    $sectioncount{$section}++;
                   9477:                 }
1.240     albertel 9478: 	    }
                   9479: 	}
                   9480:     }
1.1075.2.33  raeburn  9481:     if ($only_students) {
                   9482:         return %sectioncount;
                   9483:     }
1.240     albertel 9484:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9485:     foreach my $user (sort(keys(%courseroles))) {
                   9486: 	if ($user !~ /^(\w{2})/) { next; }
                   9487: 	my ($role) = ($user =~ /^(\w{2})/);
                   9488: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9489: 	my ($section,$status);
1.240     albertel 9490: 	if ($role eq 'cr' &&
                   9491: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9492: 	    $section=$1;
                   9493: 	}
                   9494: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9495: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9496:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9497:         if ($end == -1 && $start == -1) {
                   9498:             next; #deleted role
                   9499:         }
                   9500:         if (!defined($possible_status)) { 
                   9501:             $sectioncount{$section}++;
                   9502:         } else {
                   9503:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9504:                 $status = 'active';
                   9505:             } elsif ($end < $now) {
                   9506:                 $status = 'future';
                   9507:             } elsif ($start > $now) {
                   9508:                 $status = 'previous';
                   9509:             }
                   9510:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9511:                 $sectioncount{$section}++;
                   9512:             }
                   9513:         }
1.233     raeburn  9514:     }
1.366     albertel 9515:     return %sectioncount;
1.233     raeburn  9516: }
                   9517: 
1.274     raeburn  9518: ###############################################
1.294     raeburn  9519: 
                   9520: =pod
1.405     albertel 9521: 
                   9522: =item * &get_course_users()
                   9523: 
1.275     raeburn  9524: Retrieves usernames:domains for users in the specified course
                   9525: with specific role(s), and access status. 
                   9526: 
                   9527: Incoming parameters:
1.277     albertel 9528: 1. course domain
                   9529: 2. course number
                   9530: 3. access status: users must have - either active, 
1.275     raeburn  9531: previous, future, or all.
1.277     albertel 9532: 4. reference to array of permissible roles
1.288     raeburn  9533: 5. reference to array of section restrictions (optional)
                   9534: 6. reference to results object (hash of hashes).
                   9535: 7. reference to optional userdata hash
1.609     raeburn  9536: 8. reference to optional statushash
1.630     raeburn  9537: 9. flag if privileged users (except those set to unhide in
                   9538:    course settings) should be excluded    
1.609     raeburn  9539: Keys of top level results hash are roles.
1.275     raeburn  9540: Keys of inner hashes are username:domain, with 
                   9541: values set to access type.
1.288     raeburn  9542: Optional userdata hash returns an array with arguments in the 
                   9543: same order as loncoursedata::get_classlist() for student data.
                   9544: 
1.609     raeburn  9545: Optional statushash returns
                   9546: 
1.288     raeburn  9547: Entries for end, start, section and status are blank because
                   9548: of the possibility of multiple values for non-student roles.
                   9549: 
1.275     raeburn  9550: =cut
1.405     albertel 9551: 
1.275     raeburn  9552: ###############################################
1.405     albertel 9553: 
1.275     raeburn  9554: sub get_course_users {
1.630     raeburn  9555:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  9556:     my %idx = ();
1.419     raeburn  9557:     my %seclists;
1.288     raeburn  9558: 
                   9559:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   9560:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   9561:     $idx{end} = &Apache::loncoursedata::CL_END();
                   9562:     $idx{start} = &Apache::loncoursedata::CL_START();
                   9563:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   9564:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   9565:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   9566:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   9567: 
1.290     albertel 9568:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 9569:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  9570:         my $now = time;
1.277     albertel 9571:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  9572:             my $match = 0;
1.412     raeburn  9573:             my $secmatch = 0;
1.419     raeburn  9574:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  9575:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  9576:             if ($section eq '') {
                   9577:                 $section = 'none';
                   9578:             }
1.291     albertel 9579:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9580:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9581:                     $secmatch = 1;
                   9582:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 9583:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9584:                         $secmatch = 1;
                   9585:                     }
                   9586:                 } else {  
1.419     raeburn  9587: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  9588: 		        $secmatch = 1;
                   9589:                     }
1.290     albertel 9590: 		}
1.412     raeburn  9591:                 if (!$secmatch) {
                   9592:                     next;
                   9593:                 }
1.419     raeburn  9594:             }
1.275     raeburn  9595:             if (defined($$types{'active'})) {
1.288     raeburn  9596:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  9597:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  9598:                     $match = 1;
1.275     raeburn  9599:                 }
                   9600:             }
                   9601:             if (defined($$types{'previous'})) {
1.609     raeburn  9602:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  9603:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  9604:                     $match = 1;
1.275     raeburn  9605:                 }
                   9606:             }
                   9607:             if (defined($$types{'future'})) {
1.609     raeburn  9608:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  9609:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  9610:                     $match = 1;
1.275     raeburn  9611:                 }
                   9612:             }
1.609     raeburn  9613:             if ($match) {
                   9614:                 push(@{$seclists{$student}},$section);
                   9615:                 if (ref($userdata) eq 'HASH') {
                   9616:                     $$userdata{$student} = $$classlist{$student};
                   9617:                 }
                   9618:                 if (ref($statushash) eq 'HASH') {
                   9619:                     $statushash->{$student}{'st'}{$section} = $status;
                   9620:                 }
1.288     raeburn  9621:             }
1.275     raeburn  9622:         }
                   9623:     }
1.412     raeburn  9624:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9625:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9626:         my $now = time;
1.609     raeburn  9627:         my %displaystatus = ( previous => 'Expired',
                   9628:                               active   => 'Active',
                   9629:                               future   => 'Future',
                   9630:                             );
1.1075.2.36  raeburn  9631:         my (%nothide,@possdoms);
1.630     raeburn  9632:         if ($hidepriv) {
                   9633:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9634:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9635:                 if ($user !~ /:/) {
                   9636:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9637:                 } else {
                   9638:                     $nothide{$user} = 1;
                   9639:                 }
                   9640:             }
1.1075.2.36  raeburn  9641:             my @possdoms = ($cdom);
                   9642:             if ($coursehash{'checkforpriv'}) {
                   9643:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9644:             }
1.630     raeburn  9645:         }
1.439     raeburn  9646:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9647:             my $match = 0;
1.412     raeburn  9648:             my $secmatch = 0;
1.439     raeburn  9649:             my $status;
1.412     raeburn  9650:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9651:             $user =~ s/:$//;
1.439     raeburn  9652:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9653:             if ($end == -1 || $start == -1) {
                   9654:                 next;
                   9655:             }
                   9656:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9657:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9658:                 my ($uname,$udom) = split(/:/,$user);
                   9659:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9660:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9661:                         $secmatch = 1;
                   9662:                     } elsif ($usec eq '') {
1.420     albertel 9663:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9664:                             $secmatch = 1;
                   9665:                         }
                   9666:                     } else {
                   9667:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9668:                             $secmatch = 1;
                   9669:                         }
                   9670:                     }
                   9671:                     if (!$secmatch) {
                   9672:                         next;
                   9673:                     }
1.288     raeburn  9674:                 }
1.419     raeburn  9675:                 if ($usec eq '') {
                   9676:                     $usec = 'none';
                   9677:                 }
1.275     raeburn  9678:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9679:                     if ($hidepriv) {
1.1075.2.36  raeburn  9680:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9681:                             (!$nothide{$uname.':'.$udom})) {
                   9682:                             next;
                   9683:                         }
                   9684:                     }
1.503     raeburn  9685:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9686:                         $status = 'previous';
                   9687:                     } elsif ($start > $now) {
                   9688:                         $status = 'future';
                   9689:                     } else {
                   9690:                         $status = 'active';
                   9691:                     }
1.277     albertel 9692:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9693:                         if ($status eq $type) {
1.420     albertel 9694:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9695:                                 push(@{$$users{$role}{$user}},$type);
                   9696:                             }
1.288     raeburn  9697:                             $match = 1;
                   9698:                         }
                   9699:                     }
1.419     raeburn  9700:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9701:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9702: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9703:                         }
1.420     albertel 9704:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9705:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9706:                         }
1.609     raeburn  9707:                         if (ref($statushash) eq 'HASH') {
                   9708:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9709:                         }
1.275     raeburn  9710:                     }
                   9711:                 }
                   9712:             }
                   9713:         }
1.290     albertel 9714:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9715:             if ((defined($cdom)) && (defined($cnum))) {
                   9716:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9717:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9718:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9719:                     next if ($owner eq '');
                   9720:                     my ($ownername,$ownerdom);
                   9721:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9722:                         $ownername = $1;
                   9723:                         $ownerdom = $2;
                   9724:                     } else {
                   9725:                         $ownername = $owner;
                   9726:                         $ownerdom = $cdom;
                   9727:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9728:                     }
                   9729:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9730:                     if (defined($userdata) && 
1.609     raeburn  9731: 			!exists($$userdata{$owner})) {
                   9732: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9733:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9734:                             push(@{$seclists{$owner}},'none');
                   9735:                         }
                   9736:                         if (ref($statushash) eq 'HASH') {
                   9737:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9738:                         }
1.290     albertel 9739: 		    }
1.279     raeburn  9740:                 }
                   9741:             }
                   9742:         }
1.419     raeburn  9743:         foreach my $user (keys(%seclists)) {
                   9744:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9745:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9746:         }
1.275     raeburn  9747:     }
                   9748:     return;
                   9749: }
                   9750: 
1.288     raeburn  9751: sub get_user_info {
                   9752:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9753:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9754: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9755:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9756:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9757:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9758:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9759:     return;
                   9760: }
1.275     raeburn  9761: 
1.472     raeburn  9762: ###############################################
                   9763: 
                   9764: =pod
                   9765: 
                   9766: =item * &get_user_quota()
                   9767: 
1.1075.2.41  raeburn  9768: Retrieves quota assigned for storage of user files.
                   9769: Default is to report quota for portfolio files.
1.472     raeburn  9770: 
                   9771: Incoming parameters:
                   9772: 1. user's username
                   9773: 2. user's domain
1.1075.2.41  raeburn  9774: 3. quota name - portfolio, author, or course
                   9775:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  9776: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  9777:    course
1.472     raeburn  9778: 
                   9779: Returns:
1.1075.2.58  raeburn  9780: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9781: 2. (Optional) Type of setting: custom or default
                   9782:    (individually assigned or default for user's 
                   9783:    institutional status).
                   9784: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9785:    or student - types as defined in localenroll::inst_usertypes 
                   9786:    for user's domain, which determines default quota for user.
                   9787: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9788: 
                   9789: If a value has been stored in the user's environment, 
1.536     raeburn  9790: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  9791: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9792: 
                   9793: =cut
                   9794: 
                   9795: ###############################################
                   9796: 
                   9797: 
                   9798: sub get_user_quota {
1.1075.2.42  raeburn  9799:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9800:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9801:     if (!defined($udom)) {
                   9802:         $udom = $env{'user.domain'};
                   9803:     }
                   9804:     if (!defined($uname)) {
                   9805:         $uname = $env{'user.name'};
                   9806:     }
                   9807:     if (($udom eq '' || $uname eq '') ||
                   9808:         ($udom eq 'public') && ($uname eq 'public')) {
                   9809:         $quota = 0;
1.536     raeburn  9810:         $quotatype = 'default';
                   9811:         $defquota = 0; 
1.472     raeburn  9812:     } else {
1.536     raeburn  9813:         my $inststatus;
1.1075.2.41  raeburn  9814:         if ($quotaname eq 'course') {
                   9815:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9816:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9817:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9818:             } else {
                   9819:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9820:                 $quota = $cenv{'internal.uploadquota'};
                   9821:             }
1.536     raeburn  9822:         } else {
1.1075.2.41  raeburn  9823:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   9824:                 if ($quotaname eq 'author') {
                   9825:                     $quota = $env{'environment.authorquota'};
                   9826:                 } else {
                   9827:                     $quota = $env{'environment.portfolioquota'};
                   9828:                 }
                   9829:                 $inststatus = $env{'environment.inststatus'};
                   9830:             } else {
                   9831:                 my %userenv = 
                   9832:                     &Apache::lonnet::get('environment',['portfolioquota',
                   9833:                                          'authorquota','inststatus'],$udom,$uname);
                   9834:                 my ($tmp) = keys(%userenv);
                   9835:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9836:                     if ($quotaname eq 'author') {
                   9837:                         $quota = $userenv{'authorquota'};
                   9838:                     } else {
                   9839:                         $quota = $userenv{'portfolioquota'};
                   9840:                     }
                   9841:                     $inststatus = $userenv{'inststatus'};
                   9842:                 } else {
                   9843:                     undef(%userenv);
                   9844:                 }
                   9845:             }
                   9846:         }
                   9847:         if ($quota eq '' || wantarray) {
                   9848:             if ($quotaname eq 'course') {
                   9849:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  9850:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   9851:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  9852:                     $defquota = $domdefs{$crstype.'quota'};
                   9853:                 }
                   9854:                 if ($defquota eq '') {
                   9855:                     $defquota = 500;
                   9856:                 }
1.1075.2.41  raeburn  9857:             } else {
                   9858:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   9859:             }
                   9860:             if ($quota eq '') {
                   9861:                 $quota = $defquota;
                   9862:                 $quotatype = 'default';
                   9863:             } else {
                   9864:                 $quotatype = 'custom';
                   9865:             }
1.472     raeburn  9866:         }
                   9867:     }
1.536     raeburn  9868:     if (wantarray) {
                   9869:         return ($quota,$quotatype,$settingstatus,$defquota);
                   9870:     } else {
                   9871:         return $quota;
                   9872:     }
1.472     raeburn  9873: }
                   9874: 
                   9875: ###############################################
                   9876: 
                   9877: =pod
                   9878: 
                   9879: =item * &default_quota()
                   9880: 
1.536     raeburn  9881: Retrieves default quota assigned for storage of user portfolio files,
                   9882: given an (optional) user's institutional status.
1.472     raeburn  9883: 
                   9884: Incoming parameters:
1.1075.2.42  raeburn  9885: 
1.472     raeburn  9886: 1. domain
1.536     raeburn  9887: 2. (Optional) institutional status(es).  This is a : separated list of 
                   9888:    status types (e.g., faculty, staff, student etc.)
                   9889:    which apply to the user for whom the default is being retrieved.
                   9890:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  9891:    default quota will be returned.
                   9892: 3.  quota name - portfolio, author, or course
                   9893:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  9894: 
                   9895: Returns:
1.1075.2.42  raeburn  9896: 
1.1075.2.58  raeburn  9897: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  9898: 2. (Optional) institutional type which determined the value of the
                   9899:    default quota.
1.472     raeburn  9900: 
                   9901: If a value has been stored in the domain's configuration db,
                   9902: it will return that, otherwise it returns 20 (for backwards 
                   9903: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  9904: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  9905: 
1.536     raeburn  9906: If the user's status includes multiple types (e.g., staff and student),
                   9907: the largest default quota which applies to the user determines the
                   9908: default quota returned.
                   9909: 
1.472     raeburn  9910: =cut
                   9911: 
                   9912: ###############################################
                   9913: 
                   9914: 
                   9915: sub default_quota {
1.1075.2.41  raeburn  9916:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  9917:     my ($defquota,$settingstatus);
                   9918:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  9919:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  9920:     my $key = 'defaultquota';
                   9921:     if ($quotaname eq 'author') {
                   9922:         $key = 'authorquota';
                   9923:     }
1.622     raeburn  9924:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  9925:         if ($inststatus ne '') {
1.765     raeburn  9926:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  9927:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  9928:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9929:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  9930:                         if ($defquota eq '') {
1.1075.2.41  raeburn  9931:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9932:                             $settingstatus = $item;
1.1075.2.41  raeburn  9933:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   9934:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9935:                             $settingstatus = $item;
                   9936:                         }
                   9937:                     }
1.1075.2.41  raeburn  9938:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  9939:                     if ($quotahash{'quotas'}{$item} ne '') {
                   9940:                         if ($defquota eq '') {
                   9941:                             $defquota = $quotahash{'quotas'}{$item};
                   9942:                             $settingstatus = $item;
                   9943:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   9944:                             $defquota = $quotahash{'quotas'}{$item};
                   9945:                             $settingstatus = $item;
                   9946:                         }
1.536     raeburn  9947:                     }
                   9948:                 }
                   9949:             }
                   9950:         }
                   9951:         if ($defquota eq '') {
1.1075.2.41  raeburn  9952:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9953:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   9954:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  9955:                 $defquota = $quotahash{'quotas'}{'default'};
                   9956:             }
1.536     raeburn  9957:             $settingstatus = 'default';
1.1075.2.42  raeburn  9958:             if ($defquota eq '') {
                   9959:                 if ($quotaname eq 'author') {
                   9960:                     $defquota = 500;
                   9961:                 }
                   9962:             }
1.536     raeburn  9963:         }
                   9964:     } else {
                   9965:         $settingstatus = 'default';
1.1075.2.41  raeburn  9966:         if ($quotaname eq 'author') {
                   9967:             $defquota = 500;
                   9968:         } else {
                   9969:             $defquota = 20;
                   9970:         }
1.536     raeburn  9971:     }
                   9972:     if (wantarray) {
                   9973:         return ($defquota,$settingstatus);
1.472     raeburn  9974:     } else {
1.536     raeburn  9975:         return $defquota;
1.472     raeburn  9976:     }
                   9977: }
                   9978: 
1.1075.2.41  raeburn  9979: ###############################################
                   9980: 
                   9981: =pod
                   9982: 
1.1075.2.42  raeburn  9983: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  9984: 
                   9985: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  9986: of existing file within authoring space will cause quota for the authoring
                   9987: space to be exceeded.
                   9988: 
                   9989: Same, if upload of a file directly to a course/community via Course Editor
                   9990: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  9991: 
1.1075.2.61  raeburn  9992: Inputs: 7 
1.1075.2.42  raeburn  9993: 1. username or coursenum
1.1075.2.41  raeburn  9994: 2. domain
1.1075.2.42  raeburn  9995: 3. context ('author' or 'course')
1.1075.2.41  raeburn  9996: 4. filename of file for which action is being requested
                   9997: 5. filesize (kB) of file
                   9998: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  9999: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  10000: 
                   10001: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   10002:          otherwise return null.
                   10003: 
1.1075.2.42  raeburn  10004: =back
                   10005: 
1.1075.2.41  raeburn  10006: =cut
                   10007: 
1.1075.2.42  raeburn  10008: sub excess_filesize_warning {
1.1075.2.59  raeburn  10009:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  10010:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  10011:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  10012:     if ($context eq 'author') {
                   10013:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   10014:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   10015:     } else {
                   10016:         foreach my $subdir ('docs','supplemental') {
                   10017:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   10018:         }
                   10019:     }
1.1075.2.41  raeburn  10020:     $disk_quota = int($disk_quota * 1000);
                   10021:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  10022:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  10023:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  10024:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   10025:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  10026:                             $disk_quota,$current_disk_usage).
                   10027:                '</p>';
                   10028:     }
                   10029:     return;
                   10030: }
                   10031: 
                   10032: ###############################################
                   10033: 
                   10034: 
1.384     raeburn  10035: sub get_secgrprole_info {
                   10036:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   10037:     my %sections_count = &get_sections($cdom,$cnum);
                   10038:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   10039:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   10040:     my @groups = sort(keys(%curr_groups));
                   10041:     my $allroles = [];
                   10042:     my $rolehash;
                   10043:     my $accesshash = {
                   10044:                      active => 'Currently has access',
                   10045:                      future => 'Will have future access',
                   10046:                      previous => 'Previously had access',
                   10047:                   };
                   10048:     if ($needroles) {
                   10049:         $rolehash = {'all' => 'all'};
1.385     albertel 10050:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   10051: 	if (&Apache::lonnet::error(%user_roles)) {
                   10052: 	    undef(%user_roles);
                   10053: 	}
                   10054:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  10055:             my ($role)=split(/\:/,$item,2);
                   10056:             if ($role eq 'cr') { next; }
                   10057:             if ($role =~ /^cr/) {
                   10058:                 $$rolehash{$role} = (split('/',$role))[3];
                   10059:             } else {
                   10060:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   10061:             }
                   10062:         }
                   10063:         foreach my $key (sort(keys(%{$rolehash}))) {
                   10064:             push(@{$allroles},$key);
                   10065:         }
                   10066:         push (@{$allroles},'st');
                   10067:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   10068:     }
                   10069:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   10070: }
                   10071: 
1.555     raeburn  10072: sub user_picker {
1.1075.2.127  raeburn  10073:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  10074:     my $currdom = $dom;
1.1075.2.114  raeburn  10075:     my @alldoms = &Apache::lonnet::all_domains();
                   10076:     if (@alldoms == 1) {
                   10077:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   10078:                                                ['directorysrch'],$alldoms[0]);
                   10079:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   10080:         my $showdom = $domdesc;
                   10081:         if ($showdom eq '') {
                   10082:             $showdom = $dom;
                   10083:         }
                   10084:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   10085:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   10086:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   10087:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   10088:             }
                   10089:         }
                   10090:     }
1.555     raeburn  10091:     my %curr_selected = (
                   10092:                         srchin => 'dom',
1.580     raeburn  10093:                         srchby => 'lastname',
1.555     raeburn  10094:                       );
                   10095:     my $srchterm;
1.625     raeburn  10096:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  10097:         if ($srch->{'srchby'} ne '') {
                   10098:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   10099:         }
                   10100:         if ($srch->{'srchin'} ne '') {
                   10101:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   10102:         }
                   10103:         if ($srch->{'srchtype'} ne '') {
                   10104:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   10105:         }
                   10106:         if ($srch->{'srchdomain'} ne '') {
                   10107:             $currdom = $srch->{'srchdomain'};
                   10108:         }
                   10109:         $srchterm = $srch->{'srchterm'};
                   10110:     }
1.1075.2.98  raeburn  10111:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  10112:                     'usr'       => 'Search criteria',
1.563     raeburn  10113:                     'doma'      => 'Domain/institution to search',
1.558     albertel 10114:                     'uname'     => 'username',
                   10115:                     'lastname'  => 'last name',
1.555     raeburn  10116:                     'lastfirst' => 'last name, first name',
1.558     albertel 10117:                     'crs'       => 'in this course',
1.576     raeburn  10118:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 10119:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  10120:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 10121:                     'exact'     => 'is',
                   10122:                     'contains'  => 'contains',
1.569     raeburn  10123:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  10124:                                        );
                   10125:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  10126:                     'youm'      => "You must include some text to search for.",
                   10127:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   10128:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   10129:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   10130:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   10131:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   10132:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   10133:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  10134:                                        );
1.1075.2.98  raeburn  10135:     &html_escape(\%html_lt);
                   10136:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  10137:     my $domform;
1.1075.2.126  raeburn  10138:     my $allow_blank = 1;
1.1075.2.115  raeburn  10139:     if ($fixeddom) {
1.1075.2.126  raeburn  10140:         $allow_blank = 0;
                   10141:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  10142:     } else {
1.1075.2.126  raeburn  10143:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  10144:     }
1.563     raeburn  10145:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  10146: 
                   10147:     my @srchins = ('crs','dom','alc','instd');
                   10148: 
                   10149:     foreach my $option (@srchins) {
                   10150:         # FIXME 'alc' option unavailable until 
                   10151:         #       loncreateuser::print_user_query_page()
                   10152:         #       has been completed.
                   10153:         next if ($option eq 'alc');
1.880     raeburn  10154:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  10155:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  10156:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  10157:         if ($curr_selected{'srchin'} eq $option) {
                   10158:             $srchinsel .= ' 
1.1075.2.98  raeburn  10159:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  10160:         } else {
                   10161:             $srchinsel .= '
1.1075.2.98  raeburn  10162:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  10163:         }
1.555     raeburn  10164:     }
1.563     raeburn  10165:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  10166: 
                   10167:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  10168:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  10169:         if ($curr_selected{'srchby'} eq $option) {
                   10170:             $srchbysel .= '
1.1075.2.98  raeburn  10171:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10172:         } else {
                   10173:             $srchbysel .= '
1.1075.2.98  raeburn  10174:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10175:          }
                   10176:     }
                   10177:     $srchbysel .= "\n  </select>\n";
                   10178: 
                   10179:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  10180:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  10181:         if ($curr_selected{'srchtype'} eq $option) {
                   10182:             $srchtypesel .= '
1.1075.2.98  raeburn  10183:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10184:         } else {
                   10185:             $srchtypesel .= '
1.1075.2.98  raeburn  10186:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10187:         }
                   10188:     }
                   10189:     $srchtypesel .= "\n  </select>\n";
                   10190: 
1.558     albertel 10191:     my ($newuserscript,$new_user_create);
1.994     raeburn  10192:     my $context_dom = $env{'request.role.domain'};
                   10193:     if ($context eq 'requestcrs') {
                   10194:         if ($env{'form.coursedom'} ne '') { 
                   10195:             $context_dom = $env{'form.coursedom'};
                   10196:         }
                   10197:     }
1.556     raeburn  10198:     if ($forcenewuser) {
1.576     raeburn  10199:         if (ref($srch) eq 'HASH') {
1.994     raeburn  10200:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  10201:                 if ($cancreate) {
                   10202:                     $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>';
                   10203:                 } else {
1.799     bisitz   10204:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  10205:                     my %usertypetext = (
                   10206:                         official   => 'institutional',
                   10207:                         unofficial => 'non-institutional',
                   10208:                     );
1.799     bisitz   10209:                     $new_user_create = '<p class="LC_warning">'
                   10210:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   10211:                                       .' '
                   10212:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   10213:                                           ,'<a href="'.$helplink.'">','</a>')
                   10214:                                       .'</p><br />';
1.627     raeburn  10215:                 }
1.576     raeburn  10216:             }
                   10217:         }
                   10218: 
1.556     raeburn  10219:         $newuserscript = <<"ENDSCRIPT";
                   10220: 
1.570     raeburn  10221: function setSearch(createnew,callingForm) {
1.556     raeburn  10222:     if (createnew == 1) {
1.570     raeburn  10223:         for (var i=0; i<callingForm.srchby.length; i++) {
                   10224:             if (callingForm.srchby.options[i].value == 'uname') {
                   10225:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  10226:             }
                   10227:         }
1.570     raeburn  10228:         for (var i=0; i<callingForm.srchin.length; i++) {
                   10229:             if ( callingForm.srchin.options[i].value == 'dom') {
                   10230: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  10231:             }
                   10232:         }
1.570     raeburn  10233:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   10234:             if (callingForm.srchtype.options[i].value == 'exact') {
                   10235:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  10236:             }
                   10237:         }
1.570     raeburn  10238:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  10239:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  10240:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  10241:             }
                   10242:         }
                   10243:     }
                   10244: }
                   10245: ENDSCRIPT
1.558     albertel 10246: 
1.556     raeburn  10247:     }
                   10248: 
1.555     raeburn  10249:     my $output = <<"END_BLOCK";
1.556     raeburn  10250: <script type="text/javascript">
1.824     bisitz   10251: // <![CDATA[
1.570     raeburn  10252: function validateEntry(callingForm) {
1.558     albertel 10253: 
1.556     raeburn  10254:     var checkok = 1;
1.558     albertel 10255:     var srchin;
1.570     raeburn  10256:     for (var i=0; i<callingForm.srchin.length; i++) {
                   10257: 	if ( callingForm.srchin[i].checked ) {
                   10258: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 10259: 	}
                   10260:     }
                   10261: 
1.570     raeburn  10262:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   10263:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   10264:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   10265:     var srchterm =  callingForm.srchterm.value;
                   10266:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  10267:     var msg = "";
                   10268: 
                   10269:     if (srchterm == "") {
                   10270:         checkok = 0;
1.1075.2.98  raeburn  10271:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  10272:     }
                   10273: 
1.569     raeburn  10274:     if (srchtype== 'begins') {
                   10275:         if (srchterm.length < 2) {
                   10276:             checkok = 0;
1.1075.2.98  raeburn  10277:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  10278:         }
                   10279:     }
                   10280: 
1.556     raeburn  10281:     if (srchtype== 'contains') {
                   10282:         if (srchterm.length < 3) {
                   10283:             checkok = 0;
1.1075.2.98  raeburn  10284:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  10285:         }
                   10286:     }
                   10287:     if (srchin == 'instd') {
                   10288:         if (srchdomain == '') {
                   10289:             checkok = 0;
1.1075.2.98  raeburn  10290:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  10291:         }
                   10292:     }
                   10293:     if (srchin == 'dom') {
                   10294:         if (srchdomain == '') {
                   10295:             checkok = 0;
1.1075.2.98  raeburn  10296:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  10297:         }
                   10298:     }
                   10299:     if (srchby == 'lastfirst') {
                   10300:         if (srchterm.indexOf(",") == -1) {
                   10301:             checkok = 0;
1.1075.2.98  raeburn  10302:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  10303:         }
                   10304:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   10305:             checkok = 0;
1.1075.2.98  raeburn  10306:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  10307:         }
                   10308:     }
                   10309:     if (checkok == 0) {
1.1075.2.98  raeburn  10310:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  10311:         return;
                   10312:     }
                   10313:     if (checkok == 1) {
1.570     raeburn  10314:         callingForm.submit();
1.556     raeburn  10315:     }
                   10316: }
                   10317: 
                   10318: $newuserscript
                   10319: 
1.824     bisitz   10320: // ]]>
1.556     raeburn  10321: </script>
1.558     albertel 10322: 
                   10323: $new_user_create
                   10324: 
1.555     raeburn  10325: END_BLOCK
1.558     albertel 10326: 
1.876     raeburn  10327:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  10328:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  10329:                $domform.
                   10330:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  10331:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  10332:                $srchbysel.
                   10333:                $srchtypesel. 
                   10334:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   10335:                $srchinsel.
                   10336:                &Apache::lonhtmlcommon::row_closure(1). 
                   10337:                &Apache::lonhtmlcommon::end_pick_box().
                   10338:                '<br />';
1.1075.2.114  raeburn  10339:     return ($output,1);
1.555     raeburn  10340: }
                   10341: 
1.612     raeburn  10342: sub user_rule_check {
1.615     raeburn  10343:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  10344:     my ($response,%inst_response);
1.612     raeburn  10345:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  10346:         if (keys(%{$usershash}) > 1) {
                   10347:             my (%by_username,%by_id,%userdoms);
                   10348:             my $checkid;
1.612     raeburn  10349:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  10350:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   10351:                     $checkid = 1;
                   10352:                 }
                   10353:             }
                   10354:             foreach my $user (keys(%{$usershash})) {
                   10355:                 my ($uname,$udom) = split(/:/,$user);
                   10356:                 if ($checkid) {
                   10357:                     if (ref($usershash->{$user}) eq 'HASH') {
                   10358:                         if ($usershash->{$user}->{'id'} ne '') {
                   10359:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   10360:                             $userdoms{$udom} = 1;
                   10361:                             if (ref($inst_results) eq 'HASH') {
                   10362:                                 $inst_results->{$uname.':'.$udom} = {};
                   10363:                             }
                   10364:                         }
                   10365:                     }
                   10366:                 } else {
                   10367:                     $by_username{$udom}{$uname} = 1;
                   10368:                     $userdoms{$udom} = 1;
                   10369:                     if (ref($inst_results) eq 'HASH') {
                   10370:                         $inst_results->{$uname.':'.$udom} = {};
                   10371:                     }
                   10372:                 }
                   10373:             }
                   10374:             foreach my $udom (keys(%userdoms)) {
                   10375:                 if (!$got_rules->{$udom}) {
                   10376:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10377:                                                              ['usercreation'],$udom);
                   10378:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10379:                         foreach my $item ('username','id') {
                   10380:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10381:                                 $$curr_rules{$udom}{$item} =
                   10382:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   10383:                             }
                   10384:                         }
                   10385:                     }
                   10386:                     $got_rules->{$udom} = 1;
                   10387:                 }
                   10388:             }
                   10389:             if ($checkid) {
                   10390:                 foreach my $udom (keys(%by_id)) {
                   10391:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   10392:                     if ($outcome eq 'ok') {
                   10393:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   10394:                             my $uname = $by_id{$udom}{$id};
                   10395:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10396:                         }
                   10397:                         if (ref($results) eq 'HASH') {
                   10398:                             foreach my $uname (keys(%{$results})) {
                   10399:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   10400:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   10401:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10402:                                 }
                   10403:                             }
                   10404:                         }
                   10405:                     }
1.612     raeburn  10406:                 }
1.615     raeburn  10407:             } else {
1.1075.2.99  raeburn  10408:                 foreach my $udom (keys(%by_username)) {
                   10409:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   10410:                     if ($outcome eq 'ok') {
                   10411:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   10412:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10413:                         }
                   10414:                         if (ref($results) eq 'HASH') {
                   10415:                             foreach my $uname (keys(%{$results})) {
                   10416:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10417:                             }
                   10418:                         }
                   10419:                     }
                   10420:                 }
1.612     raeburn  10421:             }
1.1075.2.99  raeburn  10422:         } elsif (keys(%{$usershash}) == 1) {
                   10423:             my $user = (keys(%{$usershash}))[0];
                   10424:             my ($uname,$udom) = split(/:/,$user);
                   10425:             if (($udom ne '') && ($uname ne '')) {
                   10426:                 if (ref($usershash->{$user}) eq 'HASH') {
                   10427:                     if (ref($checks) eq 'HASH') {
                   10428:                         if (defined($checks->{'username'})) {
                   10429:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   10430:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   10431:                         } elsif (defined($checks->{'id'})) {
                   10432:                             if ($usershash->{$user}->{'id'} ne '') {
                   10433:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10434:                                     &Apache::lonnet::get_instuser($udom,undef,
                   10435:                                                                   $usershash->{$user}->{'id'});
                   10436:                             } else {
                   10437:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10438:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   10439:                             }
                   10440:                         }
                   10441:                     } else {
                   10442:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   10443:                             &Apache::lonnet::get_instuser($udom,$uname);
                   10444:                        return;
                   10445:                     }
                   10446:                     if (!$got_rules->{$udom}) {
                   10447:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10448:                                                                  ['usercreation'],$udom);
                   10449:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10450:                             foreach my $item ('username','id') {
                   10451:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10452:                                    $$curr_rules{$udom}{$item} =
                   10453:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   10454:                                 }
                   10455:                             }
1.585     raeburn  10456:                         }
1.1075.2.99  raeburn  10457:                         $got_rules->{$udom} = 1;
1.585     raeburn  10458:                     }
                   10459:                 }
1.1075.2.99  raeburn  10460:             } else {
                   10461:                 return;
                   10462:             }
                   10463:         } else {
                   10464:             return;
                   10465:         }
                   10466:         foreach my $user (keys(%{$usershash})) {
                   10467:             my ($uname,$udom) = split(/:/,$user);
                   10468:             next if (($udom eq '') || ($uname eq ''));
                   10469:             my $id;
                   10470:             if (ref($inst_results) eq 'HASH') {
                   10471:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   10472:                     $id = $inst_results->{$user}->{'id'};
                   10473:                 }
                   10474:             }
                   10475:             if ($id eq '') {
                   10476:                 if (ref($usershash->{$user})) {
                   10477:                     $id = $usershash->{$user}->{'id'};
                   10478:                 }
1.585     raeburn  10479:             }
1.612     raeburn  10480:             foreach my $item (keys(%{$checks})) {
                   10481:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   10482:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   10483:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  10484:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   10485:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  10486:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   10487:                                 if ($rule_check{$rule}) {
                   10488:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10489:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10490:                                         if (ref($inst_results) eq 'HASH') {
                   10491:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10492:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10493:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10494:                                                 } elsif ($item eq 'id') {
                   10495:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10496:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10497:                                                     }
1.615     raeburn  10498:                                                 }
1.612     raeburn  10499:                                             }
                   10500:                                         }
1.615     raeburn  10501:                                     }
                   10502:                                     last;
1.585     raeburn  10503:                                 }
                   10504:                             }
                   10505:                         }
                   10506:                     }
                   10507:                 }
                   10508:             }
                   10509:         }
                   10510:     }
1.612     raeburn  10511:     return;
                   10512: }
                   10513: 
                   10514: sub user_rule_formats {
                   10515:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10516:     my %text = ( 
                   10517:                  'username' => 'Usernames',
                   10518:                  'id'       => 'IDs',
                   10519:                );
                   10520:     my $output;
                   10521:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10522:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10523:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10524:             $output = '<br />'.
                   10525:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10526:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10527:                       ' <ul>';
1.612     raeburn  10528:             foreach my $rule (@{$ruleorder}) {
                   10529:                 if (ref($curr_rules) eq 'ARRAY') {
                   10530:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10531:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10532:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10533:                                         $rules->{$rule}{'desc'}.'</li>';
                   10534:                         }
                   10535:                     }
                   10536:                 }
                   10537:             }
                   10538:             $output .= '</ul>';
                   10539:         }
                   10540:     }
                   10541:     return $output;
                   10542: }
                   10543: 
                   10544: sub instrule_disallow_msg {
1.615     raeburn  10545:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  10546:     my $response;
                   10547:     my %text = (
                   10548:                   item   => 'username',
                   10549:                   items  => 'usernames',
                   10550:                   match  => 'matches',
                   10551:                   do     => 'does',
                   10552:                   action => 'a username',
                   10553:                   one    => 'one',
                   10554:                );
                   10555:     if ($count > 1) {
                   10556:         $text{'item'} = 'usernames';
                   10557:         $text{'match'} ='match';
                   10558:         $text{'do'} = 'do';
                   10559:         $text{'action'} = 'usernames',
                   10560:         $text{'one'} = 'ones';
                   10561:     }
                   10562:     if ($checkitem eq 'id') {
                   10563:         $text{'items'} = 'IDs';
                   10564:         $text{'item'} = 'ID';
                   10565:         $text{'action'} = 'an ID';
1.615     raeburn  10566:         if ($count > 1) {
                   10567:             $text{'item'} = 'IDs';
                   10568:             $text{'action'} = 'IDs';
                   10569:         }
1.612     raeburn  10570:     }
1.674     bisitz   10571:     $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  10572:     if ($mode eq 'upload') {
                   10573:         if ($checkitem eq 'username') {
                   10574:             $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'}.");
                   10575:         } elsif ($checkitem eq 'id') {
1.674     bisitz   10576:             $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  10577:         }
1.669     raeburn  10578:     } elsif ($mode eq 'selfcreate') {
                   10579:         if ($checkitem eq 'id') {
                   10580:             $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.");
                   10581:         }
1.615     raeburn  10582:     } else {
                   10583:         if ($checkitem eq 'username') {
                   10584:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   10585:         } elsif ($checkitem eq 'id') {
                   10586:             $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.");
                   10587:         }
1.612     raeburn  10588:     }
                   10589:     return $response;
1.585     raeburn  10590: }
                   10591: 
1.624     raeburn  10592: sub personal_data_fieldtitles {
                   10593:     my %fieldtitles = &Apache::lonlocal::texthash (
                   10594:                         id => 'Student/Employee ID',
                   10595:                         permanentemail => 'E-mail address',
                   10596:                         lastname => 'Last Name',
                   10597:                         firstname => 'First Name',
                   10598:                         middlename => 'Middle Name',
                   10599:                         generation => 'Generation',
                   10600:                         gen => 'Generation',
1.765     raeburn  10601:                         inststatus => 'Affiliation',
1.624     raeburn  10602:                    );
                   10603:     return %fieldtitles;
                   10604: }
                   10605: 
1.642     raeburn  10606: sub sorted_inst_types {
                   10607:     my ($dom) = @_;
1.1075.2.70  raeburn  10608:     my ($usertypes,$order);
                   10609:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   10610:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   10611:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   10612:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   10613:     } else {
                   10614:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   10615:     }
1.642     raeburn  10616:     my $othertitle = &mt('All users');
                   10617:     if ($env{'request.course.id'}) {
1.668     raeburn  10618:         $othertitle  = &mt('Any users');
1.642     raeburn  10619:     }
                   10620:     my @types;
                   10621:     if (ref($order) eq 'ARRAY') {
                   10622:         @types = @{$order};
                   10623:     }
                   10624:     if (@types == 0) {
                   10625:         if (ref($usertypes) eq 'HASH') {
                   10626:             @types = sort(keys(%{$usertypes}));
                   10627:         }
                   10628:     }
                   10629:     if (keys(%{$usertypes}) > 0) {
                   10630:         $othertitle = &mt('Other users');
                   10631:     }
                   10632:     return ($othertitle,$usertypes,\@types);
                   10633: }
                   10634: 
1.645     raeburn  10635: sub get_institutional_codes {
1.1075.2.157  raeburn  10636:     my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645     raeburn  10637: # Get complete list of course sections to update
                   10638:     my @currsections = ();
                   10639:     my @currxlists = ();
1.1075.2.157  raeburn  10640:     my (%unclutteredsec,%unclutteredlcsec);
1.645     raeburn  10641:     my $coursecode = $$settings{'internal.coursecode'};
1.1075.2.157  raeburn  10642:     my $crskey = $crs.':'.$coursecode;
                   10643:     @{$unclutteredsec{$crskey}} = ();
                   10644:     @{$unclutteredlcsec{$crskey}} = ();
1.645     raeburn  10645: 
                   10646:     if ($$settings{'internal.sectionnums'} ne '') {
                   10647:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   10648:     }
                   10649: 
                   10650:     if ($$settings{'internal.crosslistings'} ne '') {
                   10651:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   10652:     }
                   10653: 
                   10654:     if (@currxlists > 0) {
1.1075.2.157  raeburn  10655:         foreach my $xl (@currxlists) {
                   10656:             if ($xl =~ /^([^:]+):(\w*)$/) {
1.645     raeburn  10657:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  10658:                     push(@{$allcourses},$1);
1.645     raeburn  10659:                     $$LC_code{$1} = $2;
                   10660:                 }
                   10661:             }
                   10662:         }
                   10663:     }
1.1075.2.157  raeburn  10664: 
1.645     raeburn  10665:     if (@currsections > 0) {
1.1075.2.157  raeburn  10666:         foreach my $sec (@currsections) {
                   10667:             if ($sec =~ m/^(\w+):(\w*)$/ ) {
                   10668:                 my $instsec = $1;
1.645     raeburn  10669:                 my $lc_sec = $2;
1.1075.2.157  raeburn  10670:                 unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
                   10671:                     push(@{$unclutteredsec{$crskey}},$instsec);
                   10672:                     push(@{$unclutteredlcsec{$crskey}},$lc_sec);
                   10673:                 }
                   10674:             }
                   10675:         }
                   10676:     }
                   10677: 
                   10678:     if (@{$unclutteredsec{$crskey}} > 0) {
                   10679:         my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
                   10680:         if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
                   10681:             for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
                   10682:                 my $sec = $coursecode.$formattedsec{$crskey}[$i];
                   10683:                 unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1075.2.119  raeburn  10684:                     push(@{$allcourses},$sec);
1.1075.2.157  raeburn  10685:                     $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645     raeburn  10686:                 }
                   10687:             }
                   10688:         }
                   10689:     }
                   10690:     return;
                   10691: }
                   10692: 
1.971     raeburn  10693: sub get_standard_codeitems {
                   10694:     return ('Year','Semester','Department','Number','Section');
                   10695: }
                   10696: 
1.112     bowersj2 10697: =pod
                   10698: 
1.780     raeburn  10699: =head1 Slot Helpers
                   10700: 
                   10701: =over 4
                   10702: 
                   10703: =item * sorted_slots()
                   10704: 
1.1040    raeburn  10705: Sorts an array of slot names in order of an optional sort key,
                   10706: default sort is by slot start time (earliest first). 
1.780     raeburn  10707: 
                   10708: Inputs:
                   10709: 
                   10710: =over 4
                   10711: 
                   10712: slotsarr  - Reference to array of unsorted slot names.
                   10713: 
                   10714: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   10715: 
1.1040    raeburn  10716: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   10717: 
1.549     albertel 10718: =back
                   10719: 
1.780     raeburn  10720: Returns:
                   10721: 
                   10722: =over 4
                   10723: 
1.1040    raeburn  10724: sorted   - An array of slot names sorted by a specified sort key 
                   10725:            (default sort key is start time of the slot).
1.780     raeburn  10726: 
                   10727: =back
                   10728: 
                   10729: =cut
                   10730: 
                   10731: 
                   10732: sub sorted_slots {
1.1040    raeburn  10733:     my ($slotsarr,$slots,$sortkey) = @_;
                   10734:     if ($sortkey eq '') {
                   10735:         $sortkey = 'starttime';
                   10736:     }
1.780     raeburn  10737:     my @sorted;
                   10738:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   10739:         @sorted =
                   10740:             sort {
                   10741:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  10742:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  10743:                      }
                   10744:                      if (ref($slots->{$a})) { return -1;}
                   10745:                      if (ref($slots->{$b})) { return 1;}
                   10746:                      return 0;
                   10747:                  } @{$slotsarr};
                   10748:     }
                   10749:     return @sorted;
                   10750: }
                   10751: 
1.1040    raeburn  10752: =pod
                   10753: 
                   10754: =item * get_future_slots()
                   10755: 
                   10756: Inputs:
                   10757: 
                   10758: =over 4
                   10759: 
                   10760: cnum - course number
                   10761: 
                   10762: cdom - course domain
                   10763: 
                   10764: now - current UNIX time
                   10765: 
                   10766: symb - optional symb
                   10767: 
                   10768: =back
                   10769: 
                   10770: Returns:
                   10771: 
                   10772: =over 4
                   10773: 
                   10774: sorted_reservable - ref to array of student_schedulable slots currently 
                   10775:                     reservable, ordered by end date of reservation period.
                   10776: 
                   10777: reservable_now - ref to hash of student_schedulable slots currently
                   10778:                  reservable.
                   10779: 
                   10780:     Keys in inner hash are:
                   10781:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  10782:     (b) endreserve: end date of reservation period.
                   10783:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10784:         selected.
1.1040    raeburn  10785: 
                   10786: sorted_future - ref to array of student_schedulable slots reservable in
                   10787:                 the future, ordered by start date of reservation period.
                   10788: 
                   10789: future_reservable - ref to hash of student_schedulable slots reservable
                   10790:                     in the future.
                   10791: 
                   10792:     Keys in inner hash are:
                   10793:     (a) symb: either blank or symb to which slot use is restricted.
                   10794:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  10795:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10796:         selected.
1.1040    raeburn  10797: 
                   10798: =back
                   10799: 
                   10800: =cut
                   10801: 
                   10802: sub get_future_slots {
                   10803:     my ($cnum,$cdom,$now,$symb) = @_;
                   10804:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10805:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10806:     foreach my $slot (keys(%slots)) {
                   10807:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10808:         if ($symb) {
                   10809:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10810:                      ($slots{$slot}->{'symb'} ne $symb));
                   10811:         }
                   10812:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10813:             ($slots{$slot}->{'endtime'} > $now)) {
                   10814:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10815:                 my $userallowed = 0;
                   10816:                 if ($slots{$slot}->{'allowedsections'}) {
                   10817:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10818:                     if (!defined($env{'request.role.sec'})
                   10819:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10820:                         $userallowed=1;
                   10821:                     } else {
                   10822:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   10823:                             $userallowed=1;
                   10824:                         }
                   10825:                     }
                   10826:                     unless ($userallowed) {
                   10827:                         if (defined($env{'request.course.groups'})) {
                   10828:                             my @groups = split(/:/,$env{'request.course.groups'});
                   10829:                             foreach my $group (@groups) {
                   10830:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   10831:                                     $userallowed=1;
                   10832:                                     last;
                   10833:                                 }
                   10834:                             }
                   10835:                         }
                   10836:                     }
                   10837:                 }
                   10838:                 if ($slots{$slot}->{'allowedusers'}) {
                   10839:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   10840:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   10841:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   10842:                         $userallowed = 1;
                   10843:                     }
                   10844:                 }
                   10845:                 next unless($userallowed);
                   10846:             }
                   10847:             my $startreserve = $slots{$slot}->{'startreserve'};
                   10848:             my $endreserve = $slots{$slot}->{'endreserve'};
                   10849:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  10850:             my $uniqueperiod;
                   10851:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   10852:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   10853:             }
1.1040    raeburn  10854:             if (($startreserve < $now) &&
                   10855:                 (!$endreserve || $endreserve > $now)) {
                   10856:                 my $lastres = $endreserve;
                   10857:                 if (!$lastres) {
                   10858:                     $lastres = $slots{$slot}->{'starttime'};
                   10859:                 }
                   10860:                 $reservable_now{$slot} = {
                   10861:                                            symb       => $symb,
1.1075.2.104  raeburn  10862:                                            endreserve => $lastres,
                   10863:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  10864:                                          };
                   10865:             } elsif (($startreserve > $now) &&
                   10866:                      (!$endreserve || $endreserve > $startreserve)) {
                   10867:                 $future_reservable{$slot} = {
                   10868:                                               symb         => $symb,
1.1075.2.104  raeburn  10869:                                               startreserve => $startreserve,
                   10870:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  10871:                                             };
                   10872:             }
                   10873:         }
                   10874:     }
                   10875:     my @unsorted_reservable = keys(%reservable_now);
                   10876:     if (@unsorted_reservable > 0) {
                   10877:         @sorted_reservable = 
                   10878:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   10879:     }
                   10880:     my @unsorted_future = keys(%future_reservable);
                   10881:     if (@unsorted_future > 0) {
                   10882:         @sorted_future =
                   10883:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   10884:     }
                   10885:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   10886: }
1.780     raeburn  10887: 
                   10888: =pod
                   10889: 
1.1057    foxr     10890: =back
                   10891: 
1.549     albertel 10892: =head1 HTTP Helpers
                   10893: 
                   10894: =over 4
                   10895: 
1.648     raeburn  10896: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 10897: 
1.258     albertel 10898: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 10899: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 10900: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 10901: 
                   10902: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   10903: $possible_names is an ref to an array of form element names.  As an example:
                   10904: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 10905: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 10906: 
                   10907: =cut
1.1       albertel 10908: 
1.6       albertel 10909: sub get_unprocessed_cgi {
1.25      albertel 10910:   my ($query,$possible_names)= @_;
1.26      matthew  10911:   # $Apache::lonxml::debug=1;
1.356     albertel 10912:   foreach my $pair (split(/&/,$query)) {
                   10913:     my ($name, $value) = split(/=/,$pair);
1.369     www      10914:     $name = &unescape($name);
1.25      albertel 10915:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   10916:       $value =~ tr/+/ /;
                   10917:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 10918:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 10919:     }
1.16      harris41 10920:   }
1.6       albertel 10921: }
                   10922: 
1.112     bowersj2 10923: =pod
                   10924: 
1.648     raeburn  10925: =item * &cacheheader() 
1.112     bowersj2 10926: 
                   10927: returns cache-controlling header code
                   10928: 
                   10929: =cut
                   10930: 
1.7       albertel 10931: sub cacheheader {
1.258     albertel 10932:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 10933:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   10934:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 10935:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   10936:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 10937:     return $output;
1.7       albertel 10938: }
                   10939: 
1.112     bowersj2 10940: =pod
                   10941: 
1.648     raeburn  10942: =item * &no_cache($r) 
1.112     bowersj2 10943: 
                   10944: specifies header code to not have cache
                   10945: 
                   10946: =cut
                   10947: 
1.9       albertel 10948: sub no_cache {
1.216     albertel 10949:     my ($r) = @_;
                   10950:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 10951: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 10952:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   10953:     $r->no_cache(1);
                   10954:     $r->header_out("Expires" => $date);
                   10955:     $r->header_out("Pragma" => "no-cache");
1.123     www      10956: }
                   10957: 
                   10958: sub content_type {
1.181     albertel 10959:     my ($r,$type,$charset) = @_;
1.299     foxr     10960:     if ($r) {
                   10961: 	#  Note that printout.pl calls this with undef for $r.
                   10962: 	&no_cache($r);
                   10963:     }
1.258     albertel 10964:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 10965:     unless ($charset) {
                   10966: 	$charset=&Apache::lonlocal::current_encoding;
                   10967:     }
                   10968:     if ($charset) { $type.='; charset='.$charset; }
                   10969:     if ($r) {
                   10970: 	$r->content_type($type);
                   10971:     } else {
                   10972: 	print("Content-type: $type\n\n");
                   10973:     }
1.9       albertel 10974: }
1.25      albertel 10975: 
1.112     bowersj2 10976: =pod
                   10977: 
1.648     raeburn  10978: =item * &add_to_env($name,$value) 
1.112     bowersj2 10979: 
1.258     albertel 10980: adds $name to the %env hash with value
1.112     bowersj2 10981: $value, if $name already exists, the entry is converted to an array
                   10982: reference and $value is added to the array.
                   10983: 
                   10984: =cut
                   10985: 
1.25      albertel 10986: sub add_to_env {
                   10987:   my ($name,$value)=@_;
1.258     albertel 10988:   if (defined($env{$name})) {
                   10989:     if (ref($env{$name})) {
1.25      albertel 10990:       #already have multiple values
1.258     albertel 10991:       push(@{ $env{$name} },$value);
1.25      albertel 10992:     } else {
                   10993:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 10994:       my $first=$env{$name};
                   10995:       undef($env{$name});
                   10996:       push(@{ $env{$name} },$first,$value);
1.25      albertel 10997:     }
                   10998:   } else {
1.258     albertel 10999:     $env{$name}=$value;
1.25      albertel 11000:   }
1.31      albertel 11001: }
1.149     albertel 11002: 
                   11003: =pod
                   11004: 
1.648     raeburn  11005: =item * &get_env_multiple($name) 
1.149     albertel 11006: 
1.258     albertel 11007: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 11008: values may be defined and end up as an array ref.
                   11009: 
                   11010: returns an array of values
                   11011: 
                   11012: =cut
                   11013: 
                   11014: sub get_env_multiple {
                   11015:     my ($name) = @_;
                   11016:     my @values;
1.258     albertel 11017:     if (defined($env{$name})) {
1.149     albertel 11018:         # exists is it an array
1.258     albertel 11019:         if (ref($env{$name})) {
                   11020:             @values=@{ $env{$name} };
1.149     albertel 11021:         } else {
1.258     albertel 11022:             $values[0]=$env{$name};
1.149     albertel 11023:         }
                   11024:     }
                   11025:     return(@values);
                   11026: }
                   11027: 
1.660     raeburn  11028: sub ask_for_embedded_content {
                   11029:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  11030:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  11031:         %currsubfile,%unused,$rem);
1.1071    raeburn  11032:     my $counter = 0;
                   11033:     my $numnew = 0;
1.987     raeburn  11034:     my $numremref = 0;
                   11035:     my $numinvalid = 0;
                   11036:     my $numpathchg = 0;
                   11037:     my $numexisting = 0;
1.1071    raeburn  11038:     my $numunused = 0;
                   11039:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  11040:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  11041:     my $heading = &mt('Upload embedded files');
                   11042:     my $buttontext = &mt('Upload');
                   11043: 
1.1075.2.11  raeburn  11044:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  11045:         if ($actionurl eq '/adm/dependencies') {
                   11046:             $navmap = Apache::lonnavmaps::navmap->new();
                   11047:         }
                   11048:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   11049:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  11050:     }
1.1075.2.35  raeburn  11051:     if (($actionurl eq '/adm/portfolio') ||
                   11052:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  11053:         my $current_path='/';
                   11054:         if ($env{'form.currentpath'}) {
                   11055:             $current_path = $env{'form.currentpath'};
                   11056:         }
                   11057:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  11058:             $udom = $cdom;
                   11059:             $uname = $cnum;
1.984     raeburn  11060:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   11061:         } else {
                   11062:             $udom = $env{'user.domain'};
                   11063:             $uname = $env{'user.name'};
                   11064:             $url = '/userfiles/portfolio';
                   11065:         }
1.987     raeburn  11066:         $toplevel = $url.'/';
1.984     raeburn  11067:         $url .= $current_path;
                   11068:         $getpropath = 1;
1.987     raeburn  11069:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   11070:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      11071:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  11072:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  11073:         $toplevel = $url;
1.984     raeburn  11074:         if ($rest ne '') {
1.987     raeburn  11075:             $url .= $rest;
                   11076:         }
                   11077:     } elsif ($actionurl eq '/adm/coursedocs') {
                   11078:         if (ref($args) eq 'HASH') {
1.1071    raeburn  11079:             $url = $args->{'docs_url'};
                   11080:             $toplevel = $url;
1.1075.2.11  raeburn  11081:             if ($args->{'context'} eq 'paste') {
                   11082:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   11083:                 ($path) =
                   11084:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11085:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11086:                 $fileloc =~ s{^/}{};
                   11087:             }
1.1071    raeburn  11088:         }
                   11089:     } elsif ($actionurl eq '/adm/dependencies') {
                   11090:         if ($env{'request.course.id'} ne '') {
                   11091:             if (ref($args) eq 'HASH') {
                   11092:                 $url = $args->{'docs_url'};
                   11093:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  11094:                 $toplevel = $url;
                   11095:                 unless ($toplevel =~ m{^/}) {
                   11096:                     $toplevel = "/$url";
                   11097:                 }
1.1075.2.11  raeburn  11098:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  11099:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   11100:                     $path = $1;
                   11101:                 } else {
                   11102:                     ($path) =
                   11103:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11104:                 }
1.1075.2.79  raeburn  11105:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   11106:                     $fileloc = $toplevel;
                   11107:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   11108:                     my ($udom,$uname,$fname) =
                   11109:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   11110:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   11111:                 } else {
                   11112:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11113:                 }
1.1071    raeburn  11114:                 $fileloc =~ s{^/}{};
                   11115:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   11116:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   11117:             }
1.987     raeburn  11118:         }
1.1075.2.35  raeburn  11119:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11120:         $udom = $cdom;
                   11121:         $uname = $cnum;
                   11122:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   11123:         $toplevel = $url;
                   11124:         $path = $url;
                   11125:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   11126:         $fileloc =~ s{^/}{};
                   11127:     }
                   11128:     foreach my $file (keys(%{$allfiles})) {
                   11129:         my $embed_file;
                   11130:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   11131:             $embed_file = $1;
                   11132:         } else {
                   11133:             $embed_file = $file;
                   11134:         }
1.1075.2.55  raeburn  11135:         my ($absolutepath,$cleaned_file);
                   11136:         if ($embed_file =~ m{^\w+://}) {
                   11137:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  11138:             $newfiles{$cleaned_file} = 1;
                   11139:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11140:         } else {
1.1075.2.55  raeburn  11141:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  11142:             if ($embed_file =~ m{^/}) {
                   11143:                 $absolutepath = $embed_file;
                   11144:             }
1.1075.2.47  raeburn  11145:             if ($cleaned_file =~ m{/}) {
                   11146:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  11147:                 $path = &check_for_traversal($path,$url,$toplevel);
                   11148:                 my $item = $fname;
                   11149:                 if ($path ne '') {
                   11150:                     $item = $path.'/'.$fname;
                   11151:                     $subdependencies{$path}{$fname} = 1;
                   11152:                 } else {
                   11153:                     $dependencies{$item} = 1;
                   11154:                 }
                   11155:                 if ($absolutepath) {
                   11156:                     $mapping{$item} = $absolutepath;
                   11157:                 } else {
                   11158:                     $mapping{$item} = $embed_file;
                   11159:                 }
                   11160:             } else {
                   11161:                 $dependencies{$embed_file} = 1;
                   11162:                 if ($absolutepath) {
1.1075.2.47  raeburn  11163:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  11164:                 } else {
1.1075.2.47  raeburn  11165:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11166:                 }
                   11167:             }
1.984     raeburn  11168:         }
                   11169:     }
1.1071    raeburn  11170:     my $dirptr = 16384;
1.984     raeburn  11171:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  11172:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  11173:         if (($actionurl eq '/adm/portfolio') ||
                   11174:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  11175:             my ($sublistref,$listerror) =
                   11176:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   11177:             if (ref($sublistref) eq 'ARRAY') {
                   11178:                 foreach my $line (@{$sublistref}) {
                   11179:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  11180:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  11181:                 }
1.984     raeburn  11182:             }
1.987     raeburn  11183:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11184:             if (opendir(my $dir,$url.'/'.$path)) {
                   11185:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  11186:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   11187:             }
1.1075.2.11  raeburn  11188:         } elsif (($actionurl eq '/adm/dependencies') ||
                   11189:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11190:                   ($args->{'context'} eq 'paste')) ||
                   11191:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11192:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  11193:                 my $dir;
                   11194:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11195:                     $dir = $fileloc;
                   11196:                 } else {
                   11197:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11198:                 }
1.1071    raeburn  11199:                 if ($dir ne '') {
                   11200:                     my ($sublistref,$listerror) =
                   11201:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   11202:                     if (ref($sublistref) eq 'ARRAY') {
                   11203:                         foreach my $line (@{$sublistref}) {
                   11204:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   11205:                                 undef,$mtime)=split(/\&/,$line,12);
                   11206:                             unless (($testdir&$dirptr) ||
                   11207:                                     ($file_name =~ /^\.\.?$/)) {
                   11208:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   11209:                             }
                   11210:                         }
                   11211:                     }
                   11212:                 }
1.984     raeburn  11213:             }
                   11214:         }
                   11215:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  11216:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  11217:                 my $item = $path.'/'.$file;
                   11218:                 unless ($mapping{$item} eq $item) {
                   11219:                     $pathchanges{$item} = 1;
                   11220:                 }
                   11221:                 $existing{$item} = 1;
                   11222:                 $numexisting ++;
                   11223:             } else {
                   11224:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  11225:             }
                   11226:         }
1.1071    raeburn  11227:         if ($actionurl eq '/adm/dependencies') {
                   11228:             foreach my $path (keys(%currsubfile)) {
                   11229:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   11230:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   11231:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  11232:                              next if (($rem ne '') &&
                   11233:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   11234:                                        (ref($navmap) &&
                   11235:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   11236:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11237:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  11238:                              $unused{$path.'/'.$file} = 1; 
                   11239:                          }
                   11240:                     }
                   11241:                 }
                   11242:             }
                   11243:         }
1.984     raeburn  11244:     }
1.987     raeburn  11245:     my %currfile;
1.1075.2.35  raeburn  11246:     if (($actionurl eq '/adm/portfolio') ||
                   11247:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  11248:         my ($dirlistref,$listerror) =
                   11249:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   11250:         if (ref($dirlistref) eq 'ARRAY') {
                   11251:             foreach my $line (@{$dirlistref}) {
                   11252:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   11253:                 $currfile{$file_name} = 1;
                   11254:             }
1.984     raeburn  11255:         }
1.987     raeburn  11256:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11257:         if (opendir(my $dir,$url)) {
1.987     raeburn  11258:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  11259:             map {$currfile{$_} = 1;} @dir_list;
                   11260:         }
1.1075.2.11  raeburn  11261:     } elsif (($actionurl eq '/adm/dependencies') ||
                   11262:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11263:               ($args->{'context'} eq 'paste')) ||
                   11264:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11265:         if ($env{'request.course.id'} ne '') {
                   11266:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11267:             if ($dir ne '') {
                   11268:                 my ($dirlistref,$listerror) =
                   11269:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   11270:                 if (ref($dirlistref) eq 'ARRAY') {
                   11271:                     foreach my $line (@{$dirlistref}) {
                   11272:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   11273:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   11274:                         unless (($testdir&$dirptr) ||
                   11275:                                 ($file_name =~ /^\.\.?$/)) {
                   11276:                             $currfile{$file_name} = [$size,$mtime];
                   11277:                         }
                   11278:                     }
                   11279:                 }
                   11280:             }
                   11281:         }
1.984     raeburn  11282:     }
                   11283:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  11284:         if (exists($currfile{$file})) {
1.987     raeburn  11285:             unless ($mapping{$file} eq $file) {
                   11286:                 $pathchanges{$file} = 1;
                   11287:             }
                   11288:             $existing{$file} = 1;
                   11289:             $numexisting ++;
                   11290:         } else {
1.984     raeburn  11291:             $newfiles{$file} = 1;
                   11292:         }
                   11293:     }
1.1071    raeburn  11294:     foreach my $file (keys(%currfile)) {
                   11295:         unless (($file eq $filename) ||
                   11296:                 ($file eq $filename.'.bak') ||
                   11297:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  11298:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  11299:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   11300:                     next if (($rem ne '') &&
                   11301:                              (($env{"httpref.$rem".$file} ne '') ||
                   11302:                               (ref($navmap) &&
                   11303:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   11304:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11305:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   11306:                 }
1.1075.2.11  raeburn  11307:             }
1.1071    raeburn  11308:             $unused{$file} = 1;
                   11309:         }
                   11310:     }
1.1075.2.11  raeburn  11311:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   11312:         ($args->{'context'} eq 'paste')) {
                   11313:         $counter = scalar(keys(%existing));
                   11314:         $numpathchg = scalar(keys(%pathchanges));
                   11315:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  11316:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   11317:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   11318:         $counter = scalar(keys(%existing));
                   11319:         $numpathchg = scalar(keys(%pathchanges));
                   11320:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  11321:     }
1.984     raeburn  11322:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  11323:         if ($actionurl eq '/adm/dependencies') {
                   11324:             next if ($embed_file =~ m{^\w+://});
                   11325:         }
1.660     raeburn  11326:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11327:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  11328:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  11329:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  11330:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   11331:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  11332:         }
1.1075.2.35  raeburn  11333:         $upload_output .= '</td>';
1.1071    raeburn  11334:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  11335:             $upload_output.='<td align="right">'.
                   11336:                             '<span class="LC_info LC_fontsize_medium">'.
                   11337:                             &mt("URL points to web address").'</span>';
1.987     raeburn  11338:             $numremref++;
1.660     raeburn  11339:         } elsif ($args->{'error_on_invalid_names'}
                   11340:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  11341:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   11342:                             &mt('Invalid characters').'</span>';
1.987     raeburn  11343:             $numinvalid++;
1.660     raeburn  11344:         } else {
1.1075.2.35  raeburn  11345:             $upload_output .= '<td>'.
                   11346:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  11347:                                                      $embed_file,\%mapping,
1.1071    raeburn  11348:                                                      $allfiles,$codebase,'upload');
                   11349:             $counter ++;
                   11350:             $numnew ++;
1.987     raeburn  11351:         }
                   11352:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   11353:     }
                   11354:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  11355:         if ($actionurl eq '/adm/dependencies') {
                   11356:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   11357:             $modify_output .= &start_data_table_row().
                   11358:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   11359:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   11360:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   11361:                               '<td>'.$size.'</td>'.
                   11362:                               '<td>'.$mtime.'</td>'.
                   11363:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   11364:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   11365:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   11366:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   11367:                               &embedded_file_element('upload_embedded',$counter,
                   11368:                                                      $embed_file,\%mapping,
                   11369:                                                      $allfiles,$codebase,'modify').
                   11370:                               '</div></td>'.
                   11371:                               &end_data_table_row()."\n";
                   11372:             $counter ++;
                   11373:         } else {
                   11374:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11375:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   11376:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   11377:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  11378:                               &Apache::loncommon::end_data_table_row()."\n";
                   11379:         }
                   11380:     }
                   11381:     my $delidx = $counter;
                   11382:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   11383:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   11384:         $delete_output .= &start_data_table_row().
                   11385:                           '<td><img src="'.&icon($oldfile).'" />'.
                   11386:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   11387:                           '<td>'.$size.'</td>'.
                   11388:                           '<td>'.$mtime.'</td>'.
                   11389:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   11390:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   11391:                           &embedded_file_element('upload_embedded',$delidx,
                   11392:                                                  $oldfile,\%mapping,$allfiles,
                   11393:                                                  $codebase,'delete').'</td>'.
                   11394:                           &end_data_table_row()."\n"; 
                   11395:         $numunused ++;
                   11396:         $delidx ++;
1.987     raeburn  11397:     }
                   11398:     if ($upload_output) {
                   11399:         $upload_output = &start_data_table().
                   11400:                          $upload_output.
                   11401:                          &end_data_table()."\n";
                   11402:     }
1.1071    raeburn  11403:     if ($modify_output) {
                   11404:         $modify_output = &start_data_table().
                   11405:                          &start_data_table_header_row().
                   11406:                          '<th>'.&mt('File').'</th>'.
                   11407:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11408:                          '<th>'.&mt('Modified').'</th>'.
                   11409:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   11410:                          &end_data_table_header_row().
                   11411:                          $modify_output.
                   11412:                          &end_data_table()."\n";
                   11413:     }
                   11414:     if ($delete_output) {
                   11415:         $delete_output = &start_data_table().
                   11416:                          &start_data_table_header_row().
                   11417:                          '<th>'.&mt('File').'</th>'.
                   11418:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11419:                          '<th>'.&mt('Modified').'</th>'.
                   11420:                          '<th>'.&mt('Delete?').'</th>'.
                   11421:                          &end_data_table_header_row().
                   11422:                          $delete_output.
                   11423:                          &end_data_table()."\n";
                   11424:     }
1.987     raeburn  11425:     my $applies = 0;
                   11426:     if ($numremref) {
                   11427:         $applies ++;
                   11428:     }
                   11429:     if ($numinvalid) {
                   11430:         $applies ++;
                   11431:     }
                   11432:     if ($numexisting) {
                   11433:         $applies ++;
                   11434:     }
1.1071    raeburn  11435:     if ($counter || $numunused) {
1.987     raeburn  11436:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   11437:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  11438:                   $state.'<h3>'.$heading.'</h3>'; 
                   11439:         if ($actionurl eq '/adm/dependencies') {
                   11440:             if ($numnew) {
                   11441:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   11442:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   11443:                            $upload_output.'<br />'."\n";
                   11444:             }
                   11445:             if ($numexisting) {
                   11446:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   11447:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   11448:                            $modify_output.'<br />'."\n";
                   11449:                            $buttontext = &mt('Save changes');
                   11450:             }
                   11451:             if ($numunused) {
                   11452:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   11453:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   11454:                            $delete_output.'<br />'."\n";
                   11455:                            $buttontext = &mt('Save changes');
                   11456:             }
                   11457:         } else {
                   11458:             $output .= $upload_output.'<br />'."\n";
                   11459:         }
                   11460:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   11461:                    $counter.'" />'."\n";
                   11462:         if ($actionurl eq '/adm/dependencies') { 
                   11463:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   11464:                        $numnew.'" />'."\n";
                   11465:         } elsif ($actionurl eq '') {
1.987     raeburn  11466:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   11467:         }
                   11468:     } elsif ($applies) {
                   11469:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   11470:         if ($applies > 1) {
                   11471:             $output .=  
1.1075.2.35  raeburn  11472:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  11473:             if ($numremref) {
                   11474:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   11475:             }
                   11476:             if ($numinvalid) {
                   11477:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   11478:             }
                   11479:             if ($numexisting) {
                   11480:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   11481:             }
                   11482:             $output .= '</ul><br />';
                   11483:         } elsif ($numremref) {
                   11484:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   11485:         } elsif ($numinvalid) {
                   11486:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   11487:         } elsif ($numexisting) {
                   11488:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   11489:         }
                   11490:         $output .= $upload_output.'<br />';
                   11491:     }
                   11492:     my ($pathchange_output,$chgcount);
1.1071    raeburn  11493:     $chgcount = $counter;
1.987     raeburn  11494:     if (keys(%pathchanges) > 0) {
                   11495:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  11496:             if ($counter) {
1.987     raeburn  11497:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   11498:                                                   $embed_file,\%mapping,
1.1071    raeburn  11499:                                                   $allfiles,$codebase,'change');
1.987     raeburn  11500:             } else {
                   11501:                 $pathchange_output .= 
                   11502:                     &start_data_table_row().
                   11503:                     '<td><input type ="checkbox" name="namechange" value="'.
                   11504:                     $chgcount.'" checked="checked" /></td>'.
                   11505:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11506:                     '<td>'.$embed_file.
                   11507:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11508:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11509:                     '</td>'.&end_data_table_row();
1.660     raeburn  11510:             }
1.987     raeburn  11511:             $numpathchg ++;
                   11512:             $chgcount ++;
1.660     raeburn  11513:         }
                   11514:     }
1.1075.2.35  raeburn  11515:     if (($counter) || ($numunused)) {
1.987     raeburn  11516:         if ($numpathchg) {
                   11517:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11518:                        $numpathchg.'" />'."\n";
                   11519:         }
                   11520:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11521:             ($actionurl eq '/adm/imsimport')) {
                   11522:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11523:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11524:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11525:         } elsif ($actionurl eq '/adm/dependencies') {
                   11526:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11527:         }
1.1075.2.35  raeburn  11528:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11529:     } elsif ($numpathchg) {
                   11530:         my %pathchange = ();
                   11531:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11532:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11533:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  11534:         }
1.987     raeburn  11535:     }
1.1071    raeburn  11536:     return ($output,$counter,$numpathchg);
1.987     raeburn  11537: }
                   11538: 
1.1075.2.47  raeburn  11539: =pod
                   11540: 
                   11541: =item * clean_path($name)
                   11542: 
                   11543: Performs clean-up of directories, subdirectories and filename in an
                   11544: embedded object, referenced in an HTML file which is being uploaded
                   11545: to a course or portfolio, where
                   11546: "Upload embedded images/multimedia files if HTML file" checkbox was
                   11547: checked.
                   11548: 
                   11549: Clean-up is similar to replacements in lonnet::clean_filename()
                   11550: except each / between sub-directory and next level is preserved.
                   11551: 
                   11552: =cut
                   11553: 
                   11554: sub clean_path {
                   11555:     my ($embed_file) = @_;
                   11556:     $embed_file =~s{^/+}{};
                   11557:     my @contents;
                   11558:     if ($embed_file =~ m{/}) {
                   11559:         @contents = split(/\//,$embed_file);
                   11560:     } else {
                   11561:         @contents = ($embed_file);
                   11562:     }
                   11563:     my $lastidx = scalar(@contents)-1;
                   11564:     for (my $i=0; $i<=$lastidx; $i++) {
                   11565:         $contents[$i]=~s{\\}{/}g;
                   11566:         $contents[$i]=~s/\s+/\_/g;
                   11567:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   11568:         if ($i == $lastidx) {
                   11569:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   11570:         }
                   11571:     }
                   11572:     if ($lastidx > 0) {
                   11573:         return join('/',@contents);
                   11574:     } else {
                   11575:         return $contents[0];
                   11576:     }
                   11577: }
                   11578: 
1.987     raeburn  11579: sub embedded_file_element {
1.1071    raeburn  11580:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  11581:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   11582:                    (ref($codebase) eq 'HASH'));
                   11583:     my $output;
1.1071    raeburn  11584:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  11585:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   11586:     }
                   11587:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   11588:                &escape($embed_file).'" />';
                   11589:     unless (($context eq 'upload_embedded') && 
                   11590:             ($mapping->{$embed_file} eq $embed_file)) {
                   11591:         $output .='
                   11592:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   11593:     }
                   11594:     my $attrib;
                   11595:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   11596:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   11597:     }
                   11598:     $output .=
                   11599:         "\n\t\t".
                   11600:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   11601:         $attrib.'" />';
                   11602:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   11603:         $output .=
                   11604:             "\n\t\t".
                   11605:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   11606:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  11607:     }
1.987     raeburn  11608:     return $output;
1.660     raeburn  11609: }
                   11610: 
1.1071    raeburn  11611: sub get_dependency_details {
                   11612:     my ($currfile,$currsubfile,$embed_file) = @_;
                   11613:     my ($size,$mtime,$showsize,$showmtime);
                   11614:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   11615:         if ($embed_file =~ m{/}) {
                   11616:             my ($path,$fname) = split(/\//,$embed_file);
                   11617:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   11618:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   11619:             }
                   11620:         } else {
                   11621:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   11622:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   11623:             }
                   11624:         }
                   11625:         $showsize = $size/1024.0;
                   11626:         $showsize = sprintf("%.1f",$showsize);
                   11627:         if ($mtime > 0) {
                   11628:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   11629:         }
                   11630:     }
                   11631:     return ($showsize,$showmtime);
                   11632: }
                   11633: 
                   11634: sub ask_embedded_js {
                   11635:     return <<"END";
                   11636: <script type="text/javascript"">
                   11637: // <![CDATA[
                   11638: function toggleBrowse(counter) {
                   11639:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   11640:     var fileid = document.getElementById('embedded_item_'+counter);
                   11641:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   11642:     if (chkboxid.checked == true) {
                   11643:         uploaddivid.style.display='block';
                   11644:     } else {
                   11645:         uploaddivid.style.display='none';
                   11646:         fileid.value = '';
                   11647:     }
                   11648: }
                   11649: // ]]>
                   11650: </script>
                   11651: 
                   11652: END
                   11653: }
                   11654: 
1.661     raeburn  11655: sub upload_embedded {
                   11656:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  11657:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   11658:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  11659:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   11660:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   11661:         my $orig_uploaded_filename =
                   11662:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  11663:         foreach my $type ('orig','ref','attrib','codebase') {
                   11664:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   11665:                 $env{'form.embedded_'.$type.'_'.$i} =
                   11666:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   11667:             }
                   11668:         }
1.661     raeburn  11669:         my ($path,$fname) =
                   11670:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   11671:         # no path, whole string is fname
                   11672:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   11673:         $fname = &Apache::lonnet::clean_filename($fname);
                   11674:         # See if there is anything left
                   11675:         next if ($fname eq '');
                   11676: 
                   11677:         # Check if file already exists as a file or directory.
                   11678:         my ($state,$msg);
                   11679:         if ($context eq 'portfolio') {
                   11680:             my $port_path = $dirpath;
                   11681:             if ($group ne '') {
                   11682:                 $port_path = "groups/$group/$port_path";
                   11683:             }
1.987     raeburn  11684:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   11685:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  11686:                                               $dir_root,$port_path,$disk_quota,
                   11687:                                               $current_disk_usage,$uname,$udom);
                   11688:             if ($state eq 'will_exceed_quota'
1.984     raeburn  11689:                 || $state eq 'file_locked') {
1.661     raeburn  11690:                 $output .= $msg;
                   11691:                 next;
                   11692:             }
                   11693:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   11694:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   11695:             if ($state eq 'exists') {
                   11696:                 $output .= $msg;
                   11697:                 next;
                   11698:             }
                   11699:         }
                   11700:         # Check if extension is valid
                   11701:         if (($fname =~ /\.(\w+)$/) &&
                   11702:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  11703:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   11704:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  11705:             next;
                   11706:         } elsif (($fname =~ /\.(\w+)$/) &&
                   11707:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  11708:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  11709:             next;
                   11710:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  11711:             $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  11712:             next;
                   11713:         }
                   11714:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  11715:         my $subdir = $path;
                   11716:         $subdir =~ s{/+$}{};
1.661     raeburn  11717:         if ($context eq 'portfolio') {
1.984     raeburn  11718:             my $result;
                   11719:             if ($state eq 'existingfile') {
                   11720:                 $result=
                   11721:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  11722:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  11723:             } else {
1.984     raeburn  11724:                 $result=
                   11725:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  11726:                                                     $dirpath.
1.1075.2.35  raeburn  11727:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  11728:                 if ($result !~ m|^/uploaded/|) {
                   11729:                     $output .= '<span class="LC_error">'
                   11730:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11731:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11732:                                .'</span><br />';
                   11733:                     next;
                   11734:                 } else {
1.987     raeburn  11735:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11736:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  11737:                 }
1.661     raeburn  11738:             }
1.1075.2.35  raeburn  11739:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   11740:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   11741:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  11742:             my $result =
1.1075.2.35  raeburn  11743:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  11744:             if ($result !~ m|^/uploaded/|) {
                   11745:                 $output .= '<span class="LC_error">'
                   11746:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11747:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11748:                            .'</span><br />';
                   11749:                     next;
                   11750:             } else {
                   11751:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11752:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  11753:                 if ($context eq 'syllabus') {
                   11754:                     &Apache::lonnet::make_public_indefinitely($result);
                   11755:                 }
1.987     raeburn  11756:             }
1.661     raeburn  11757:         } else {
                   11758: # Save the file
                   11759:             my $target = $env{'form.embedded_item_'.$i};
                   11760:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   11761:             my $dest = $fullpath.$fname;
                   11762:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  11763:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  11764:             my $count;
                   11765:             my $filepath = $dir_root;
1.1027    raeburn  11766:             foreach my $subdir (@parts) {
                   11767:                 $filepath .= "/$subdir";
                   11768:                 if (!-e $filepath) {
1.661     raeburn  11769:                     mkdir($filepath,0770);
                   11770:                 }
                   11771:             }
                   11772:             my $fh;
                   11773:             if (!open($fh,'>'.$dest)) {
                   11774:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11775:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11776:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11777:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11778:                            '</span><br />';
                   11779:             } else {
                   11780:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11781:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11782:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11783:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11784:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11785:                               '</span><br />';
                   11786:                 } else {
1.987     raeburn  11787:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11788:                                $url.'</span>').'<br />';
                   11789:                     unless ($context eq 'testbank') {
                   11790:                         $footer .= &mt('View embedded file: [_1]',
                   11791:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11792:                     }
                   11793:                 }
                   11794:                 close($fh);
                   11795:             }
                   11796:         }
                   11797:         if ($env{'form.embedded_ref_'.$i}) {
                   11798:             $pathchange{$i} = 1;
                   11799:         }
                   11800:     }
                   11801:     if ($output) {
                   11802:         $output = '<p>'.$output.'</p>';
                   11803:     }
                   11804:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11805:     $returnflag = 'ok';
1.1071    raeburn  11806:     my $numpathchgs = scalar(keys(%pathchange));
                   11807:     if ($numpathchgs > 0) {
1.987     raeburn  11808:         if ($context eq 'portfolio') {
                   11809:             $output .= '<p>'.&mt('or').'</p>';
                   11810:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11811:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11812:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11813:             $returnflag = 'modify_orightml';
                   11814:         }
                   11815:     }
1.1071    raeburn  11816:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11817: }
                   11818: 
                   11819: sub modify_html_form {
                   11820:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11821:     my $end = 0;
                   11822:     my $modifyform;
                   11823:     if ($context eq 'upload_embedded') {
                   11824:         return unless (ref($pathchange) eq 'HASH');
                   11825:         if ($env{'form.number_embedded_items'}) {
                   11826:             $end += $env{'form.number_embedded_items'};
                   11827:         }
                   11828:         if ($env{'form.number_pathchange_items'}) {
                   11829:             $end += $env{'form.number_pathchange_items'};
                   11830:         }
                   11831:         if ($end) {
                   11832:             for (my $i=0; $i<$end; $i++) {
                   11833:                 if ($i < $env{'form.number_embedded_items'}) {
                   11834:                     next unless($pathchange->{$i});
                   11835:                 }
                   11836:                 $modifyform .=
                   11837:                     &start_data_table_row().
                   11838:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   11839:                     'checked="checked" /></td>'.
                   11840:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   11841:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   11842:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   11843:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   11844:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   11845:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   11846:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   11847:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   11848:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   11849:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   11850:                     &end_data_table_row();
1.1071    raeburn  11851:             }
1.987     raeburn  11852:         }
                   11853:     } else {
                   11854:         $modifyform = $pathchgtable;
                   11855:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   11856:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   11857:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11858:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   11859:         }
                   11860:     }
                   11861:     if ($modifyform) {
1.1071    raeburn  11862:         if ($actionurl eq '/adm/dependencies') {
                   11863:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   11864:         }
1.987     raeburn  11865:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   11866:                '<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".
                   11867:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   11868:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   11869:                '</ol></p>'."\n".'<p>'.
                   11870:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   11871:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   11872:                &start_data_table()."\n".
                   11873:                &start_data_table_header_row().
                   11874:                '<th>'.&mt('Change?').'</th>'.
                   11875:                '<th>'.&mt('Current reference').'</th>'.
                   11876:                '<th>'.&mt('Required reference').'</th>'.
                   11877:                &end_data_table_header_row()."\n".
                   11878:                $modifyform.
                   11879:                &end_data_table().'<br />'."\n".$hiddenstate.
                   11880:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   11881:                '</form>'."\n";
                   11882:     }
                   11883:     return;
                   11884: }
                   11885: 
                   11886: sub modify_html_refs {
1.1075.2.35  raeburn  11887:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  11888:     my $container;
                   11889:     if ($context eq 'portfolio') {
                   11890:         $container = $env{'form.container'};
                   11891:     } elsif ($context eq 'coursedoc') {
                   11892:         $container = $env{'form.primaryurl'};
1.1071    raeburn  11893:     } elsif ($context eq 'manage_dependencies') {
                   11894:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   11895:         $container = "/$container";
1.1075.2.35  raeburn  11896:     } elsif ($context eq 'syllabus') {
                   11897:         $container = $url;
1.987     raeburn  11898:     } else {
1.1027    raeburn  11899:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  11900:     }
                   11901:     my (%allfiles,%codebase,$output,$content);
                   11902:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  11903:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  11904:         if (wantarray) {
                   11905:             return ('',0,0); 
                   11906:         } else {
                   11907:             return;
                   11908:         }
                   11909:     }
                   11910:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11911:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  11912:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   11913:             if (wantarray) {
                   11914:                 return ('',0,0);
                   11915:             } else {
                   11916:                 return;
                   11917:             }
                   11918:         } 
1.987     raeburn  11919:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  11920:         if ($content eq '-1') {
                   11921:             if (wantarray) {
                   11922:                 return ('',0,0);
                   11923:             } else {
                   11924:                 return;
                   11925:             }
                   11926:         }
1.987     raeburn  11927:     } else {
1.1071    raeburn  11928:         unless ($container =~ /^\Q$dir_root\E/) {
                   11929:             if (wantarray) {
                   11930:                 return ('',0,0);
                   11931:             } else {
                   11932:                 return;
                   11933:             }
                   11934:         } 
1.1075.2.128  raeburn  11935:         if (open(my $fh,'<',$container)) {
1.987     raeburn  11936:             $content = join('', <$fh>);
                   11937:             close($fh);
                   11938:         } else {
1.1071    raeburn  11939:             if (wantarray) {
                   11940:                 return ('',0,0);
                   11941:             } else {
                   11942:                 return;
                   11943:             }
1.987     raeburn  11944:         }
                   11945:     }
                   11946:     my ($count,$codebasecount) = (0,0);
                   11947:     my $mm = new File::MMagic;
                   11948:     my $mime_type = $mm->checktype_contents($content);
                   11949:     if ($mime_type eq 'text/html') {
                   11950:         my $parse_result = 
                   11951:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   11952:                                                     \%codebase,\$content);
                   11953:         if ($parse_result eq 'ok') {
                   11954:             foreach my $i (@changes) {
                   11955:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   11956:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   11957:                 if ($allfiles{$ref}) {
                   11958:                     my $newname =  $orig;
                   11959:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  11960:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  11961:                     if ($attrib_regexp =~ /:/) {
                   11962:                         $attrib_regexp =~ s/\:/|/g;
                   11963:                     }
                   11964:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11965:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11966:                         $count += $numchg;
1.1075.2.35  raeburn  11967:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  11968:                         delete($allfiles{$ref});
1.987     raeburn  11969:                     }
                   11970:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  11971:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  11972:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   11973:                         $codebasecount ++;
                   11974:                     }
                   11975:                 }
                   11976:             }
1.1075.2.35  raeburn  11977:             my $skiprewrites;
1.987     raeburn  11978:             if ($count || $codebasecount) {
                   11979:                 my $saveresult;
1.1071    raeburn  11980:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11981:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  11982:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11983:                     if ($url eq $container) {
                   11984:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   11985:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11986:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  11987:                                             $fname.'</span>').'</p>';
1.987     raeburn  11988:                     } else {
                   11989:                          $output = '<p class="LC_error">'.
                   11990:                                    &mt('Error: update failed for: [_1].',
                   11991:                                    '<span class="LC_filename">'.
                   11992:                                    $container.'</span>').'</p>';
                   11993:                     }
1.1075.2.35  raeburn  11994:                     if ($context eq 'syllabus') {
                   11995:                         unless ($saveresult eq 'ok') {
                   11996:                             $skiprewrites = 1;
                   11997:                         }
                   11998:                     }
1.987     raeburn  11999:                 } else {
1.1075.2.128  raeburn  12000:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  12001:                         print $fh $content;
                   12002:                         close($fh);
                   12003:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   12004:                                   $count,'<span class="LC_filename">'.
                   12005:                                   $container.'</span>').'</p>';
1.661     raeburn  12006:                     } else {
1.987     raeburn  12007:                          $output = '<p class="LC_error">'.
                   12008:                                    &mt('Error: could not update [_1].',
                   12009:                                    '<span class="LC_filename">'.
                   12010:                                    $container.'</span>').'</p>';
1.661     raeburn  12011:                     }
                   12012:                 }
                   12013:             }
1.1075.2.35  raeburn  12014:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   12015:                 my ($actionurl,$state);
                   12016:                 $actionurl = "/public/$udom/$uname/syllabus";
                   12017:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   12018:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   12019:                                               \%codebase,
                   12020:                                               {'context' => 'rewrites',
                   12021:                                                'ignore_remote_references' => 1,});
                   12022:                 if (ref($mapping) eq 'HASH') {
                   12023:                     my $rewrites = 0;
                   12024:                     foreach my $key (keys(%{$mapping})) {
                   12025:                         next if ($key =~ m{^https?://});
                   12026:                         my $ref = $mapping->{$key};
                   12027:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   12028:                         my $attrib;
                   12029:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   12030:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   12031:                         }
                   12032:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   12033:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   12034:                             $rewrites += $numchg;
                   12035:                         }
                   12036:                     }
                   12037:                     if ($rewrites) {
                   12038:                         my $saveresult;
                   12039:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   12040:                         if ($url eq $container) {
                   12041:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   12042:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   12043:                                             $count,'<span class="LC_filename">'.
                   12044:                                             $fname.'</span>').'</p>';
                   12045:                         } else {
                   12046:                             $output .= '<p class="LC_error">'.
                   12047:                                        &mt('Error: could not update links in [_1].',
                   12048:                                        '<span class="LC_filename">'.
                   12049:                                        $container.'</span>').'</p>';
                   12050: 
                   12051:                         }
                   12052:                     }
                   12053:                 }
                   12054:             }
1.987     raeburn  12055:         } else {
                   12056:             &logthis('Failed to parse '.$container.
                   12057:                      ' to modify references: '.$parse_result);
1.661     raeburn  12058:         }
                   12059:     }
1.1071    raeburn  12060:     if (wantarray) {
                   12061:         return ($output,$count,$codebasecount);
                   12062:     } else {
                   12063:         return $output;
                   12064:     }
1.661     raeburn  12065: }
                   12066: 
                   12067: sub check_for_existing {
                   12068:     my ($path,$fname,$element) = @_;
                   12069:     my ($state,$msg);
                   12070:     if (-d $path.'/'.$fname) {
                   12071:         $state = 'exists';
                   12072:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12073:     } elsif (-e $path.'/'.$fname) {
                   12074:         $state = 'exists';
                   12075:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12076:     }
                   12077:     if ($state eq 'exists') {
                   12078:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   12079:     }
                   12080:     return ($state,$msg);
                   12081: }
                   12082: 
                   12083: sub check_for_upload {
                   12084:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   12085:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  12086:     my $filesize = length($env{'form.'.$element});
                   12087:     if (!$filesize) {
                   12088:         my $msg = '<span class="LC_error">'.
                   12089:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   12090:                       '<span class="LC_filename">'.$fname.'</span>',
                   12091:                       $filesize).'<br />'.
1.1007    raeburn  12092:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  12093:                   '</span>';
                   12094:         return ('zero_bytes',$msg);
                   12095:     }
                   12096:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  12097:     my $getpropath = 1;
1.1021    raeburn  12098:     my ($dirlistref,$listerror) =
                   12099:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  12100:     my $found_file = 0;
                   12101:     my $locked_file = 0;
1.991     raeburn  12102:     my @lockers;
                   12103:     my $navmap;
                   12104:     if ($env{'request.course.id'}) {
                   12105:         $navmap = Apache::lonnavmaps::navmap->new();
                   12106:     }
1.1021    raeburn  12107:     if (ref($dirlistref) eq 'ARRAY') {
                   12108:         foreach my $line (@{$dirlistref}) {
                   12109:             my ($file_name,$rest)=split(/\&/,$line,2);
                   12110:             if ($file_name eq $fname){
                   12111:                 $file_name = $path.$file_name;
                   12112:                 if ($group ne '') {
                   12113:                     $file_name = $group.$file_name;
                   12114:                 }
                   12115:                 $found_file = 1;
                   12116:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   12117:                     foreach my $lock (@lockers) {
                   12118:                         if (ref($lock) eq 'ARRAY') {
                   12119:                             my ($symb,$crsid) = @{$lock};
                   12120:                             if ($crsid eq $env{'request.course.id'}) {
                   12121:                                 if (ref($navmap)) {
                   12122:                                     my $res = $navmap->getBySymb($symb);
                   12123:                                     foreach my $part (@{$res->parts()}) { 
                   12124:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   12125:                                         unless (($slot_status == $res->RESERVED) ||
                   12126:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   12127:                                             $locked_file = 1;
                   12128:                                         }
1.991     raeburn  12129:                                     }
1.1021    raeburn  12130:                                 } else {
                   12131:                                     $locked_file = 1;
1.991     raeburn  12132:                                 }
                   12133:                             } else {
                   12134:                                 $locked_file = 1;
                   12135:                             }
                   12136:                         }
1.1021    raeburn  12137:                    }
                   12138:                 } else {
                   12139:                     my @info = split(/\&/,$rest);
                   12140:                     my $currsize = $info[6]/1000;
                   12141:                     if ($currsize < $filesize) {
                   12142:                         my $extra = $filesize - $currsize;
                   12143:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  12144:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  12145:                                       &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  12146:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   12147:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   12148:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  12149:                             return ('will_exceed_quota',$msg);
                   12150:                         }
1.984     raeburn  12151:                     }
                   12152:                 }
1.661     raeburn  12153:             }
                   12154:         }
                   12155:     }
                   12156:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  12157:         my $msg = '<p class="LC_warning">'.
                   12158:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   12159:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  12160:         return ('will_exceed_quota',$msg);
                   12161:     } elsif ($found_file) {
                   12162:         if ($locked_file) {
1.1075.2.69  raeburn  12163:             my $msg = '<p class="LC_warning">';
1.661     raeburn  12164:             $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  12165:             $msg .= '</p>';
1.661     raeburn  12166:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   12167:             return ('file_locked',$msg);
                   12168:         } else {
1.1075.2.69  raeburn  12169:             my $msg = '<p class="LC_error">';
1.984     raeburn  12170:             $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  12171:             $msg .= '</p>';
1.984     raeburn  12172:             return ('existingfile',$msg);
1.661     raeburn  12173:         }
                   12174:     }
                   12175: }
                   12176: 
1.987     raeburn  12177: sub check_for_traversal {
                   12178:     my ($path,$url,$toplevel) = @_;
                   12179:     my @parts=split(/\//,$path);
                   12180:     my $cleanpath;
                   12181:     my $fullpath = $url;
                   12182:     for (my $i=0;$i<@parts;$i++) {
                   12183:         next if ($parts[$i] eq '.');
                   12184:         if ($parts[$i] eq '..') {
                   12185:             $fullpath =~ s{([^/]+/)$}{};
                   12186:         } else {
                   12187:             $fullpath .= $parts[$i].'/';
                   12188:         }
                   12189:     }
                   12190:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   12191:         $cleanpath = $1;
                   12192:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   12193:         my $curr_toprel = $1;
                   12194:         my @parts = split(/\//,$curr_toprel);
                   12195:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   12196:         my @urlparts = split(/\//,$url_toprel);
                   12197:         my $doubledots;
                   12198:         my $startdiff = -1;
                   12199:         for (my $i=0; $i<@urlparts; $i++) {
                   12200:             if ($startdiff == -1) {
                   12201:                 unless ($urlparts[$i] eq $parts[$i]) {
                   12202:                     $startdiff = $i;
                   12203:                     $doubledots .= '../';
                   12204:                 }
                   12205:             } else {
                   12206:                 $doubledots .= '../';
                   12207:             }
                   12208:         }
                   12209:         if ($startdiff > -1) {
                   12210:             $cleanpath = $doubledots;
                   12211:             for (my $i=$startdiff; $i<@parts; $i++) {
                   12212:                 $cleanpath .= $parts[$i].'/';
                   12213:             }
                   12214:         }
                   12215:     }
                   12216:     $cleanpath =~ s{(/)$}{};
                   12217:     return $cleanpath;
                   12218: }
1.31      albertel 12219: 
1.1053    raeburn  12220: sub is_archive_file {
                   12221:     my ($mimetype) = @_;
                   12222:     if (($mimetype eq 'application/octet-stream') ||
                   12223:         ($mimetype eq 'application/x-stuffit') ||
                   12224:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   12225:         return 1;
                   12226:     }
                   12227:     return;
                   12228: }
                   12229: 
                   12230: sub decompress_form {
1.1065    raeburn  12231:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  12232:     my %lt = &Apache::lonlocal::texthash (
                   12233:         this => 'This file is an archive file.',
1.1067    raeburn  12234:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  12235:         itsc => 'Its contents are as follows:',
1.1053    raeburn  12236:         youm => 'You may wish to extract its contents.',
                   12237:         extr => 'Extract contents',
1.1067    raeburn  12238:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   12239:         proa => 'Process automatically?',
1.1053    raeburn  12240:         yes  => 'Yes',
                   12241:         no   => 'No',
1.1067    raeburn  12242:         fold => 'Title for folder containing movie',
                   12243:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  12244:     );
1.1065    raeburn  12245:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  12246:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  12247:     my $info = &list_archive_contents($fileloc,\@paths);
                   12248:     if (@paths) {
                   12249:         foreach my $path (@paths) {
                   12250:             $path =~ s{^/}{};
1.1067    raeburn  12251:             if ($path =~ m{^([^/]+)/$}) {
                   12252:                 $topdir = $1;
                   12253:             }
1.1065    raeburn  12254:             if ($path =~ m{^([^/]+)/}) {
                   12255:                 $toplevel{$1} = $path;
                   12256:             } else {
                   12257:                 $toplevel{$path} = $path;
                   12258:             }
                   12259:         }
                   12260:     }
1.1067    raeburn  12261:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  12262:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  12263:                         "$topdir/media/",
                   12264:                         "$topdir/media/$topdir.mp4",
                   12265:                         "$topdir/media/FirstFrame.png",
                   12266:                         "$topdir/media/player.swf",
                   12267:                         "$topdir/media/swfobject.js",
                   12268:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  12269:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  12270:                          "$topdir/$topdir.mp4",
                   12271:                          "$topdir/$topdir\_config.xml",
                   12272:                          "$topdir/$topdir\_controller.swf",
                   12273:                          "$topdir/$topdir\_embed.css",
                   12274:                          "$topdir/$topdir\_First_Frame.png",
                   12275:                          "$topdir/$topdir\_player.html",
                   12276:                          "$topdir/$topdir\_Thumbnails.png",
                   12277:                          "$topdir/playerProductInstall.swf",
                   12278:                          "$topdir/scripts/",
                   12279:                          "$topdir/scripts/config_xml.js",
                   12280:                          "$topdir/scripts/handlebars.js",
                   12281:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   12282:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   12283:                          "$topdir/scripts/modernizr.js",
                   12284:                          "$topdir/scripts/player-min.js",
                   12285:                          "$topdir/scripts/swfobject.js",
                   12286:                          "$topdir/skins/",
                   12287:                          "$topdir/skins/configuration_express.xml",
                   12288:                          "$topdir/skins/express_show/",
                   12289:                          "$topdir/skins/express_show/player-min.css",
                   12290:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  12291:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   12292:                          "$topdir/$topdir.mp4",
                   12293:                          "$topdir/$topdir\_config.xml",
                   12294:                          "$topdir/$topdir\_controller.swf",
                   12295:                          "$topdir/$topdir\_embed.css",
                   12296:                          "$topdir/$topdir\_First_Frame.png",
                   12297:                          "$topdir/$topdir\_player.html",
                   12298:                          "$topdir/$topdir\_Thumbnails.png",
                   12299:                          "$topdir/playerProductInstall.swf",
                   12300:                          "$topdir/scripts/",
                   12301:                          "$topdir/scripts/config_xml.js",
                   12302:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   12303:                          "$topdir/skins/",
                   12304:                          "$topdir/skins/configuration_express.xml",
                   12305:                          "$topdir/skins/express_show/",
                   12306:                          "$topdir/skins/express_show/spritesheet.min.css",
                   12307:                          "$topdir/skins/express_show/spritesheet.png",
                   12308:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  12309:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  12310:         if (@diffs == 0) {
1.1075.2.59  raeburn  12311:             $is_camtasia = 6;
                   12312:         } else {
1.1075.2.81  raeburn  12313:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  12314:             if (@diffs == 0) {
                   12315:                 $is_camtasia = 8;
1.1075.2.81  raeburn  12316:             } else {
                   12317:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   12318:                 if (@diffs == 0) {
                   12319:                     $is_camtasia = 8;
                   12320:                 }
1.1075.2.59  raeburn  12321:             }
1.1067    raeburn  12322:         }
                   12323:     }
                   12324:     my $output;
                   12325:     if ($is_camtasia) {
                   12326:         $output = <<"ENDCAM";
                   12327: <script type="text/javascript" language="Javascript">
                   12328: // <![CDATA[
                   12329: 
                   12330: function camtasiaToggle() {
                   12331:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   12332:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  12333:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  12334:                 document.getElementById('camtasia_titles').style.display='block';
                   12335:             } else {
                   12336:                 document.getElementById('camtasia_titles').style.display='none';
                   12337:             }
                   12338:         }
                   12339:     }
                   12340:     return;
                   12341: }
                   12342: 
                   12343: // ]]>
                   12344: </script>
                   12345: <p>$lt{'camt'}</p>
                   12346: ENDCAM
1.1065    raeburn  12347:     } else {
1.1067    raeburn  12348:         $output = '<p>'.$lt{'this'};
                   12349:         if ($info eq '') {
                   12350:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   12351:         } else {
                   12352:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   12353:                        '<div><pre>'.$info.'</pre></div>';
                   12354:         }
1.1065    raeburn  12355:     }
1.1067    raeburn  12356:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  12357:     my $duplicates;
                   12358:     my $num = 0;
                   12359:     if (ref($dirlist) eq 'ARRAY') {
                   12360:         foreach my $item (@{$dirlist}) {
                   12361:             if (ref($item) eq 'ARRAY') {
                   12362:                 if (exists($toplevel{$item->[0]})) {
                   12363:                     $duplicates .= 
                   12364:                         &start_data_table_row().
                   12365:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12366:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   12367:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12368:                         'value="1" />'.&mt('Yes').'</label>'.
                   12369:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   12370:                         '<td>'.$item->[0].'</td>';
                   12371:                     if ($item->[2]) {
                   12372:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   12373:                     } else {
                   12374:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   12375:                     }
                   12376:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   12377:                                    '<td>'.
                   12378:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   12379:                                    '</td>'.
                   12380:                                    &end_data_table_row();
                   12381:                     $num ++;
                   12382:                 }
                   12383:             }
                   12384:         }
                   12385:     }
                   12386:     my $itemcount;
                   12387:     if (@paths > 0) {
                   12388:         $itemcount = scalar(@paths);
                   12389:     } else {
                   12390:         $itemcount = 1;
                   12391:     }
1.1067    raeburn  12392:     if ($is_camtasia) {
                   12393:         $output .= $lt{'auto'}.'<br />'.
                   12394:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  12395:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  12396:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   12397:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   12398:                    $lt{'no'}.'</label></span><br />'.
                   12399:                    '<div id="camtasia_titles" style="display:block">'.
                   12400:                    &Apache::lonhtmlcommon::start_pick_box().
                   12401:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   12402:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   12403:                    &Apache::lonhtmlcommon::row_closure().
                   12404:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   12405:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   12406:                    &Apache::lonhtmlcommon::row_closure(1).
                   12407:                    &Apache::lonhtmlcommon::end_pick_box().
                   12408:                    '</div>';
                   12409:     }
1.1065    raeburn  12410:     $output .= 
                   12411:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  12412:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   12413:         "\n";
1.1065    raeburn  12414:     if ($duplicates ne '') {
                   12415:         $output .= '<p><span class="LC_warning">'.
                   12416:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   12417:                    &start_data_table().
                   12418:                    &start_data_table_header_row().
                   12419:                    '<th>'.&mt('Overwrite?').'</th>'.
                   12420:                    '<th>'.&mt('Name').'</th>'.
                   12421:                    '<th>'.&mt('Type').'</th>'.
                   12422:                    '<th>'.&mt('Size').'</th>'.
                   12423:                    '<th>'.&mt('Last modified').'</th>'.
                   12424:                    &end_data_table_header_row().
                   12425:                    $duplicates.
                   12426:                    &end_data_table().
                   12427:                    '</p>';
                   12428:     }
1.1067    raeburn  12429:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  12430:     if (ref($hiddenelements) eq 'HASH') {
                   12431:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   12432:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   12433:         }
                   12434:     }
                   12435:     $output .= <<"END";
1.1067    raeburn  12436: <br />
1.1053    raeburn  12437: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   12438: </form>
                   12439: $noextract
                   12440: END
                   12441:     return $output;
                   12442: }
                   12443: 
1.1065    raeburn  12444: sub decompression_utility {
                   12445:     my ($program) = @_;
                   12446:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   12447:     my $location;
                   12448:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   12449:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   12450:                          '/usr/sbin/') {
                   12451:             if (-x $dir.$program) {
                   12452:                 $location = $dir.$program;
                   12453:                 last;
                   12454:             }
                   12455:         }
                   12456:     }
                   12457:     return $location;
                   12458: }
                   12459: 
                   12460: sub list_archive_contents {
                   12461:     my ($file,$pathsref) = @_;
                   12462:     my (@cmd,$output);
                   12463:     my $needsregexp;
                   12464:     if ($file =~ /\.zip$/) {
                   12465:         @cmd = (&decompression_utility('unzip'),"-l");
                   12466:         $needsregexp = 1;
                   12467:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   12468:              ($file =~ /\.tgz$/)) {
                   12469:         @cmd = (&decompression_utility('tar'),"-ztf");
                   12470:     } elsif ($file =~ /\.tar\.bz2$/) {
                   12471:         @cmd = (&decompression_utility('tar'),"-jtf");
                   12472:     } elsif ($file =~ m|\.tar$|) {
                   12473:         @cmd = (&decompression_utility('tar'),"-tf");
                   12474:     }
                   12475:     if (@cmd) {
                   12476:         undef($!);
                   12477:         undef($@);
                   12478:         if (open(my $fh,"-|", @cmd, $file)) {
                   12479:             while (my $line = <$fh>) {
                   12480:                 $output .= $line;
                   12481:                 chomp($line);
                   12482:                 my $item;
                   12483:                 if ($needsregexp) {
                   12484:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   12485:                 } else {
                   12486:                     $item = $line;
                   12487:                 }
                   12488:                 if ($item ne '') {
                   12489:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   12490:                         push(@{$pathsref},$item);
                   12491:                     } 
                   12492:                 }
                   12493:             }
                   12494:             close($fh);
                   12495:         }
                   12496:     }
                   12497:     return $output;
                   12498: }
                   12499: 
1.1053    raeburn  12500: sub decompress_uploaded_file {
                   12501:     my ($file,$dir) = @_;
                   12502:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   12503:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   12504:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   12505:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12506:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12507:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12508:     my $decompressed = $env{'cgi.decompressed'};
                   12509:     &Apache::lonnet::delenv('cgi.file');
                   12510:     &Apache::lonnet::delenv('cgi.dir');
                   12511:     &Apache::lonnet::delenv('cgi.decompressed');
                   12512:     return ($decompressed,$result);
                   12513: }
                   12514: 
1.1055    raeburn  12515: sub process_decompression {
                   12516:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12517:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12518:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12519:                &mt('Unexpected file path.').'</p>'."\n";
                   12520:     }
                   12521:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12522:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12523:                &mt('Unexpected course context.').'</p>'."\n";
                   12524:     }
                   12525:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12526:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12527:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12528:     }
1.1055    raeburn  12529:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12530:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12531:         $error = &mt('Filename not a supported archive file type.').
                   12532:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12533:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   12534:     } else {
                   12535:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12536:         if ($docuhome eq 'no_host') {
                   12537:             $error = &mt('Could not determine home server for course.');
                   12538:         } else {
                   12539:             my @ids=&Apache::lonnet::current_machine_ids();
                   12540:             my $currdir = "$dir_root/$destination";
                   12541:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12542:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   12543:                        "$dir_root/$destination";
                   12544:             } else {
                   12545:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   12546:                        "$dir_root/$docudom/$docuname/$destination";
                   12547:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   12548:                     $error = &mt('Archive file not found.');
                   12549:                 }
                   12550:             }
1.1065    raeburn  12551:             my (@to_overwrite,@to_skip);
                   12552:             if ($env{'form.archive_overwrite_total'} > 0) {
                   12553:                 my $total = $env{'form.archive_overwrite_total'};
                   12554:                 for (my $i=0; $i<$total; $i++) {
                   12555:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   12556:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   12557:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   12558:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   12559:                     }
                   12560:                 }
                   12561:             }
                   12562:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  12563:             my $numoverwrite = scalar(@to_overwrite);
                   12564:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  12565:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   12566:             } elsif ($dir eq '') {
1.1055    raeburn  12567:                 $error = &mt('Directory containing archive file unavailable.');
                   12568:             } elsif (!$error) {
1.1065    raeburn  12569:                 my ($decompressed,$display);
1.1075.2.128  raeburn  12570:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  12571:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   12572:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  12573:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   12574:                         ($decompressed,$display) =
                   12575:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   12576:                         foreach my $item (@to_skip) {
                   12577:                             if (($item ne '') && ($item !~ /\.\./)) {
                   12578:                                 if (-f "$dir/$tempdir/$item") {
                   12579:                                     unlink("$dir/$tempdir/$item");
                   12580:                                 } elsif (-d "$dir/$tempdir/$item") {
                   12581:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   12582:                                 }
                   12583:                             }
                   12584:                         }
                   12585:                         foreach my $item (@to_overwrite) {
                   12586:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   12587:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   12588:                                     if (-f "$dir/$item") {
                   12589:                                         unlink("$dir/$item");
                   12590:                                     } elsif (-d "$dir/$item") {
                   12591:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   12592:                                     }
                   12593:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   12594:                                 }
1.1065    raeburn  12595:                             }
                   12596:                         }
1.1075.2.128  raeburn  12597:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   12598:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   12599:                         }
1.1065    raeburn  12600:                     }
                   12601:                 } else {
                   12602:                     ($decompressed,$display) = 
                   12603:                         &decompress_uploaded_file($file,$dir);
                   12604:                 }
1.1055    raeburn  12605:                 if ($decompressed eq 'ok') {
1.1065    raeburn  12606:                     $output = '<p class="LC_info">'.
                   12607:                               &mt('Files extracted successfully from archive.').
                   12608:                               '</p>'."\n";
1.1055    raeburn  12609:                     my ($warning,$result,@contents);
                   12610:                     my ($newdirlistref,$newlisterror) =
                   12611:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   12612:                                                  $docuname,1);
                   12613:                     my (%is_dir,%changes,@newitems);
                   12614:                     my $dirptr = 16384;
1.1065    raeburn  12615:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  12616:                         foreach my $dir_line (@{$newdirlistref}) {
                   12617:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  12618:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  12619:                                 push(@newitems,$item);
                   12620:                                 if ($dirptr&$testdir) {
                   12621:                                     $is_dir{$item} = 1;
                   12622:                                 }
                   12623:                                 $changes{$item} = 1;
                   12624:                             }
                   12625:                         }
                   12626:                     }
                   12627:                     if (keys(%changes) > 0) {
                   12628:                         foreach my $item (sort(@newitems)) {
                   12629:                             if ($changes{$item}) {
                   12630:                                 push(@contents,$item);
                   12631:                             }
                   12632:                         }
                   12633:                     }
                   12634:                     if (@contents > 0) {
1.1067    raeburn  12635:                         my $wantform;
                   12636:                         unless ($env{'form.autoextract_camtasia'}) {
                   12637:                             $wantform = 1;
                   12638:                         }
1.1056    raeburn  12639:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  12640:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   12641:                                                                 $currdir,\%is_dir,
                   12642:                                                                 \%children,\%parent,
1.1056    raeburn  12643:                                                                 \@contents,\%dirorder,
                   12644:                                                                 \%titles,$wantform);
1.1055    raeburn  12645:                         if ($datatable ne '') {
                   12646:                             $output .= &archive_options_form('decompressed',$datatable,
                   12647:                                                              $count,$hiddenelem);
1.1065    raeburn  12648:                             my $startcount = 6;
1.1055    raeburn  12649:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  12650:                                                            \%titles,\%children);
1.1055    raeburn  12651:                         }
1.1067    raeburn  12652:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  12653:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  12654:                             my %displayed;
                   12655:                             my $total = 1;
                   12656:                             $env{'form.archive_directory'} = [];
                   12657:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   12658:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   12659:                                 $path =~ s{/$}{};
                   12660:                                 my $item;
                   12661:                                 if ($path ne '') {
                   12662:                                     $item = "$path/$titles{$i}";
                   12663:                                 } else {
                   12664:                                     $item = $titles{$i};
                   12665:                                 }
                   12666:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   12667:                                 if ($item eq $contents[0]) {
                   12668:                                     push(@{$env{'form.archive_directory'}},$i);
                   12669:                                     $env{'form.archive_'.$i} = 'display';
                   12670:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   12671:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  12672:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   12673:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  12674:                                     $env{'form.archive_'.$i} = 'display';
                   12675:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   12676:                                     $displayed{'web'} = $i;
                   12677:                                 } else {
1.1075.2.59  raeburn  12678:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   12679:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   12680:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  12681:                                         push(@{$env{'form.archive_directory'}},$i);
                   12682:                                     }
                   12683:                                     $env{'form.archive_'.$i} = 'dependency';
                   12684:                                 }
                   12685:                                 $total ++;
                   12686:                             }
                   12687:                             for (my $i=1; $i<$total; $i++) {
                   12688:                                 next if ($i == $displayed{'web'});
                   12689:                                 next if ($i == $displayed{'folder'});
                   12690:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   12691:                             }
                   12692:                             $env{'form.phase'} = 'decompress_cleanup';
                   12693:                             $env{'form.archivedelete'} = 1;
                   12694:                             $env{'form.archive_count'} = $total-1;
                   12695:                             $output .=
                   12696:                                 &process_extracted_files('coursedocs',$docudom,
                   12697:                                                          $docuname,$destination,
                   12698:                                                          $dir_root,$hiddenelem);
                   12699:                         }
1.1055    raeburn  12700:                     } else {
                   12701:                         $warning = &mt('No new items extracted from archive file.');
                   12702:                     }
                   12703:                 } else {
                   12704:                     $output = $display;
                   12705:                     $error = &mt('An error occurred during extraction from the archive file.');
                   12706:                 }
                   12707:             }
                   12708:         }
                   12709:     }
                   12710:     if ($error) {
                   12711:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12712:                    $error.'</p>'."\n";
                   12713:     }
                   12714:     if ($warning) {
                   12715:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12716:     }
                   12717:     return $output;
                   12718: }
                   12719: 
                   12720: sub get_extracted {
1.1056    raeburn  12721:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   12722:         $titles,$wantform) = @_;
1.1055    raeburn  12723:     my $count = 0;
                   12724:     my $depth = 0;
                   12725:     my $datatable;
1.1056    raeburn  12726:     my @hierarchy;
1.1055    raeburn  12727:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  12728:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   12729:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  12730:     foreach my $item (@{$contents}) {
                   12731:         $count ++;
1.1056    raeburn  12732:         @{$dirorder->{$count}} = @hierarchy;
                   12733:         $titles->{$count} = $item;
1.1055    raeburn  12734:         &archive_hierarchy($depth,$count,$parent,$children);
                   12735:         if ($wantform) {
                   12736:             $datatable .= &archive_row($is_dir->{$item},$item,
                   12737:                                        $currdir,$depth,$count);
                   12738:         }
                   12739:         if ($is_dir->{$item}) {
                   12740:             $depth ++;
1.1056    raeburn  12741:             push(@hierarchy,$count);
                   12742:             $parent->{$depth} = $count;
1.1055    raeburn  12743:             $datatable .=
                   12744:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  12745:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   12746:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  12747:             $depth --;
1.1056    raeburn  12748:             pop(@hierarchy);
1.1055    raeburn  12749:         }
                   12750:     }
                   12751:     return ($count,$datatable);
                   12752: }
                   12753: 
                   12754: sub recurse_extracted_archive {
1.1056    raeburn  12755:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   12756:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  12757:     my $result='';
1.1056    raeburn  12758:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   12759:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   12760:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  12761:         return $result;
                   12762:     }
                   12763:     my $dirptr = 16384;
                   12764:     my ($newdirlistref,$newlisterror) =
                   12765:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   12766:     if (ref($newdirlistref) eq 'ARRAY') {
                   12767:         foreach my $dir_line (@{$newdirlistref}) {
                   12768:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   12769:             unless ($item =~ /^\.+$/) {
                   12770:                 $$count ++;
1.1056    raeburn  12771:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   12772:                 $titles->{$$count} = $item;
1.1055    raeburn  12773:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  12774: 
1.1055    raeburn  12775:                 my $is_dir;
                   12776:                 if ($dirptr&$testdir) {
                   12777:                     $is_dir = 1;
                   12778:                 }
                   12779:                 if ($wantform) {
                   12780:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   12781:                 }
                   12782:                 if ($is_dir) {
                   12783:                     $$depth ++;
1.1056    raeburn  12784:                     push(@{$hierarchy},$$count);
                   12785:                     $parent->{$$depth} = $$count;
1.1055    raeburn  12786:                     $result .=
                   12787:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   12788:                                                    $docuname,$depth,$count,
1.1056    raeburn  12789:                                                    $hierarchy,$dirorder,$children,
                   12790:                                                    $parent,$titles,$wantform);
1.1055    raeburn  12791:                     $$depth --;
1.1056    raeburn  12792:                     pop(@{$hierarchy});
1.1055    raeburn  12793:                 }
                   12794:             }
                   12795:         }
                   12796:     }
                   12797:     return $result;
                   12798: }
                   12799: 
                   12800: sub archive_hierarchy {
                   12801:     my ($depth,$count,$parent,$children) =@_;
                   12802:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12803:         if (exists($parent->{$depth})) {
                   12804:              $children->{$parent->{$depth}} .= $count.':';
                   12805:         }
                   12806:     }
                   12807:     return;
                   12808: }
                   12809: 
                   12810: sub archive_row {
                   12811:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12812:     my ($name) = ($item =~ m{([^/]+)$});
                   12813:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12814:                                        'display'    => 'Add as file',
1.1055    raeburn  12815:                                        'dependency' => 'Include as dependency',
                   12816:                                        'discard'    => 'Discard',
                   12817:                                       );
                   12818:     if ($is_dir) {
1.1059    raeburn  12819:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12820:     }
1.1056    raeburn  12821:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   12822:     my $offset = 0;
1.1055    raeburn  12823:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  12824:         $offset ++;
1.1065    raeburn  12825:         if ($action ne 'display') {
                   12826:             $offset ++;
                   12827:         }  
1.1055    raeburn  12828:         $output .= '<td><span class="LC_nobreak">'.
                   12829:                    '<label><input type="radio" name="archive_'.$count.
                   12830:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   12831:         my $text = $choices{$action};
                   12832:         if ($is_dir) {
                   12833:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   12834:             if ($action eq 'display') {
1.1059    raeburn  12835:                 $text = &mt('Add as folder');
1.1055    raeburn  12836:             }
1.1056    raeburn  12837:         } else {
                   12838:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   12839: 
                   12840:         }
                   12841:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   12842:         if ($action eq 'dependency') {
                   12843:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   12844:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   12845:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   12846:                        '<option value=""></option>'."\n".
                   12847:                        '</select>'."\n".
                   12848:                        '</div>';
1.1059    raeburn  12849:         } elsif ($action eq 'display') {
                   12850:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   12851:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   12852:                        '</div>';
1.1055    raeburn  12853:         }
1.1056    raeburn  12854:         $output .= '</td>';
1.1055    raeburn  12855:     }
                   12856:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   12857:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   12858:     for (my $i=0; $i<$depth; $i++) {
                   12859:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   12860:     }
                   12861:     if ($is_dir) {
                   12862:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   12863:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   12864:     } else {
                   12865:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   12866:     }
                   12867:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   12868:                &end_data_table_row();
                   12869:     return $output;
                   12870: }
                   12871: 
                   12872: sub archive_options_form {
1.1065    raeburn  12873:     my ($form,$display,$count,$hiddenelem) = @_;
                   12874:     my %lt = &Apache::lonlocal::texthash(
                   12875:                perm => 'Permanently remove archive file?',
                   12876:                hows => 'How should each extracted item be incorporated in the course?',
                   12877:                cont => 'Content actions for all',
                   12878:                addf => 'Add as folder/file',
                   12879:                incd => 'Include as dependency for a displayed file',
                   12880:                disc => 'Discard',
                   12881:                no   => 'No',
                   12882:                yes  => 'Yes',
                   12883:                save => 'Save',
                   12884:     );
                   12885:     my $output = <<"END";
                   12886: <form name="$form" method="post" action="">
                   12887: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   12888: <label>
                   12889:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   12890: </label>
                   12891: &nbsp;
                   12892: <label>
                   12893:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   12894: </span>
                   12895: </p>
                   12896: <input type="hidden" name="phase" value="decompress_cleanup" />
                   12897: <br />$lt{'hows'}
                   12898: <div class="LC_columnSection">
                   12899:   <fieldset>
                   12900:     <legend>$lt{'cont'}</legend>
                   12901:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   12902:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   12903:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   12904:   </fieldset>
                   12905: </div>
                   12906: END
                   12907:     return $output.
1.1055    raeburn  12908:            &start_data_table()."\n".
1.1065    raeburn  12909:            $display."\n".
1.1055    raeburn  12910:            &end_data_table()."\n".
                   12911:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   12912:            $hiddenelem.
1.1065    raeburn  12913:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  12914:            '</form>';
                   12915: }
                   12916: 
                   12917: sub archive_javascript {
1.1056    raeburn  12918:     my ($startcount,$numitems,$titles,$children) = @_;
                   12919:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  12920:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  12921:     my $scripttag = <<START;
                   12922: <script type="text/javascript">
                   12923: // <![CDATA[
                   12924: 
                   12925: function checkAll(form,prefix) {
                   12926:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   12927:     for (var i=0; i < form.elements.length; i++) {
                   12928:         var id = form.elements[i].id;
                   12929:         if ((id != '') && (id != undefined)) {
                   12930:             if (idstr.test(id)) {
                   12931:                 if (form.elements[i].type == 'radio') {
                   12932:                     form.elements[i].checked = true;
1.1056    raeburn  12933:                     var nostart = i-$startcount;
1.1059    raeburn  12934:                     var offset = nostart%7;
                   12935:                     var count = (nostart-offset)/7;    
1.1056    raeburn  12936:                     dependencyCheck(form,count,offset);
1.1055    raeburn  12937:                 }
                   12938:             }
                   12939:         }
                   12940:     }
                   12941: }
                   12942: 
                   12943: function propagateCheck(form,count) {
                   12944:     if (count > 0) {
1.1059    raeburn  12945:         var startelement = $startcount + ((count-1) * 7);
                   12946:         for (var j=1; j<6; j++) {
                   12947:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  12948:                 var item = startelement + j; 
                   12949:                 if (form.elements[item].type == 'radio') {
                   12950:                     if (form.elements[item].checked) {
                   12951:                         containerCheck(form,count,j);
                   12952:                         break;
                   12953:                     }
1.1055    raeburn  12954:                 }
                   12955:             }
                   12956:         }
                   12957:     }
                   12958: }
                   12959: 
                   12960: numitems = $numitems
1.1056    raeburn  12961: var titles = new Array(numitems);
                   12962: var parents = new Array(numitems);
1.1055    raeburn  12963: for (var i=0; i<numitems; i++) {
1.1056    raeburn  12964:     parents[i] = new Array;
1.1055    raeburn  12965: }
1.1059    raeburn  12966: var maintitle = '$maintitle';
1.1055    raeburn  12967: 
                   12968: START
                   12969: 
1.1056    raeburn  12970:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   12971:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  12972:         for (my $i=0; $i<@contents; $i ++) {
                   12973:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   12974:         }
                   12975:     }
                   12976: 
1.1056    raeburn  12977:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   12978:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   12979:     }
                   12980: 
1.1055    raeburn  12981:     $scripttag .= <<END;
                   12982: 
                   12983: function containerCheck(form,count,offset) {
                   12984:     if (count > 0) {
1.1056    raeburn  12985:         dependencyCheck(form,count,offset);
1.1059    raeburn  12986:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  12987:         form.elements[item].checked = true;
                   12988:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12989:             if (parents[count].length > 0) {
                   12990:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  12991:                     containerCheck(form,parents[count][j],offset);
                   12992:                 }
                   12993:             }
                   12994:         }
                   12995:     }
                   12996: }
                   12997: 
                   12998: function dependencyCheck(form,count,offset) {
                   12999:     if (count > 0) {
1.1059    raeburn  13000:         var chosen = (offset+$startcount)+7*(count-1);
                   13001:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  13002:         var currtype = form.elements[depitem].type;
                   13003:         if (form.elements[chosen].value == 'dependency') {
                   13004:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   13005:             form.elements[depitem].options.length = 0;
                   13006:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  13007:             for (var i=1; i<=numitems; i++) {
                   13008:                 if (i == count) {
                   13009:                     continue;
                   13010:                 }
1.1059    raeburn  13011:                 var startelement = $startcount + (i-1) * 7;
                   13012:                 for (var j=1; j<6; j++) {
                   13013:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  13014:                         var item = startelement + j;
                   13015:                         if (form.elements[item].type == 'radio') {
                   13016:                             if (form.elements[item].checked) {
                   13017:                                 if (form.elements[item].value == 'display') {
                   13018:                                     var n = form.elements[depitem].options.length;
                   13019:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   13020:                                 }
                   13021:                             }
                   13022:                         }
                   13023:                     }
                   13024:                 }
                   13025:             }
                   13026:         } else {
                   13027:             document.getElementById('arc_depon_'+count).style.display='none';
                   13028:             form.elements[depitem].options.length = 0;
                   13029:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   13030:         }
1.1059    raeburn  13031:         titleCheck(form,count,offset);
1.1056    raeburn  13032:     }
                   13033: }
                   13034: 
                   13035: function propagateSelect(form,count,offset) {
                   13036:     if (count > 0) {
1.1065    raeburn  13037:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  13038:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   13039:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13040:             if (parents[count].length > 0) {
                   13041:                 for (var j=0; j<parents[count].length; j++) {
                   13042:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  13043:                 }
                   13044:             }
                   13045:         }
                   13046:     }
                   13047: }
1.1056    raeburn  13048: 
                   13049: function containerSelect(form,count,offset,picked) {
                   13050:     if (count > 0) {
1.1065    raeburn  13051:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  13052:         if (form.elements[item].type == 'radio') {
                   13053:             if (form.elements[item].value == 'dependency') {
                   13054:                 if (form.elements[item+1].type == 'select-one') {
                   13055:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   13056:                         if (form.elements[item+1].options[i].value == picked) {
                   13057:                             form.elements[item+1].selectedIndex = i;
                   13058:                             break;
                   13059:                         }
                   13060:                     }
                   13061:                 }
                   13062:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13063:                     if (parents[count].length > 0) {
                   13064:                         for (var j=0; j<parents[count].length; j++) {
                   13065:                             containerSelect(form,parents[count][j],offset,picked);
                   13066:                         }
                   13067:                     }
                   13068:                 }
                   13069:             }
                   13070:         }
                   13071:     }
                   13072: }
                   13073: 
1.1059    raeburn  13074: function titleCheck(form,count,offset) {
                   13075:     if (count > 0) {
                   13076:         var chosen = (offset+$startcount)+7*(count-1);
                   13077:         var depitem = $startcount + ((count-1) * 7) + 2;
                   13078:         var currtype = form.elements[depitem].type;
                   13079:         if (form.elements[chosen].value == 'display') {
                   13080:             document.getElementById('arc_title_'+count).style.display='block';
                   13081:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   13082:                 document.getElementById('archive_title_'+count).value=maintitle;
                   13083:             }
                   13084:         } else {
                   13085:             document.getElementById('arc_title_'+count).style.display='none';
                   13086:             if (currtype == 'text') { 
                   13087:                 document.getElementById('archive_title_'+count).value='';
                   13088:             }
                   13089:         }
                   13090:     }
                   13091:     return;
                   13092: }
                   13093: 
1.1055    raeburn  13094: // ]]>
                   13095: </script>
                   13096: END
                   13097:     return $scripttag;
                   13098: }
                   13099: 
                   13100: sub process_extracted_files {
1.1067    raeburn  13101:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  13102:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  13103:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  13104:     my @ids=&Apache::lonnet::current_machine_ids();
                   13105:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  13106:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  13107:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   13108:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   13109:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   13110:         $pathtocheck = "$dir_root/$destination";
                   13111:         $dir = $dir_root;
                   13112:         $ishome = 1;
                   13113:     } else {
                   13114:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   13115:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  13116:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  13117:     }
                   13118:     my $currdir = "$dir_root/$destination";
                   13119:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   13120:     if ($env{'form.folderpath'}) {
                   13121:         my @items = split('&',$env{'form.folderpath'});
                   13122:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  13123:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   13124:             $containers{'0'}='page';
                   13125:         } else {
                   13126:             $containers{'0'}='sequence';
                   13127:         }
1.1055    raeburn  13128:     }
                   13129:     my @archdirs = &get_env_multiple('form.archive_directory');
                   13130:     if ($numitems) {
                   13131:         for (my $i=1; $i<=$numitems; $i++) {
                   13132:             my $path = $env{'form.archive_content_'.$i};
                   13133:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   13134:                 my $item = $1;
                   13135:                 $toplevelitems{$item} = $i;
                   13136:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   13137:                     $is_dir{$item} = 1;
                   13138:                 }
                   13139:             }
                   13140:         }
                   13141:     }
1.1067    raeburn  13142:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  13143:     if (keys(%toplevelitems) > 0) {
                   13144:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  13145:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   13146:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  13147:     }
1.1066    raeburn  13148:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  13149:     if ($numitems) {
                   13150:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  13151:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  13152:             my $path = $env{'form.archive_content_'.$i};
                   13153:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13154:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   13155:                     if ($prefix ne '' && $path ne '') {
                   13156:                         if (-e $prefix.$path) {
1.1066    raeburn  13157:                             if ((@archdirs > 0) && 
                   13158:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   13159:                                 $todeletedir{$prefix.$path} = 1;
                   13160:                             } else {
                   13161:                                 $todelete{$prefix.$path} = 1;
                   13162:                             }
1.1055    raeburn  13163:                         }
                   13164:                     }
                   13165:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  13166:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  13167:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  13168:                     $docstitle = $env{'form.archive_title_'.$i};
                   13169:                     if ($docstitle eq '') {
                   13170:                         $docstitle = $title;
                   13171:                     }
1.1055    raeburn  13172:                     $outer = 0;
1.1056    raeburn  13173:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13174:                         if (@{$dirorder{$i}} > 0) {
                   13175:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  13176:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   13177:                                     $outer = $item;
                   13178:                                     last;
                   13179:                                 }
                   13180:                             }
                   13181:                         }
                   13182:                     }
                   13183:                     my ($errtext,$fatal) = 
                   13184:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   13185:                                                '/'.$folders{$outer}.'.'.
                   13186:                                                $containers{$outer});
                   13187:                     next if ($fatal);
                   13188:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   13189:                         if ($context eq 'coursedocs') {
1.1056    raeburn  13190:                             $mapinner{$i} = time;
1.1055    raeburn  13191:                             $folders{$i} = 'default_'.$mapinner{$i};
                   13192:                             $containers{$i} = 'sequence';
                   13193:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13194:                                       $folders{$i}.'.'.$containers{$i};
                   13195:                             my $newidx = &LONCAPA::map::getresidx();
                   13196:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  13197:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  13198:                             push(@LONCAPA::map::order,$newidx);
                   13199:                             my ($outtext,$errtext) =
                   13200:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13201:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  13202:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  13203:                             $newseqid{$i} = $newidx;
1.1067    raeburn  13204:                             unless ($errtext) {
1.1075.2.128  raeburn  13205:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   13206:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   13207:                                             '</li>'."\n";
1.1067    raeburn  13208:                             }
1.1055    raeburn  13209:                         }
                   13210:                     } else {
                   13211:                         if ($context eq 'coursedocs') {
                   13212:                             my $newidx=&LONCAPA::map::getresidx();
                   13213:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13214:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   13215:                                       $title;
1.1075.2.167  raeburn  13216:                             if (($outer !~ /\D/) &&
                   13217:                                 (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
                   13218:                                 ($newidx !~ /\D/)) {
1.1075.2.128  raeburn  13219:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   13220:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  13221:                                 }
1.1075.2.128  raeburn  13222:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13223:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   13224:                                 }
                   13225:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13226:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   13227:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   13228:                                         unless ($ishome) {
                   13229:                                             my $fetch = "$newdest{$i}/$title";
                   13230:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   13231:                                             $prompttofetch{$fetch} = 1;
                   13232:                                         }
                   13233:                                    }
                   13234:                                 }
                   13235:                                 $LONCAPA::map::resources[$newidx]=
                   13236:                                     $docstitle.':'.$url.':false:normal:res';
                   13237:                                 push(@LONCAPA::map::order, $newidx);
                   13238:                                 my ($outtext,$errtext)=
                   13239:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13240:                                                             $docuname.'/'.$folders{$outer}.
                   13241:                                                             '.'.$containers{$outer},1,1);
                   13242:                                 unless ($errtext) {
                   13243:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   13244:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   13245:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   13246:                                                    '</li>'."\n";
                   13247:                                     }
1.1067    raeburn  13248:                                 }
1.1075.2.128  raeburn  13249:                             } else {
                   13250:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13251:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  13252:                             }
1.1055    raeburn  13253:                         }
                   13254:                     }
1.1075.2.11  raeburn  13255:                 }
                   13256:             } else {
1.1075.2.128  raeburn  13257:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13258:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  13259:             }
                   13260:         }
                   13261:         for (my $i=1; $i<=$numitems; $i++) {
                   13262:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   13263:             my $path = $env{'form.archive_content_'.$i};
                   13264:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13265:                 my ($title) = ($path =~ m{/([^/]+)$});
                   13266:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   13267:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   13268:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13269:                         my ($itemidx,$fullpath,$relpath);
                   13270:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   13271:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  13272:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  13273:                                 if ($dirorder{$i}->[$j] eq $container) {
                   13274:                                     $itemidx = $j;
1.1056    raeburn  13275:                                 }
                   13276:                             }
1.1075.2.11  raeburn  13277:                         }
                   13278:                         if ($itemidx eq '') {
                   13279:                             $itemidx =  0;
                   13280:                         }
                   13281:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   13282:                             if ($mapinner{$referrer{$i}}) {
                   13283:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   13284:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13285:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13286:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13287:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13288:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13289:                                             if (!-e $fullpath) {
                   13290:                                                 mkdir($fullpath,0755);
1.1056    raeburn  13291:                                             }
                   13292:                                         }
1.1075.2.11  raeburn  13293:                                     } else {
                   13294:                                         last;
1.1056    raeburn  13295:                                     }
1.1075.2.11  raeburn  13296:                                 }
                   13297:                             }
                   13298:                         } elsif ($newdest{$referrer{$i}}) {
                   13299:                             $fullpath = $newdest{$referrer{$i}};
                   13300:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13301:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   13302:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   13303:                                     last;
                   13304:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13305:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13306:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13307:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13308:                                         if (!-e $fullpath) {
                   13309:                                             mkdir($fullpath,0755);
1.1056    raeburn  13310:                                         }
                   13311:                                     }
1.1075.2.11  raeburn  13312:                                 } else {
                   13313:                                     last;
1.1056    raeburn  13314:                                 }
1.1075.2.11  raeburn  13315:                             }
                   13316:                         }
                   13317:                         if ($fullpath ne '') {
                   13318:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  13319:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   13320:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   13321:                                 }
1.1075.2.11  raeburn  13322:                             }
                   13323:                             if (-e "$fullpath/$title") {
                   13324:                                 my $showpath;
                   13325:                                 if ($relpath ne '') {
                   13326:                                     $showpath = "$relpath/$title";
                   13327:                                 } else {
                   13328:                                     $showpath = "/$title";
1.1056    raeburn  13329:                                 }
1.1075.2.128  raeburn  13330:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   13331:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   13332:                                            '</li>'."\n";
                   13333:                                 unless ($ishome) {
                   13334:                                     my $fetch = "$fullpath/$title";
                   13335:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   13336:                                     $prompttofetch{$fetch} = 1;
                   13337:                                 }
1.1055    raeburn  13338:                             }
                   13339:                         }
                   13340:                     }
1.1075.2.11  raeburn  13341:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   13342:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  13343:                                     &HTML::Entities::encode($path,'<>&"'),
                   13344:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   13345:                                 '<br />';
1.1055    raeburn  13346:                 }
                   13347:             } else {
1.1075.2.128  raeburn  13348:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13349:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  13350:             }
                   13351:         }
                   13352:         if (keys(%todelete)) {
                   13353:             foreach my $key (keys(%todelete)) {
                   13354:                 unlink($key);
1.1066    raeburn  13355:             }
                   13356:         }
                   13357:         if (keys(%todeletedir)) {
                   13358:             foreach my $key (keys(%todeletedir)) {
                   13359:                 rmdir($key);
                   13360:             }
                   13361:         }
                   13362:         foreach my $dir (sort(keys(%is_dir))) {
                   13363:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   13364:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  13365:             }
                   13366:         }
1.1067    raeburn  13367:         if ($result ne '') {
                   13368:             $output .= '<ul>'."\n".
                   13369:                        $result."\n".
                   13370:                        '</ul>';
                   13371:         }
                   13372:         unless ($ishome) {
                   13373:             my $replicationfail;
                   13374:             foreach my $item (keys(%prompttofetch)) {
                   13375:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   13376:                 unless ($fetchresult eq 'ok') {
                   13377:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   13378:                 }
                   13379:             }
                   13380:             if ($replicationfail) {
                   13381:                 $output .= '<p class="LC_error">'.
                   13382:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   13383:                            $replicationfail.
                   13384:                            '</ul></p>';
                   13385:             }
                   13386:         }
1.1055    raeburn  13387:     } else {
                   13388:         $warning = &mt('No items found in archive.');
                   13389:     }
                   13390:     if ($error) {
                   13391:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13392:                    $error.'</p>'."\n";
                   13393:     }
                   13394:     if ($warning) {
                   13395:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13396:     }
                   13397:     return $output;
                   13398: }
                   13399: 
1.1066    raeburn  13400: sub cleanup_empty_dirs {
                   13401:     my ($path) = @_;
                   13402:     if (($path ne '') && (-d $path)) {
                   13403:         if (opendir(my $dirh,$path)) {
                   13404:             my @dircontents = grep(!/^\./,readdir($dirh));
                   13405:             my $numitems = 0;
                   13406:             foreach my $item (@dircontents) {
                   13407:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  13408:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  13409:                     if (-e "$path/$item") {
                   13410:                         $numitems ++;
                   13411:                     }
                   13412:                 } else {
                   13413:                     $numitems ++;
                   13414:                 }
                   13415:             }
                   13416:             if ($numitems == 0) {
                   13417:                 rmdir($path);
                   13418:             }
                   13419:             closedir($dirh);
                   13420:         }
                   13421:     }
                   13422:     return;
                   13423: }
                   13424: 
1.41      ng       13425: =pod
1.45      matthew  13426: 
1.1075.2.56  raeburn  13427: =item * &get_folder_hierarchy()
1.1068    raeburn  13428: 
                   13429: Provides hierarchy of names of folders/sub-folders containing the current
                   13430: item,
                   13431: 
                   13432: Inputs: 3
                   13433:      - $navmap - navmaps object
                   13434: 
                   13435:      - $map - url for map (either the trigger itself, or map containing
                   13436:                            the resource, which is the trigger).
                   13437: 
                   13438:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   13439: 
                   13440: Outputs: 1 @pathitems - array of folder/subfolder names.
                   13441: 
                   13442: =cut
                   13443: 
                   13444: sub get_folder_hierarchy {
                   13445:     my ($navmap,$map,$showitem) = @_;
                   13446:     my @pathitems;
                   13447:     if (ref($navmap)) {
                   13448:         my $mapres = $navmap->getResourceByUrl($map);
                   13449:         if (ref($mapres)) {
                   13450:             my $pcslist = $mapres->map_hierarchy();
                   13451:             if ($pcslist ne '') {
                   13452:                 my @pcs = split(/,/,$pcslist);
                   13453:                 foreach my $pc (@pcs) {
                   13454:                     if ($pc == 1) {
1.1075.2.38  raeburn  13455:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  13456:                     } else {
                   13457:                         my $res = $navmap->getByMapPc($pc);
                   13458:                         if (ref($res)) {
                   13459:                             my $title = $res->compTitle();
                   13460:                             $title =~ s/\W+/_/g;
                   13461:                             if ($title ne '') {
                   13462:                                 push(@pathitems,$title);
                   13463:                             }
                   13464:                         }
                   13465:                     }
                   13466:                 }
                   13467:             }
1.1071    raeburn  13468:             if ($showitem) {
                   13469:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  13470:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  13471:                 } else {
                   13472:                     my $maptitle = $mapres->compTitle();
                   13473:                     $maptitle =~ s/\W+/_/g;
                   13474:                     if ($maptitle ne '') {
                   13475:                         push(@pathitems,$maptitle);
                   13476:                     }
1.1068    raeburn  13477:                 }
                   13478:             }
                   13479:         }
                   13480:     }
                   13481:     return @pathitems;
                   13482: }
                   13483: 
                   13484: =pod
                   13485: 
1.1015    raeburn  13486: =item * &get_turnedin_filepath()
                   13487: 
                   13488: Determines path in a user's portfolio file for storage of files uploaded
                   13489: to a specific essayresponse or dropbox item.
                   13490: 
                   13491: Inputs: 3 required + 1 optional.
                   13492: $symb is symb for resource, $uname and $udom are for current user (required).
                   13493: $caller is optional (can be "submission", if routine is called when storing
                   13494: an upoaded file when "Submit Answer" button was pressed).
                   13495: 
                   13496: Returns array containing $path and $multiresp. 
                   13497: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   13498: than one file upload item.  Callers of routine should append partid as a 
                   13499: subdirectory to $path in cases where $multiresp is 1.
                   13500: 
                   13501: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   13502: 
                   13503: =cut
                   13504: 
                   13505: sub get_turnedin_filepath {
                   13506:     my ($symb,$uname,$udom,$caller) = @_;
                   13507:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13508:     my $turnindir;
                   13509:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13510:     $turnindir = $userhash{'turnindir'};
                   13511:     my ($path,$multiresp);
                   13512:     if ($turnindir eq '') {
                   13513:         if ($caller eq 'submission') {
                   13514:             $turnindir = &mt('turned in');
                   13515:             $turnindir =~ s/\W+/_/g;
                   13516:             my %newhash = (
                   13517:                             'turnindir' => $turnindir,
                   13518:                           );
                   13519:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13520:         }
                   13521:     }
                   13522:     if ($turnindir ne '') {
                   13523:         $path = '/'.$turnindir.'/';
                   13524:         my ($multipart,$turnin,@pathitems);
                   13525:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13526:         if (defined($navmap)) {
                   13527:             my $mapres = $navmap->getResourceByUrl($map);
                   13528:             if (ref($mapres)) {
                   13529:                 my $pcslist = $mapres->map_hierarchy();
                   13530:                 if ($pcslist ne '') {
                   13531:                     foreach my $pc (split(/,/,$pcslist)) {
                   13532:                         my $res = $navmap->getByMapPc($pc);
                   13533:                         if (ref($res)) {
                   13534:                             my $title = $res->compTitle();
                   13535:                             $title =~ s/\W+/_/g;
                   13536:                             if ($title ne '') {
1.1075.2.48  raeburn  13537:                                 if (($pc > 1) && (length($title) > 12)) {
                   13538:                                     $title = substr($title,0,12);
                   13539:                                 }
1.1015    raeburn  13540:                                 push(@pathitems,$title);
                   13541:                             }
                   13542:                         }
                   13543:                     }
                   13544:                 }
                   13545:                 my $maptitle = $mapres->compTitle();
                   13546:                 $maptitle =~ s/\W+/_/g;
                   13547:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  13548:                     if (length($maptitle) > 12) {
                   13549:                         $maptitle = substr($maptitle,0,12);
                   13550:                     }
1.1015    raeburn  13551:                     push(@pathitems,$maptitle);
                   13552:                 }
                   13553:                 unless ($env{'request.state'} eq 'construct') {
                   13554:                     my $res = $navmap->getBySymb($symb);
                   13555:                     if (ref($res)) {
                   13556:                         my $partlist = $res->parts();
                   13557:                         my $totaluploads = 0;
                   13558:                         if (ref($partlist) eq 'ARRAY') {
                   13559:                             foreach my $part (@{$partlist}) {
                   13560:                                 my @types = $res->responseType($part);
                   13561:                                 my @ids = $res->responseIds($part);
                   13562:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   13563:                                     if ($types[$i] eq 'essay') {
                   13564:                                         my $partid = $part.'_'.$ids[$i];
                   13565:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   13566:                                             $totaluploads ++;
                   13567:                                         }
                   13568:                                     }
                   13569:                                 }
                   13570:                             }
                   13571:                             if ($totaluploads > 1) {
                   13572:                                 $multiresp = 1;
                   13573:                             }
                   13574:                         }
                   13575:                     }
                   13576:                 }
                   13577:             } else {
                   13578:                 return;
                   13579:             }
                   13580:         } else {
                   13581:             return;
                   13582:         }
                   13583:         my $restitle=&Apache::lonnet::gettitle($symb);
                   13584:         $restitle =~ s/\W+/_/g;
                   13585:         if ($restitle eq '') {
                   13586:             $restitle = ($resurl =~ m{/[^/]+$});
                   13587:             if ($restitle eq '') {
                   13588:                 $restitle = time;
                   13589:             }
                   13590:         }
1.1075.2.48  raeburn  13591:         if (length($restitle) > 12) {
                   13592:             $restitle = substr($restitle,0,12);
                   13593:         }
1.1015    raeburn  13594:         push(@pathitems,$restitle);
                   13595:         $path .= join('/',@pathitems);
                   13596:     }
                   13597:     return ($path,$multiresp);
                   13598: }
                   13599: 
                   13600: =pod
                   13601: 
1.464     albertel 13602: =back
1.41      ng       13603: 
1.112     bowersj2 13604: =head1 CSV Upload/Handling functions
1.38      albertel 13605: 
1.41      ng       13606: =over 4
                   13607: 
1.648     raeburn  13608: =item * &upfile_store($r)
1.41      ng       13609: 
                   13610: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 13611: needs $env{'form.upfile'}
1.41      ng       13612: returns $datatoken to be put into hidden field
                   13613: 
                   13614: =cut
1.31      albertel 13615: 
                   13616: sub upfile_store {
                   13617:     my $r=shift;
1.258     albertel 13618:     $env{'form.upfile'}=~s/\r/\n/gs;
                   13619:     $env{'form.upfile'}=~s/\f/\n/gs;
                   13620:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   13621:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 13622: 
1.1075.2.128  raeburn  13623:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   13624:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   13625:                                      time.'_'.$$);
                   13626:     return if ($datatoken eq '');
                   13627: 
1.31      albertel 13628:     {
1.158     raeburn  13629:         my $datafile = $r->dir_config('lonDaemons').
                   13630:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  13631:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 13632:             print $fh $env{'form.upfile'};
1.158     raeburn  13633:             close($fh);
                   13634:         }
1.31      albertel 13635:     }
                   13636:     return $datatoken;
                   13637: }
                   13638: 
1.56      matthew  13639: =pod
                   13640: 
1.1075.2.128  raeburn  13641: =item * &load_tmp_file($r,$datatoken)
1.41      ng       13642: 
                   13643: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  13644: $datatoken is the name to assign to the temporary file.
1.258     albertel 13645: sets $env{'form.upfile'} to the contents of the file
1.41      ng       13646: 
                   13647: =cut
1.31      albertel 13648: 
                   13649: sub load_tmp_file {
1.1075.2.128  raeburn  13650:     my ($r,$datatoken) = @_;
                   13651:     return if ($datatoken eq '');
1.31      albertel 13652:     my @studentdata=();
                   13653:     {
1.158     raeburn  13654:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  13655:                               '/tmp/'.$datatoken.'.tmp';
                   13656:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  13657:             @studentdata=<$fh>;
                   13658:             close($fh);
                   13659:         }
1.31      albertel 13660:     }
1.258     albertel 13661:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 13662: }
                   13663: 
1.1075.2.128  raeburn  13664: sub valid_datatoken {
                   13665:     my ($datatoken) = @_;
1.1075.2.131  raeburn  13666:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128  raeburn  13667:         return $datatoken;
                   13668:     }
                   13669:     return;
                   13670: }
                   13671: 
1.56      matthew  13672: =pod
                   13673: 
1.648     raeburn  13674: =item * &upfile_record_sep()
1.41      ng       13675: 
                   13676: Separate uploaded file into records
                   13677: returns array of records,
1.258     albertel 13678: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       13679: 
                   13680: =cut
1.31      albertel 13681: 
                   13682: sub upfile_record_sep {
1.258     albertel 13683:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 13684:     } else {
1.248     albertel 13685: 	my @records;
1.258     albertel 13686: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 13687: 	    if ($line=~/^\s*$/) { next; }
                   13688: 	    push(@records,$line);
                   13689: 	}
                   13690: 	return @records;
1.31      albertel 13691:     }
                   13692: }
                   13693: 
1.56      matthew  13694: =pod
                   13695: 
1.648     raeburn  13696: =item * &record_sep($record)
1.41      ng       13697: 
1.258     albertel 13698: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       13699: 
                   13700: =cut
                   13701: 
1.263     www      13702: sub takeleft {
                   13703:     my $index=shift;
                   13704:     return substr('0000'.$index,-4,4);
                   13705: }
                   13706: 
1.31      albertel 13707: sub record_sep {
                   13708:     my $record=shift;
                   13709:     my %components=();
1.258     albertel 13710:     if ($env{'form.upfiletype'} eq 'xml') {
                   13711:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 13712:         my $i=0;
1.356     albertel 13713:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 13714:             $field=~s/^(\"|\')//;
                   13715:             $field=~s/(\"|\')$//;
1.263     www      13716:             $components{&takeleft($i)}=$field;
1.31      albertel 13717:             $i++;
                   13718:         }
1.258     albertel 13719:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 13720:         my $i=0;
1.356     albertel 13721:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 13722:             $field=~s/^(\"|\')//;
                   13723:             $field=~s/(\"|\')$//;
1.263     www      13724:             $components{&takeleft($i)}=$field;
1.31      albertel 13725:             $i++;
                   13726:         }
                   13727:     } else {
1.561     www      13728:         my $separator=',';
1.480     banghart 13729:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      13730:             $separator=';';
1.480     banghart 13731:         }
1.31      albertel 13732:         my $i=0;
1.561     www      13733: # the character we are looking for to indicate the end of a quote or a record 
                   13734:         my $looking_for=$separator;
                   13735: # do not add the characters to the fields
                   13736:         my $ignore=0;
                   13737: # we just encountered a separator (or the beginning of the record)
                   13738:         my $just_found_separator=1;
                   13739: # store the field we are working on here
                   13740:         my $field='';
                   13741: # work our way through all characters in record
                   13742:         foreach my $character ($record=~/(.)/g) {
                   13743:             if ($character eq $looking_for) {
                   13744:                if ($character ne $separator) {
                   13745: # Found the end of a quote, again looking for separator
                   13746:                   $looking_for=$separator;
                   13747:                   $ignore=1;
                   13748:                } else {
                   13749: # Found a separator, store away what we got
                   13750:                   $components{&takeleft($i)}=$field;
                   13751: 	          $i++;
                   13752:                   $just_found_separator=1;
                   13753:                   $ignore=0;
                   13754:                   $field='';
                   13755:                }
                   13756:                next;
                   13757:             }
                   13758: # single or double quotation marks after a separator indicate beginning of a quote
                   13759: # we are now looking for the end of the quote and need to ignore separators
                   13760:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   13761:                $looking_for=$character;
                   13762:                next;
                   13763:             }
                   13764: # ignore would be true after we reached the end of a quote
                   13765:             if ($ignore) { next; }
                   13766:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   13767:             $field.=$character;
                   13768:             $just_found_separator=0; 
1.31      albertel 13769:         }
1.561     www      13770: # catch the very last entry, since we never encountered the separator
                   13771:         $components{&takeleft($i)}=$field;
1.31      albertel 13772:     }
                   13773:     return %components;
                   13774: }
                   13775: 
1.144     matthew  13776: ######################################################
                   13777: ######################################################
                   13778: 
1.56      matthew  13779: =pod
                   13780: 
1.648     raeburn  13781: =item * &upfile_select_html()
1.41      ng       13782: 
1.144     matthew  13783: Return HTML code to select a file from the users machine and specify 
                   13784: the file type.
1.41      ng       13785: 
                   13786: =cut
                   13787: 
1.144     matthew  13788: ######################################################
                   13789: ######################################################
1.31      albertel 13790: sub upfile_select_html {
1.144     matthew  13791:     my %Types = (
                   13792:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 13793:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  13794:                  space => &mt('Space separated'),
                   13795:                  tab   => &mt('Tabulator separated'),
                   13796: #                 xml   => &mt('HTML/XML'),
                   13797:                  );
                   13798:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  13799:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  13800:     foreach my $type (sort(keys(%Types))) {
                   13801:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   13802:     }
                   13803:     $Str .= "</select>\n";
                   13804:     return $Str;
1.31      albertel 13805: }
                   13806: 
1.301     albertel 13807: sub get_samples {
                   13808:     my ($records,$toget) = @_;
                   13809:     my @samples=({});
                   13810:     my $got=0;
                   13811:     foreach my $rec (@$records) {
                   13812: 	my %temp = &record_sep($rec);
                   13813: 	if (! grep(/\S/, values(%temp))) { next; }
                   13814: 	if (%temp) {
                   13815: 	    $samples[$got]=\%temp;
                   13816: 	    $got++;
                   13817: 	    if ($got == $toget) { last; }
                   13818: 	}
                   13819:     }
                   13820:     return \@samples;
                   13821: }
                   13822: 
1.144     matthew  13823: ######################################################
                   13824: ######################################################
                   13825: 
1.56      matthew  13826: =pod
                   13827: 
1.648     raeburn  13828: =item * &csv_print_samples($r,$records)
1.41      ng       13829: 
                   13830: Prints a table of sample values from each column uploaded $r is an
                   13831: Apache Request ref, $records is an arrayref from
                   13832: &Apache::loncommon::upfile_record_sep
                   13833: 
                   13834: =cut
                   13835: 
1.144     matthew  13836: ######################################################
                   13837: ######################################################
1.31      albertel 13838: sub csv_print_samples {
                   13839:     my ($r,$records) = @_;
1.662     bisitz   13840:     my $samples = &get_samples($records,5);
1.301     albertel 13841: 
1.594     raeburn  13842:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   13843:               &start_data_table_header_row());
1.356     albertel 13844:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   13845:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  13846:     $r->print(&end_data_table_header_row());
1.301     albertel 13847:     foreach my $hash (@$samples) {
1.594     raeburn  13848: 	$r->print(&start_data_table_row());
1.356     albertel 13849: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 13850: 	    $r->print('<td>');
1.356     albertel 13851: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 13852: 	    $r->print('</td>');
                   13853: 	}
1.594     raeburn  13854: 	$r->print(&end_data_table_row());
1.31      albertel 13855:     }
1.594     raeburn  13856:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 13857: }
                   13858: 
1.144     matthew  13859: ######################################################
                   13860: ######################################################
                   13861: 
1.56      matthew  13862: =pod
                   13863: 
1.648     raeburn  13864: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       13865: 
                   13866: Prints a table to create associations between values and table columns.
1.144     matthew  13867: 
1.41      ng       13868: $r is an Apache Request ref,
                   13869: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  13870: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       13871: 
                   13872: =cut
                   13873: 
1.144     matthew  13874: ######################################################
                   13875: ######################################################
1.31      albertel 13876: sub csv_print_select_table {
                   13877:     my ($r,$records,$d) = @_;
1.301     albertel 13878:     my $i=0;
                   13879:     my $samples = &get_samples($records,1);
1.144     matthew  13880:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  13881: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  13882:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  13883:               '<th>'.&mt('Column').'</th>'.
                   13884:               &end_data_table_header_row()."\n");
1.356     albertel 13885:     foreach my $array_ref (@$d) {
                   13886: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  13887: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 13888: 
1.875     bisitz   13889: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  13890: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 13891: 	$r->print('<option value="none"></option>');
1.356     albertel 13892: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   13893: 	    $r->print('<option value="'.$sample.'"'.
                   13894:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   13895:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 13896: 	}
1.594     raeburn  13897: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 13898: 	$i++;
                   13899:     }
1.594     raeburn  13900:     $r->print(&end_data_table());
1.31      albertel 13901:     $i--;
                   13902:     return $i;
                   13903: }
1.56      matthew  13904: 
1.144     matthew  13905: ######################################################
                   13906: ######################################################
                   13907: 
1.56      matthew  13908: =pod
1.31      albertel 13909: 
1.648     raeburn  13910: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       13911: 
                   13912: Prints a table of sample values from the upload and can make associate samples to internal names.
                   13913: 
                   13914: $r is an Apache Request ref,
                   13915: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   13916: $d is an array of 2 element arrays (internal name, displayed name)
                   13917: 
                   13918: =cut
                   13919: 
1.144     matthew  13920: ######################################################
                   13921: ######################################################
1.31      albertel 13922: sub csv_samples_select_table {
                   13923:     my ($r,$records,$d) = @_;
                   13924:     my $i=0;
1.144     matthew  13925:     #
1.662     bisitz   13926:     my $max_samples = 5;
                   13927:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  13928:     $r->print(&start_data_table().
                   13929:               &start_data_table_header_row().'<th>'.
                   13930:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   13931:               &end_data_table_header_row());
1.301     albertel 13932: 
                   13933:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  13934: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  13935: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 13936: 	foreach my $option (@$d) {
                   13937: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  13938: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 13939:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  13940:                       $display.'</option>');
1.31      albertel 13941: 	}
                   13942: 	$r->print('</select></td><td>');
1.662     bisitz   13943: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 13944: 	    if (defined($samples->[$line]{$key})) { 
                   13945: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   13946: 	    }
                   13947: 	}
1.594     raeburn  13948: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 13949: 	$i++;
                   13950:     }
1.594     raeburn  13951:     $r->print(&end_data_table());
1.31      albertel 13952:     $i--;
                   13953:     return($i);
1.115     matthew  13954: }
                   13955: 
1.144     matthew  13956: ######################################################
                   13957: ######################################################
                   13958: 
1.115     matthew  13959: =pod
                   13960: 
1.648     raeburn  13961: =item * &clean_excel_name($name)
1.115     matthew  13962: 
                   13963: Returns a replacement for $name which does not contain any illegal characters.
                   13964: 
                   13965: =cut
                   13966: 
1.144     matthew  13967: ######################################################
                   13968: ######################################################
1.115     matthew  13969: sub clean_excel_name {
                   13970:     my ($name) = @_;
                   13971:     $name =~ s/[:\*\?\/\\]//g;
                   13972:     if (length($name) > 31) {
                   13973:         $name = substr($name,0,31);
                   13974:     }
                   13975:     return $name;
1.25      albertel 13976: }
1.84      albertel 13977: 
1.85      albertel 13978: =pod
                   13979: 
1.648     raeburn  13980: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 13981: 
                   13982: Returns either 1 or undef
                   13983: 
                   13984: 1 if the part is to be hidden, undef if it is to be shown
                   13985: 
                   13986: Arguments are:
                   13987: 
                   13988: $id the id of the part to be checked
                   13989: $symb, optional the symb of the resource to check
                   13990: $udom, optional the domain of the user to check for
                   13991: $uname, optional the username of the user to check for
                   13992: 
                   13993: =cut
1.84      albertel 13994: 
                   13995: sub check_if_partid_hidden {
                   13996:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 13997:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 13998: 					 $symb,$udom,$uname);
1.141     albertel 13999:     my $truth=1;
                   14000:     #if the string starts with !, then the list is the list to show not hide
                   14001:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 14002:     my @hiddenlist=split(/,/,$hiddenparts);
                   14003:     foreach my $checkid (@hiddenlist) {
1.141     albertel 14004: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 14005:     }
1.141     albertel 14006:     return !$truth;
1.84      albertel 14007: }
1.127     matthew  14008: 
1.138     matthew  14009: 
                   14010: ############################################################
                   14011: ############################################################
                   14012: 
                   14013: =pod
                   14014: 
1.157     matthew  14015: =back 
                   14016: 
1.138     matthew  14017: =head1 cgi-bin script and graphing routines
                   14018: 
1.157     matthew  14019: =over 4
                   14020: 
1.648     raeburn  14021: =item * &get_cgi_id()
1.138     matthew  14022: 
                   14023: Inputs: none
                   14024: 
                   14025: Returns an id which can be used to pass environment variables
                   14026: to various cgi-bin scripts.  These environment variables will
                   14027: be removed from the users environment after a given time by
                   14028: the routine &Apache::lonnet::transfer_profile_to_env.
                   14029: 
                   14030: =cut
                   14031: 
                   14032: ############################################################
                   14033: ############################################################
1.152     albertel 14034: my $uniq=0;
1.136     matthew  14035: sub get_cgi_id {
1.154     albertel 14036:     $uniq=($uniq+1)%100000;
1.280     albertel 14037:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  14038: }
                   14039: 
1.127     matthew  14040: ############################################################
                   14041: ############################################################
                   14042: 
                   14043: =pod
                   14044: 
1.648     raeburn  14045: =item * &DrawBarGraph()
1.127     matthew  14046: 
1.138     matthew  14047: Facilitates the plotting of data in a (stacked) bar graph.
                   14048: Puts plot definition data into the users environment in order for 
                   14049: graph.png to plot it.  Returns an <img> tag for the plot.
                   14050: The bars on the plot are labeled '1','2',...,'n'.
                   14051: 
                   14052: Inputs:
                   14053: 
                   14054: =over 4
                   14055: 
                   14056: =item $Title: string, the title of the plot
                   14057: 
                   14058: =item $xlabel: string, text describing the X-axis of the plot
                   14059: 
                   14060: =item $ylabel: string, text describing the Y-axis of the plot
                   14061: 
                   14062: =item $Max: scalar, the maximum Y value to use in the plot
                   14063: If $Max is < any data point, the graph will not be rendered.
                   14064: 
1.140     matthew  14065: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  14066: they are plotted.  If undefined, default values will be used.
                   14067: 
1.178     matthew  14068: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   14069: 
1.138     matthew  14070: =item @Values: An array of array references.  Each array reference holds data
                   14071: to be plotted in a stacked bar chart.
                   14072: 
1.239     matthew  14073: =item If the final element of @Values is a hash reference the key/value
                   14074: pairs will be added to the graph definition.
                   14075: 
1.138     matthew  14076: =back
                   14077: 
                   14078: Returns:
                   14079: 
                   14080: An <img> tag which references graph.png and the appropriate identifying
                   14081: information for the plot.
                   14082: 
1.127     matthew  14083: =cut
                   14084: 
                   14085: ############################################################
                   14086: ############################################################
1.134     matthew  14087: sub DrawBarGraph {
1.178     matthew  14088:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  14089:     #
                   14090:     if (! defined($colors)) {
                   14091:         $colors = ['#33ff00', 
                   14092:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   14093:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   14094:                   ]; 
                   14095:     }
1.228     matthew  14096:     my $extra_settings = {};
                   14097:     if (ref($Values[-1]) eq 'HASH') {
                   14098:         $extra_settings = pop(@Values);
                   14099:     }
1.127     matthew  14100:     #
1.136     matthew  14101:     my $identifier = &get_cgi_id();
                   14102:     my $id = 'cgi.'.$identifier;        
1.129     matthew  14103:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  14104:         return '';
                   14105:     }
1.225     matthew  14106:     #
                   14107:     my @Labels;
                   14108:     if (defined($labels)) {
                   14109:         @Labels = @$labels;
                   14110:     } else {
                   14111:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  14112:             push(@Labels,$i+1);
1.225     matthew  14113:         }
                   14114:     }
                   14115:     #
1.129     matthew  14116:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  14117:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  14118:     my %ValuesHash;
                   14119:     my $NumSets=1;
                   14120:     foreach my $array (@Values) {
                   14121:         next if (! ref($array));
1.136     matthew  14122:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  14123:             join(',',@$array);
1.129     matthew  14124:     }
1.127     matthew  14125:     #
1.136     matthew  14126:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  14127:     if ($NumBars < 3) {
                   14128:         $width = 120+$NumBars*32;
1.220     matthew  14129:         $xskip = 1;
1.225     matthew  14130:         $bar_width = 30;
                   14131:     } elsif ($NumBars < 5) {
                   14132:         $width = 120+$NumBars*20;
                   14133:         $xskip = 1;
                   14134:         $bar_width = 20;
1.220     matthew  14135:     } elsif ($NumBars < 10) {
1.136     matthew  14136:         $width = 120+$NumBars*15;
                   14137:         $xskip = 1;
                   14138:         $bar_width = 15;
                   14139:     } elsif ($NumBars <= 25) {
                   14140:         $width = 120+$NumBars*11;
                   14141:         $xskip = 5;
                   14142:         $bar_width = 8;
                   14143:     } elsif ($NumBars <= 50) {
                   14144:         $width = 120+$NumBars*8;
                   14145:         $xskip = 5;
                   14146:         $bar_width = 4;
                   14147:     } else {
                   14148:         $width = 120+$NumBars*8;
                   14149:         $xskip = 5;
                   14150:         $bar_width = 4;
                   14151:     }
                   14152:     #
1.137     matthew  14153:     $Max = 1 if ($Max < 1);
                   14154:     if ( int($Max) < $Max ) {
                   14155:         $Max++;
                   14156:         $Max = int($Max);
                   14157:     }
1.127     matthew  14158:     $Title  = '' if (! defined($Title));
                   14159:     $xlabel = '' if (! defined($xlabel));
                   14160:     $ylabel = '' if (! defined($ylabel));
1.369     www      14161:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   14162:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   14163:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  14164:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  14165:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   14166:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   14167:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   14168:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14169:     $ValuesHash{$id.'.height'}   = $height;
                   14170:     $ValuesHash{$id.'.width'}    = $width;
                   14171:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   14172:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   14173:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  14174:     #
1.228     matthew  14175:     # Deal with other parameters
                   14176:     while (my ($key,$value) = each(%$extra_settings)) {
                   14177:         $ValuesHash{$id.'.'.$key} = $value;
                   14178:     }
                   14179:     #
1.646     raeburn  14180:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  14181:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14182: }
                   14183: 
                   14184: ############################################################
                   14185: ############################################################
                   14186: 
                   14187: =pod
                   14188: 
1.648     raeburn  14189: =item * &DrawXYGraph()
1.137     matthew  14190: 
1.138     matthew  14191: Facilitates the plotting of data in an XY graph.
                   14192: Puts plot definition data into the users environment in order for 
                   14193: graph.png to plot it.  Returns an <img> tag for the plot.
                   14194: 
                   14195: Inputs:
                   14196: 
                   14197: =over 4
                   14198: 
                   14199: =item $Title: string, the title of the plot
                   14200: 
                   14201: =item $xlabel: string, text describing the X-axis of the plot
                   14202: 
                   14203: =item $ylabel: string, text describing the Y-axis of the plot
                   14204: 
                   14205: =item $Max: scalar, the maximum Y value to use in the plot
                   14206: If $Max is < any data point, the graph will not be rendered.
                   14207: 
                   14208: =item $colors: Array ref containing the hex color codes for the data to be 
                   14209: plotted in.  If undefined, default values will be used.
                   14210: 
                   14211: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14212: 
                   14213: =item $Ydata: Array ref containing Array refs.  
1.185     www      14214: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  14215: 
                   14216: =item %Values: hash indicating or overriding any default values which are 
                   14217: passed to graph.png.  
                   14218: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14219: 
                   14220: =back
                   14221: 
                   14222: Returns:
                   14223: 
                   14224: An <img> tag which references graph.png and the appropriate identifying
                   14225: information for the plot.
                   14226: 
1.137     matthew  14227: =cut
                   14228: 
                   14229: ############################################################
                   14230: ############################################################
                   14231: sub DrawXYGraph {
                   14232:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   14233:     #
                   14234:     # Create the identifier for the graph
                   14235:     my $identifier = &get_cgi_id();
                   14236:     my $id = 'cgi.'.$identifier;
                   14237:     #
                   14238:     $Title  = '' if (! defined($Title));
                   14239:     $xlabel = '' if (! defined($xlabel));
                   14240:     $ylabel = '' if (! defined($ylabel));
                   14241:     my %ValuesHash = 
                   14242:         (
1.369     www      14243:          $id.'.title'  => &escape($Title),
                   14244:          $id.'.xlabel' => &escape($xlabel),
                   14245:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  14246:          $id.'.y_max_value'=> $Max,
                   14247:          $id.'.labels'     => join(',',@$Xlabels),
                   14248:          $id.'.PlotType'   => 'XY',
                   14249:          );
                   14250:     #
                   14251:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14252:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14253:     }
                   14254:     #
                   14255:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   14256:         return '';
                   14257:     }
                   14258:     my $NumSets=1;
1.138     matthew  14259:     foreach my $array (@{$Ydata}){
1.137     matthew  14260:         next if (! ref($array));
                   14261:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   14262:     }
1.138     matthew  14263:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  14264:     #
                   14265:     # Deal with other parameters
                   14266:     while (my ($key,$value) = each(%Values)) {
                   14267:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  14268:     }
                   14269:     #
1.646     raeburn  14270:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  14271:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14272: }
                   14273: 
                   14274: ############################################################
                   14275: ############################################################
                   14276: 
                   14277: =pod
                   14278: 
1.648     raeburn  14279: =item * &DrawXYYGraph()
1.138     matthew  14280: 
                   14281: Facilitates the plotting of data in an XY graph with two Y axes.
                   14282: Puts plot definition data into the users environment in order for 
                   14283: graph.png to plot it.  Returns an <img> tag for the plot.
                   14284: 
                   14285: Inputs:
                   14286: 
                   14287: =over 4
                   14288: 
                   14289: =item $Title: string, the title of the plot
                   14290: 
                   14291: =item $xlabel: string, text describing the X-axis of the plot
                   14292: 
                   14293: =item $ylabel: string, text describing the Y-axis of the plot
                   14294: 
                   14295: =item $colors: Array ref containing the hex color codes for the data to be 
                   14296: plotted in.  If undefined, default values will be used.
                   14297: 
                   14298: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14299: 
                   14300: =item $Ydata1: The first data set
                   14301: 
                   14302: =item $Min1: The minimum value of the left Y-axis
                   14303: 
                   14304: =item $Max1: The maximum value of the left Y-axis
                   14305: 
                   14306: =item $Ydata2: The second data set
                   14307: 
                   14308: =item $Min2: The minimum value of the right Y-axis
                   14309: 
                   14310: =item $Max2: The maximum value of the left Y-axis
                   14311: 
                   14312: =item %Values: hash indicating or overriding any default values which are 
                   14313: passed to graph.png.  
                   14314: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14315: 
                   14316: =back
                   14317: 
                   14318: Returns:
                   14319: 
                   14320: An <img> tag which references graph.png and the appropriate identifying
                   14321: information for the plot.
1.136     matthew  14322: 
                   14323: =cut
                   14324: 
                   14325: ############################################################
                   14326: ############################################################
1.137     matthew  14327: sub DrawXYYGraph {
                   14328:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   14329:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  14330:     #
                   14331:     # Create the identifier for the graph
                   14332:     my $identifier = &get_cgi_id();
                   14333:     my $id = 'cgi.'.$identifier;
                   14334:     #
                   14335:     $Title  = '' if (! defined($Title));
                   14336:     $xlabel = '' if (! defined($xlabel));
                   14337:     $ylabel = '' if (! defined($ylabel));
                   14338:     my %ValuesHash = 
                   14339:         (
1.369     www      14340:          $id.'.title'  => &escape($Title),
                   14341:          $id.'.xlabel' => &escape($xlabel),
                   14342:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  14343:          $id.'.labels' => join(',',@$Xlabels),
                   14344:          $id.'.PlotType' => 'XY',
                   14345:          $id.'.NumSets' => 2,
1.137     matthew  14346:          $id.'.two_axes' => 1,
                   14347:          $id.'.y1_max_value' => $Max1,
                   14348:          $id.'.y1_min_value' => $Min1,
                   14349:          $id.'.y2_max_value' => $Max2,
                   14350:          $id.'.y2_min_value' => $Min2,
1.136     matthew  14351:          );
                   14352:     #
1.137     matthew  14353:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14354:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14355:     }
                   14356:     #
                   14357:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   14358:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  14359:         return '';
                   14360:     }
                   14361:     my $NumSets=1;
1.137     matthew  14362:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  14363:         next if (! ref($array));
                   14364:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  14365:     }
                   14366:     #
                   14367:     # Deal with other parameters
                   14368:     while (my ($key,$value) = each(%Values)) {
                   14369:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  14370:     }
                   14371:     #
1.646     raeburn  14372:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 14373:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  14374: }
                   14375: 
                   14376: ############################################################
                   14377: ############################################################
                   14378: 
                   14379: =pod
                   14380: 
1.157     matthew  14381: =back 
                   14382: 
1.139     matthew  14383: =head1 Statistics helper routines?  
                   14384: 
                   14385: Bad place for them but what the hell.
                   14386: 
1.157     matthew  14387: =over 4
                   14388: 
1.648     raeburn  14389: =item * &chartlink()
1.139     matthew  14390: 
                   14391: Returns a link to the chart for a specific student.  
                   14392: 
                   14393: Inputs:
                   14394: 
                   14395: =over 4
                   14396: 
                   14397: =item $linktext: The text of the link
                   14398: 
                   14399: =item $sname: The students username
                   14400: 
                   14401: =item $sdomain: The students domain
                   14402: 
                   14403: =back
                   14404: 
1.157     matthew  14405: =back
                   14406: 
1.139     matthew  14407: =cut
                   14408: 
                   14409: ############################################################
                   14410: ############################################################
                   14411: sub chartlink {
                   14412:     my ($linktext, $sname, $sdomain) = @_;
                   14413:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      14414:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 14415:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  14416:        '">'.$linktext.'</a>';
1.153     matthew  14417: }
                   14418: 
                   14419: #######################################################
                   14420: #######################################################
                   14421: 
                   14422: =pod
                   14423: 
                   14424: =head1 Course Environment Routines
1.157     matthew  14425: 
                   14426: =over 4
1.153     matthew  14427: 
1.648     raeburn  14428: =item * &restore_course_settings()
1.153     matthew  14429: 
1.648     raeburn  14430: =item * &store_course_settings()
1.153     matthew  14431: 
                   14432: Restores/Store indicated form parameters from the course environment.
                   14433: Will not overwrite existing values of the form parameters.
                   14434: 
                   14435: Inputs: 
                   14436: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   14437: 
                   14438: a hash ref describing the data to be stored.  For example:
                   14439:    
                   14440: %Save_Parameters = ('Status' => 'scalar',
                   14441:     'chartoutputmode' => 'scalar',
                   14442:     'chartoutputdata' => 'scalar',
                   14443:     'Section' => 'array',
1.373     raeburn  14444:     'Group' => 'array',
1.153     matthew  14445:     'StudentData' => 'array',
                   14446:     'Maps' => 'array');
                   14447: 
                   14448: Returns: both routines return nothing
                   14449: 
1.631     raeburn  14450: =back
                   14451: 
1.153     matthew  14452: =cut
                   14453: 
                   14454: #######################################################
                   14455: #######################################################
                   14456: sub store_course_settings {
1.496     albertel 14457:     return &store_settings($env{'request.course.id'},@_);
                   14458: }
                   14459: 
                   14460: sub store_settings {
1.153     matthew  14461:     # save to the environment
                   14462:     # appenv the same items, just to be safe
1.300     albertel 14463:     my $udom  = $env{'user.domain'};
                   14464:     my $uname = $env{'user.name'};
1.496     albertel 14465:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14466:     my %SaveHash;
                   14467:     my %AppHash;
                   14468:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 14469:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 14470:         my $envname = 'environment.'.$basename;
1.258     albertel 14471:         if (exists($env{'form.'.$setting})) {
1.153     matthew  14472:             # Save this value away
                   14473:             if ($type eq 'scalar' &&
1.258     albertel 14474:                 (! exists($env{$envname}) || 
                   14475:                  $env{$envname} ne $env{'form.'.$setting})) {
                   14476:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   14477:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  14478:             } elsif ($type eq 'array') {
                   14479:                 my $stored_form;
1.258     albertel 14480:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  14481:                     $stored_form = join(',',
                   14482:                                         map {
1.369     www      14483:                                             &escape($_);
1.258     albertel 14484:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  14485:                 } else {
                   14486:                     $stored_form = 
1.369     www      14487:                         &escape($env{'form.'.$setting});
1.153     matthew  14488:                 }
                   14489:                 # Determine if the array contents are the same.
1.258     albertel 14490:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  14491:                     $SaveHash{$basename} = $stored_form;
                   14492:                     $AppHash{$envname}   = $stored_form;
                   14493:                 }
                   14494:             }
                   14495:         }
                   14496:     }
                   14497:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 14498:                                           $udom,$uname);
1.153     matthew  14499:     if ($put_result !~ /^(ok|delayed)/) {
                   14500:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   14501:                                  'got error:'.$put_result);
                   14502:     }
                   14503:     # Make sure these settings stick around in this session, too
1.646     raeburn  14504:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  14505:     return;
                   14506: }
                   14507: 
                   14508: sub restore_course_settings {
1.499     albertel 14509:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14510: }
                   14511: 
                   14512: sub restore_settings {
                   14513:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14514:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14515:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14516:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14517:             '.'.$setting;
1.258     albertel 14518:         if (exists($env{$envname})) {
1.153     matthew  14519:             if ($type eq 'scalar') {
1.258     albertel 14520:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14521:             } elsif ($type eq 'array') {
1.258     albertel 14522:                 $env{'form.'.$setting} = [ 
1.153     matthew  14523:                                            map { 
1.369     www      14524:                                                &unescape($_); 
1.258     albertel 14525:                                            } split(',',$env{$envname})
1.153     matthew  14526:                                            ];
                   14527:             }
                   14528:         }
                   14529:     }
1.127     matthew  14530: }
                   14531: 
1.618     raeburn  14532: #######################################################
                   14533: #######################################################
                   14534: 
                   14535: =pod
                   14536: 
                   14537: =head1 Domain E-mail Routines  
                   14538: 
                   14539: =over 4
                   14540: 
1.648     raeburn  14541: =item * &build_recipient_list()
1.618     raeburn  14542: 
1.1075.2.44  raeburn  14543: Build recipient lists for following types of e-mail:
1.766     raeburn  14544: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  14545: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   14546: module change checking, student/employee ID conflict checks, as
                   14547: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   14548: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  14549: 
                   14550: Inputs:
1.1075.2.44  raeburn  14551: defmail (scalar - email address of default recipient),
                   14552: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   14553: requestsmail, updatesmail, or idconflictsmail).
                   14554: 
1.619     raeburn  14555: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  14556: 
                   14557: origmail (scalar - email address of recipient from loncapa.conf,
                   14558: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  14559: 
1.1075.2.139  raeburn  14560: $requname username of requester (if mailing type is helpdeskmail)
                   14561: 
                   14562: $requdom domain of requester (if mailing type is helpdeskmail)
                   14563: 
                   14564: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   14565: 
1.655     raeburn  14566: Returns: comma separated list of addresses to which to send e-mail.
                   14567: 
                   14568: =back
1.618     raeburn  14569: 
                   14570: =cut
                   14571: 
                   14572: ############################################################
                   14573: ############################################################
                   14574: sub build_recipient_list {
1.1075.2.139  raeburn  14575:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  14576:     my @recipients;
1.1075.2.122  raeburn  14577:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  14578:     my %domconfig =
1.1075.2.122  raeburn  14579:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  14580:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  14581:         if (exists($domconfig{'contacts'}{$mailing})) {
                   14582:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   14583:                 my @contacts = ('adminemail','supportemail');
                   14584:                 foreach my $item (@contacts) {
                   14585:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   14586:                         my $addr = $domconfig{'contacts'}{$item}; 
                   14587:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14588:                             push(@recipients,$addr);
                   14589:                         }
1.619     raeburn  14590:                     }
1.1075.2.122  raeburn  14591:                 }
                   14592:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   14593:                 if ($mailing eq 'helpdeskmail') {
                   14594:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   14595:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   14596:                         my @ok_bccs;
                   14597:                         foreach my $bcc (@bccs) {
                   14598:                             $bcc =~ s/^\s+//g;
                   14599:                             $bcc =~ s/\s+$//g;
                   14600:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14601:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14602:                                     push(@ok_bccs,$bcc);
                   14603:                                 }
                   14604:                             }
                   14605:                         }
                   14606:                         if (@ok_bccs > 0) {
                   14607:                             $allbcc = join(', ',@ok_bccs);
                   14608:                         }
                   14609:                     }
                   14610:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  14611:                 }
                   14612:             }
1.766     raeburn  14613:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14614:             $lastresort = $origmail;
1.618     raeburn  14615:         }
1.1075.2.139  raeburn  14616:         if ($mailing eq 'helpdeskmail') {
                   14617:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   14618:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   14619:                 my ($inststatus,$inststatus_checked);
                   14620:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   14621:                     ($env{'user.domain'} ne 'public')) {
                   14622:                     $inststatus_checked = 1;
                   14623:                     $inststatus = $env{'environment.inststatus'};
                   14624:                 }
                   14625:                 unless ($inststatus_checked) {
                   14626:                     if (($requname ne '') && ($requdom ne '')) {
                   14627:                         if (($requname =~ /^$match_username$/) &&
                   14628:                             ($requdom =~ /^$match_domain$/) &&
                   14629:                             (&Apache::lonnet::domain($requdom))) {
                   14630:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   14631:                                                                       $requdom);
                   14632:                             unless ($requhome eq 'no_host') {
                   14633:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   14634:                                 $inststatus = $userenv{'inststatus'};
                   14635:                                 $inststatus_checked = 1;
                   14636:                             }
                   14637:                         }
                   14638:                     }
                   14639:                 }
                   14640:                 unless ($inststatus_checked) {
                   14641:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   14642:                         my %srch = (srchby     => 'email',
                   14643:                                     srchdomain => $defdom,
                   14644:                                     srchterm   => $reqemail,
                   14645:                                     srchtype   => 'exact');
                   14646:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   14647:                         foreach my $uname (keys(%srch_results)) {
                   14648:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14649:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14650:                                 $inststatus_checked = 1;
                   14651:                                 last;
                   14652:                             }
                   14653:                         }
                   14654:                         unless ($inststatus_checked) {
                   14655:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   14656:                             if ($dirsrchres eq 'ok') {
                   14657:                                 foreach my $uname (keys(%srch_results)) {
                   14658:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14659:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14660:                                         $inststatus_checked = 1;
                   14661:                                         last;
                   14662:                                     }
                   14663:                                 }
                   14664:                             }
                   14665:                         }
                   14666:                     }
                   14667:                 }
                   14668:                 if ($inststatus ne '') {
                   14669:                     foreach my $status (split(/\:/,$inststatus)) {
                   14670:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   14671:                             my @contacts = ('adminemail','supportemail');
                   14672:                             foreach my $item (@contacts) {
                   14673:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   14674:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   14675:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14676:                                         push(@recipients,$addr);
                   14677:                                     }
                   14678:                                 }
                   14679:                             }
                   14680:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   14681:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   14682:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   14683:                                 my @ok_bccs;
                   14684:                                 foreach my $bcc (@bccs) {
                   14685:                                     $bcc =~ s/^\s+//g;
                   14686:                                     $bcc =~ s/\s+$//g;
                   14687:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14688:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14689:                                             push(@ok_bccs,$bcc);
                   14690:                                         }
                   14691:                                     }
                   14692:                                 }
                   14693:                                 if (@ok_bccs > 0) {
                   14694:                                     $allbcc = join(', ',@ok_bccs);
                   14695:                                 }
                   14696:                             }
                   14697:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   14698:                             last;
                   14699:                         }
                   14700:                     }
                   14701:                 }
                   14702:             }
                   14703:         }
1.619     raeburn  14704:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14705:         $lastresort = $origmail;
                   14706:     }
1.1075.2.128  raeburn  14707:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  14708:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   14709:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   14710:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   14711:             my %what = (
                   14712:                           perlvar => 1,
                   14713:                        );
                   14714:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   14715:             if ($primary) {
                   14716:                 my $gotaddr;
                   14717:                 my ($result,$returnhash) =
                   14718:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   14719:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   14720:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   14721:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   14722:                         $gotaddr = 1;
                   14723:                     }
                   14724:                 }
                   14725:                 unless ($gotaddr) {
                   14726:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   14727:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   14728:                     unless ($uintdom eq $intdom) {
                   14729:                         my %domconfig =
                   14730:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   14731:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   14732:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   14733:                                 my @contacts = ('adminemail','supportemail');
                   14734:                                 foreach my $item (@contacts) {
                   14735:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   14736:                                         my $addr = $domconfig{'contacts'}{$item};
                   14737:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14738:                                             push(@recipients,$addr);
                   14739:                                         }
                   14740:                                     }
                   14741:                                 }
                   14742:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   14743:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   14744:                                 }
                   14745:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   14746:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   14747:                                     my @ok_bccs;
                   14748:                                     foreach my $bcc (@bccs) {
                   14749:                                         $bcc =~ s/^\s+//g;
                   14750:                                         $bcc =~ s/\s+$//g;
                   14751:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14752:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14753:                                                 push(@ok_bccs,$bcc);
                   14754:                                             }
                   14755:                                         }
                   14756:                                     }
                   14757:                                     if (@ok_bccs > 0) {
                   14758:                                         $allbcc = join(', ',@ok_bccs);
                   14759:                                     }
                   14760:                                 }
                   14761:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   14762:                             }
                   14763:                         }
                   14764:                     }
                   14765:                 }
                   14766:             }
                   14767:         }
1.618     raeburn  14768:     }
1.688     raeburn  14769:     if (defined($defmail)) {
                   14770:         if ($defmail ne '') {
                   14771:             push(@recipients,$defmail);
                   14772:         }
1.618     raeburn  14773:     }
                   14774:     if ($otheremails) {
1.619     raeburn  14775:         my @others;
                   14776:         if ($otheremails =~ /,/) {
                   14777:             @others = split(/,/,$otheremails);
1.618     raeburn  14778:         } else {
1.619     raeburn  14779:             push(@others,$otheremails);
                   14780:         }
                   14781:         foreach my $addr (@others) {
                   14782:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14783:                 push(@recipients,$addr);
                   14784:             }
1.618     raeburn  14785:         }
                   14786:     }
1.1075.2.128  raeburn  14787:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  14788:         if ((!@recipients) && ($lastresort ne '')) {
                   14789:             push(@recipients,$lastresort);
                   14790:         }
                   14791:     } elsif ($lastresort ne '') {
                   14792:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   14793:             push(@recipients,$lastresort);
                   14794:         }
                   14795:     }
                   14796:     my $recipientlist = join(',',@recipients);
                   14797:     if (wantarray) {
                   14798:         return ($recipientlist,$allbcc,$addtext);
                   14799:     } else {
                   14800:         return $recipientlist;
                   14801:     }
1.618     raeburn  14802: }
                   14803: 
1.127     matthew  14804: ############################################################
                   14805: ############################################################
1.154     albertel 14806: 
1.655     raeburn  14807: =pod
                   14808: 
                   14809: =head1 Course Catalog Routines
                   14810: 
                   14811: =over 4
                   14812: 
                   14813: =item * &gather_categories()
                   14814: 
                   14815: Converts category definitions - keys of categories hash stored in  
                   14816: coursecategories in configuration.db on the primary library server in a 
                   14817: domain - to an array.  Also generates javascript and idx hash used to 
                   14818: generate Domain Coordinator interface for editing Course Categories.
                   14819: 
                   14820: Inputs:
1.663     raeburn  14821: 
1.655     raeburn  14822: categories (reference to hash of category definitions).
1.663     raeburn  14823: 
1.655     raeburn  14824: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14825:       categories and subcategories).
1.663     raeburn  14826: 
1.655     raeburn  14827: idx (reference to hash of counters used in Domain Coordinator interface for 
                   14828:       editing Course Categories).
1.663     raeburn  14829: 
1.655     raeburn  14830: jsarray (reference to array of categories used to create Javascript arrays for
                   14831:          Domain Coordinator interface for editing Course Categories).
                   14832: 
                   14833: Returns: nothing
                   14834: 
                   14835: Side effects: populates cats, idx and jsarray. 
                   14836: 
                   14837: =cut
                   14838: 
                   14839: sub gather_categories {
                   14840:     my ($categories,$cats,$idx,$jsarray) = @_;
                   14841:     my %counters;
                   14842:     my $num = 0;
                   14843:     foreach my $item (keys(%{$categories})) {
                   14844:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   14845:         if ($container eq '' && $depth == 0) {
                   14846:             $cats->[$depth][$categories->{$item}] = $cat;
                   14847:         } else {
                   14848:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   14849:         }
                   14850:         my ($escitem,$tail) = split(/:/,$item,2);
                   14851:         if ($counters{$tail} eq '') {
                   14852:             $counters{$tail} = $num;
                   14853:             $num ++;
                   14854:         }
                   14855:         if (ref($idx) eq 'HASH') {
                   14856:             $idx->{$item} = $counters{$tail};
                   14857:         }
                   14858:         if (ref($jsarray) eq 'ARRAY') {
                   14859:             push(@{$jsarray->[$counters{$tail}]},$item);
                   14860:         }
                   14861:     }
                   14862:     return;
                   14863: }
                   14864: 
                   14865: =pod
                   14866: 
                   14867: =item * &extract_categories()
                   14868: 
                   14869: Used to generate breadcrumb trails for course categories.
                   14870: 
                   14871: Inputs:
1.663     raeburn  14872: 
1.655     raeburn  14873: categories (reference to hash of category definitions).
1.663     raeburn  14874: 
1.655     raeburn  14875: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14876:       categories and subcategories).
1.663     raeburn  14877: 
1.655     raeburn  14878: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  14879: 
1.655     raeburn  14880: allitems (reference to hash - key is category key 
                   14881:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14882: 
1.655     raeburn  14883: idx (reference to hash of counters used in Domain Coordinator interface for
                   14884:       editing Course Categories).
1.663     raeburn  14885: 
1.655     raeburn  14886: jsarray (reference to array of categories used to create Javascript arrays for
                   14887:          Domain Coordinator interface for editing Course Categories).
                   14888: 
1.665     raeburn  14889: subcats (reference to hash of arrays containing all subcategories within each 
                   14890:          category, -recursive)
                   14891: 
1.1075.2.132  raeburn  14892: maxd (reference to hash used to hold max depth for all top-level categories).
                   14893: 
1.655     raeburn  14894: Returns: nothing
                   14895: 
                   14896: Side effects: populates trails and allitems hash references.
                   14897: 
                   14898: =cut
                   14899: 
                   14900: sub extract_categories {
1.1075.2.132  raeburn  14901:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  14902:     if (ref($categories) eq 'HASH') {
                   14903:         &gather_categories($categories,$cats,$idx,$jsarray);
                   14904:         if (ref($cats->[0]) eq 'ARRAY') {
                   14905:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   14906:                 my $name = $cats->[0][$i];
                   14907:                 my $item = &escape($name).'::0';
                   14908:                 my $trailstr;
                   14909:                 if ($name eq 'instcode') {
                   14910:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  14911:                 } elsif ($name eq 'communities') {
                   14912:                     $trailstr = &mt('Communities');
1.655     raeburn  14913:                 } else {
                   14914:                     $trailstr = $name;
                   14915:                 }
                   14916:                 if ($allitems->{$item} eq '') {
                   14917:                     push(@{$trails},$trailstr);
                   14918:                     $allitems->{$item} = scalar(@{$trails})-1;
                   14919:                 }
                   14920:                 my @parents = ($name);
                   14921:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   14922:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   14923:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  14924:                         if (ref($subcats) eq 'HASH') {
                   14925:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   14926:                         }
1.1075.2.132  raeburn  14927:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  14928:                     }
                   14929:                 } else {
                   14930:                     if (ref($subcats) eq 'HASH') {
                   14931:                         $subcats->{$item} = [];
1.655     raeburn  14932:                     }
1.1075.2.132  raeburn  14933:                     if (ref($maxd) eq 'HASH') {
                   14934:                         $maxd->{$name} = 1;
                   14935:                     }
1.655     raeburn  14936:                 }
                   14937:             }
                   14938:         }
                   14939:     }
                   14940:     return;
                   14941: }
                   14942: 
                   14943: =pod
                   14944: 
1.1075.2.56  raeburn  14945: =item * &recurse_categories()
1.655     raeburn  14946: 
                   14947: Recursively used to generate breadcrumb trails for course categories.
                   14948: 
                   14949: Inputs:
1.663     raeburn  14950: 
1.655     raeburn  14951: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14952:       categories and subcategories).
1.663     raeburn  14953: 
1.655     raeburn  14954: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  14955: 
                   14956: category (current course category, for which breadcrumb trail is being generated).
                   14957: 
                   14958: trails (reference to array of breadcrumb trails for each category).
                   14959: 
1.655     raeburn  14960: allitems (reference to hash - key is category key
                   14961:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14962: 
1.655     raeburn  14963: parents (array containing containers directories for current category, 
                   14964:          back to top level). 
                   14965: 
                   14966: Returns: nothing
                   14967: 
                   14968: Side effects: populates trails and allitems hash references
                   14969: 
                   14970: =cut
                   14971: 
                   14972: sub recurse_categories {
1.1075.2.132  raeburn  14973:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  14974:     my $shallower = $depth - 1;
                   14975:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   14976:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   14977:             my $name = $cats->[$depth]{$category}[$k];
                   14978:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.164  raeburn  14979:             my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  14980:             if ($allitems->{$item} eq '') {
                   14981:                 push(@{$trails},$trailstr);
                   14982:                 $allitems->{$item} = scalar(@{$trails})-1;
                   14983:             }
                   14984:             my $deeper = $depth+1;
                   14985:             push(@{$parents},$category);
1.665     raeburn  14986:             if (ref($subcats) eq 'HASH') {
                   14987:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   14988:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   14989:                     my $higher;
                   14990:                     if ($j > 0) {
                   14991:                         $higher = &escape($parents->[$j]).':'.
                   14992:                                   &escape($parents->[$j-1]).':'.$j;
                   14993:                     } else {
                   14994:                         $higher = &escape($parents->[$j]).'::'.$j;
                   14995:                     }
                   14996:                     push(@{$subcats->{$higher}},$subcat);
                   14997:                 }
                   14998:             }
                   14999:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132  raeburn  15000:                                 $subcats,$maxd);
1.655     raeburn  15001:             pop(@{$parents});
                   15002:         }
                   15003:     } else {
                   15004:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132  raeburn  15005:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  15006:         if ($allitems->{$item} eq '') {
                   15007:             push(@{$trails},$trailstr);
                   15008:             $allitems->{$item} = scalar(@{$trails})-1;
                   15009:         }
1.1075.2.132  raeburn  15010:         if (ref($maxd) eq 'HASH') {
                   15011:             if ($depth > $maxd->{$parents->[0]}) {
                   15012:                 $maxd->{$parents->[0]} = $depth;
                   15013:             }
                   15014:         }
1.655     raeburn  15015:     }
                   15016:     return;
                   15017: }
                   15018: 
1.663     raeburn  15019: =pod
                   15020: 
1.1075.2.56  raeburn  15021: =item * &assign_categories_table()
1.663     raeburn  15022: 
                   15023: Create a datatable for display of hierarchical categories in a domain,
                   15024: with checkboxes to allow a course to be categorized. 
                   15025: 
                   15026: Inputs:
                   15027: 
                   15028: cathash - reference to hash of categories defined for the domain (from
                   15029:           configuration.db)
                   15030: 
                   15031: currcat - scalar with an & separated list of categories assigned to a course. 
                   15032: 
1.919     raeburn  15033: type    - scalar contains course type (Course or Community).
                   15034: 
1.1075.2.117  raeburn  15035: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15036:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15037: 
1.663     raeburn  15038: Returns: $output (markup to be displayed) 
                   15039: 
                   15040: =cut
                   15041: 
                   15042: sub assign_categories_table {
1.1075.2.117  raeburn  15043:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  15044:     my $output;
                   15045:     if (ref($cathash) eq 'HASH') {
1.1075.2.132  raeburn  15046:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   15047:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  15048:         $maxdepth = scalar(@cats);
                   15049:         if (@cats > 0) {
                   15050:             my $itemcount = 0;
                   15051:             if (ref($cats[0]) eq 'ARRAY') {
                   15052:                 my @currcategories;
                   15053:                 if ($currcat ne '') {
                   15054:                     @currcategories = split('&',$currcat);
                   15055:                 }
1.919     raeburn  15056:                 my $table;
1.663     raeburn  15057:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   15058:                     my $parent = $cats[0][$i];
1.919     raeburn  15059:                     next if ($parent eq 'instcode');
                   15060:                     if ($type eq 'Community') {
                   15061:                         next unless ($parent eq 'communities');
                   15062:                     } else {
                   15063:                         next if ($parent eq 'communities');
                   15064:                     }
1.663     raeburn  15065:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   15066:                     my $item = &escape($parent).'::0';
                   15067:                     my $checked = '';
                   15068:                     if (@currcategories > 0) {
                   15069:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   15070:                             $checked = ' checked="checked"';
1.663     raeburn  15071:                         }
                   15072:                     }
1.919     raeburn  15073:                     my $parent_title = $parent;
                   15074:                     if ($parent eq 'communities') {
                   15075:                         $parent_title = &mt('Communities');
                   15076:                     }
                   15077:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   15078:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15079:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  15080:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  15081:                     my $depth = 1;
                   15082:                     push(@path,$parent);
1.1075.2.117  raeburn  15083:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  15084:                     pop(@path);
1.919     raeburn  15085:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  15086:                     $itemcount ++;
                   15087:                 }
1.919     raeburn  15088:                 if ($itemcount) {
                   15089:                     $output = &Apache::loncommon::start_data_table().
                   15090:                               $table.
                   15091:                               &Apache::loncommon::end_data_table();
                   15092:                 }
1.663     raeburn  15093:             }
                   15094:         }
                   15095:     }
                   15096:     return $output;
                   15097: }
                   15098: 
                   15099: =pod
                   15100: 
1.1075.2.56  raeburn  15101: =item * &assign_category_rows()
1.663     raeburn  15102: 
                   15103: Create a datatable row for display of nested categories in a domain,
                   15104: with checkboxes to allow a course to be categorized,called recursively.
                   15105: 
                   15106: Inputs:
                   15107: 
                   15108: itemcount - track row number for alternating colors
                   15109: 
                   15110: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   15111:       categories and subcategories.
                   15112: 
                   15113: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   15114: 
                   15115: parent - parent of current category item
                   15116: 
                   15117: path - Array containing all categories back up through the hierarchy from the
                   15118:        current category to the top level.
                   15119: 
                   15120: currcategories - reference to array of current categories assigned to the course
                   15121: 
1.1075.2.117  raeburn  15122: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15123:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15124: 
1.663     raeburn  15125: Returns: $output (markup to be displayed).
                   15126: 
                   15127: =cut
                   15128: 
                   15129: sub assign_category_rows {
1.1075.2.117  raeburn  15130:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  15131:     my ($text,$name,$item,$chgstr);
                   15132:     if (ref($cats) eq 'ARRAY') {
                   15133:         my $maxdepth = scalar(@{$cats});
                   15134:         if (ref($cats->[$depth]) eq 'HASH') {
                   15135:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   15136:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   15137:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  15138:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  15139:                 for (my $j=0; $j<$numchildren; $j++) {
                   15140:                     $name = $cats->[$depth]{$parent}[$j];
                   15141:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   15142:                     my $deeper = $depth+1;
                   15143:                     my $checked = '';
                   15144:                     if (ref($currcategories) eq 'ARRAY') {
                   15145:                         if (@{$currcategories} > 0) {
                   15146:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   15147:                                 $checked = ' checked="checked"';
1.663     raeburn  15148:                             }
                   15149:                         }
                   15150:                     }
1.664     raeburn  15151:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   15152:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15153:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  15154:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   15155:                              '</td><td>';
1.663     raeburn  15156:                     if (ref($path) eq 'ARRAY') {
                   15157:                         push(@{$path},$name);
1.1075.2.117  raeburn  15158:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  15159:                         pop(@{$path});
                   15160:                     }
                   15161:                     $text .= '</td></tr>';
                   15162:                 }
                   15163:                 $text .= '</table></td>';
                   15164:             }
                   15165:         }
                   15166:     }
                   15167:     return $text;
                   15168: }
                   15169: 
1.1075.2.69  raeburn  15170: =pod
                   15171: 
                   15172: =back
                   15173: 
                   15174: =cut
                   15175: 
1.655     raeburn  15176: ############################################################
                   15177: ############################################################
                   15178: 
                   15179: 
1.443     albertel 15180: sub commit_customrole {
1.664     raeburn  15181:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  15182:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 15183:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   15184:                          ($end?', ending '.localtime($end):'').': <b>'.
                   15185:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  15186:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 15187:                  '</b><br />';
                   15188:     return $output;
                   15189: }
                   15190: 
                   15191: sub commit_standardrole {
1.1075.2.31  raeburn  15192:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  15193:     my ($output,$logmsg,$linefeed);
                   15194:     if ($context eq 'auto') {
                   15195:         $linefeed = "\n";
                   15196:     } else {
                   15197:         $linefeed = "<br />\n";
                   15198:     }  
1.443     albertel 15199:     if ($three eq 'st') {
1.541     raeburn  15200:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  15201:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  15202:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  15203:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   15204:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 15205:         } else {
1.541     raeburn  15206:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 15207:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15208:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   15209:             if ($context eq 'auto') {
                   15210:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   15211:             } else {
                   15212:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   15213:                &mt('Add to classlist').': <b>ok</b>';
                   15214:             }
                   15215:             $output .= $linefeed;
1.443     albertel 15216:         }
                   15217:     } else {
                   15218:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   15219:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15220:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  15221:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  15222:         if ($context eq 'auto') {
                   15223:             $output .= $result.$linefeed;
                   15224:         } else {
                   15225:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   15226:         }
1.443     albertel 15227:     }
                   15228:     return $output;
                   15229: }
                   15230: 
                   15231: sub commit_studentrole {
1.1075.2.31  raeburn  15232:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   15233:         $credits) = @_;
1.626     raeburn  15234:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  15235:     if ($context eq 'auto') {
                   15236:         $linefeed = "\n";
                   15237:     } else {
                   15238:         $linefeed = '<br />'."\n";
                   15239:     }
1.443     albertel 15240:     if (defined($one) && defined($two)) {
                   15241:         my $cid=$one.'_'.$two;
                   15242:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   15243:         my $secchange = 0;
                   15244:         my $expire_role_result;
                   15245:         my $modify_section_result;
1.628     raeburn  15246:         if ($oldsec ne '-1') { 
                   15247:             if ($oldsec ne $sec) {
1.443     albertel 15248:                 $secchange = 1;
1.628     raeburn  15249:                 my $now = time;
1.443     albertel 15250:                 my $uurl='/'.$cid;
                   15251:                 $uurl=~s/\_/\//g;
                   15252:                 if ($oldsec) {
                   15253:                     $uurl.='/'.$oldsec;
                   15254:                 }
1.626     raeburn  15255:                 $oldsecurl = $uurl;
1.628     raeburn  15256:                 $expire_role_result = 
1.1075.2.167  raeburn  15257:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
                   15258:                                                 '','','',$context);
1.628     raeburn  15259:                 if ($env{'request.course.sec'} ne '') { 
                   15260:                     if ($expire_role_result eq 'refused') {
                   15261:                         my @roles = ('st');
                   15262:                         my @statuses = ('previous');
                   15263:                         my @roledoms = ($one);
                   15264:                         my $withsec = 1;
                   15265:                         my %roleshash = 
                   15266:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   15267:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   15268:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   15269:                             my ($oldstart,$oldend) = 
                   15270:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   15271:                             if ($oldend > 0 && $oldend <= $now) {
                   15272:                                 $expire_role_result = 'ok';
                   15273:                             }
                   15274:                         }
                   15275:                     }
                   15276:                 }
1.443     albertel 15277:                 $result = $expire_role_result;
                   15278:             }
                   15279:         }
                   15280:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  15281:             $modify_section_result = 
                   15282:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   15283:                                                            undef,undef,undef,$sec,
                   15284:                                                            $end,$start,'','',$cid,
                   15285:                                                            '',$context,$credits);
1.443     albertel 15286:             if ($modify_section_result =~ /^ok/) {
                   15287:                 if ($secchange == 1) {
1.628     raeburn  15288:                     if ($sec eq '') {
                   15289:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   15290:                     } else {
                   15291:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   15292:                     }
1.443     albertel 15293:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  15294:                     if ($sec eq '') {
                   15295:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   15296:                     } else {
                   15297:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15298:                     }
1.443     albertel 15299:                 } else {
1.628     raeburn  15300:                     if ($sec eq '') {
                   15301:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   15302:                     } else {
                   15303:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15304:                     }
1.443     albertel 15305:                 }
                   15306:             } else {
1.628     raeburn  15307:                 if ($secchange) {       
                   15308:                     $$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;
                   15309:                 } else {
                   15310:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   15311:                 }
1.443     albertel 15312:             }
                   15313:             $result = $modify_section_result;
                   15314:         } elsif ($secchange == 1) {
1.628     raeburn  15315:             if ($oldsec eq '') {
1.1075.2.20  raeburn  15316:                 $$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  15317:             } else {
                   15318:                 $$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;
                   15319:             }
1.626     raeburn  15320:             if ($expire_role_result eq 'refused') {
                   15321:                 my $newsecurl = '/'.$cid;
                   15322:                 $newsecurl =~ s/\_/\//g;
                   15323:                 if ($sec ne '') {
                   15324:                     $newsecurl.='/'.$sec;
                   15325:                 }
                   15326:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   15327:                     if ($sec eq '') {
                   15328:                         $$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;
                   15329:                     } else {
                   15330:                         $$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;
                   15331:                     }
                   15332:                 }
                   15333:             }
1.443     albertel 15334:         }
                   15335:     } else {
1.626     raeburn  15336:         $$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 15337:         $result = "error: incomplete course id\n";
                   15338:     }
                   15339:     return $result;
                   15340: }
                   15341: 
1.1075.2.25  raeburn  15342: sub show_role_extent {
                   15343:     my ($scope,$context,$role) = @_;
                   15344:     $scope =~ s{^/}{};
                   15345:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   15346:     push(@courseroles,'co');
                   15347:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   15348:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   15349:         $scope =~ s{/}{_};
                   15350:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   15351:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   15352:         my ($audom,$auname) = split(/\//,$scope);
                   15353:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   15354:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   15355:     } else {
                   15356:         $scope =~ s{/$}{};
                   15357:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   15358:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   15359:     }
                   15360: }
                   15361: 
1.443     albertel 15362: ############################################################
                   15363: ############################################################
                   15364: 
1.566     albertel 15365: sub check_clone {
1.578     raeburn  15366:     my ($args,$linefeed) = @_;
1.566     albertel 15367:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   15368:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   15369:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   15370:     my $clonemsg;
                   15371:     my $can_clone = 0;
1.944     raeburn  15372:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  15373:     if ($lctype ne 'community') {
                   15374:         $lctype = 'course';
                   15375:     }
1.566     albertel 15376:     if ($clonehome eq 'no_host') {
1.944     raeburn  15377:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15378:             $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'});
                   15379:         } else {
                   15380:             $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'});
                   15381:         }     
1.566     albertel 15382:     } else {
                   15383: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  15384:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15385:             if ($clonedesc{'type'} ne 'Community') {
                   15386:                  $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'});
                   15387:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15388:             }
                   15389:         }
1.1075.2.119  raeburn  15390: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  15391:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 15392: 	    $can_clone = 1;
                   15393: 	} else {
1.1075.2.95  raeburn  15394: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 15395: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  15396:             if ($clonehash{'cloners'} eq '') {
                   15397:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   15398:                 if ($domdefs{'canclone'}) {
                   15399:                     unless ($domdefs{'canclone'} eq 'none') {
                   15400:                         if ($domdefs{'canclone'} eq 'domain') {
                   15401:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   15402:                                 $can_clone = 1;
                   15403:                             }
                   15404:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15405:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   15406:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   15407:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   15408:                                 $can_clone = 1;
                   15409:                             }
                   15410:                         }
                   15411:                     }
1.908     raeburn  15412:                 }
1.1075.2.95  raeburn  15413:             } else {
                   15414: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   15415:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  15416:                     $can_clone = 1;
1.1075.2.95  raeburn  15417:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  15418:                     $can_clone = 1;
1.1075.2.96  raeburn  15419:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   15420:                     $can_clone = 1;
1.1075.2.95  raeburn  15421:                 }
                   15422:                 unless ($can_clone) {
1.1075.2.96  raeburn  15423:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15424:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  15425:                         my (%gotdomdefaults,%gotcodedefaults);
                   15426:                         foreach my $cloner (@cloners) {
                   15427:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   15428:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   15429:                                 my (%codedefaults,@code_order);
                   15430:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   15431:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   15432:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   15433:                                     }
                   15434:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   15435:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   15436:                                     }
                   15437:                                 } else {
                   15438:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   15439:                                                                             \%codedefaults,
                   15440:                                                                             \@code_order);
                   15441:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   15442:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   15443:                                 }
                   15444:                                 if (@code_order > 0) {
                   15445:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   15446:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   15447:                                                                                 $args->{'crscode'})) {
                   15448:                                         $can_clone = 1;
                   15449:                                         last;
                   15450:                                     }
                   15451:                                 }
                   15452:                             }
                   15453:                         }
                   15454:                     }
1.1075.2.96  raeburn  15455:                 }
                   15456:             }
                   15457:             unless ($can_clone) {
                   15458:                 my $ccrole = 'cc';
                   15459:                 if ($args->{'crstype'} eq 'Community') {
                   15460:                     $ccrole = 'co';
                   15461:                 }
                   15462:                 my %roleshash =
                   15463:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   15464:                                                   $args->{'ccdomain'},
                   15465:                                                   'userroles',['active'],[$ccrole],
                   15466:                                                   [$args->{'clonedomain'}]);
                   15467:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   15468:                     $can_clone = 1;
                   15469:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   15470:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   15471:                     $can_clone = 1;
1.1075.2.95  raeburn  15472:                 }
                   15473:             }
                   15474:             unless ($can_clone) {
                   15475:                 if ($args->{'crstype'} eq 'Community') {
                   15476:                     $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'});
                   15477:                 } else {
                   15478:                     $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  15479: 	        }
1.566     albertel 15480: 	    }
1.578     raeburn  15481:         }
1.566     albertel 15482:     }
                   15483:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15484: }
                   15485: 
1.444     albertel 15486: sub construct_course {
1.1075.2.119  raeburn  15487:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
                   15488:         $cnum,$category,$coderef) = @_;
1.444     albertel 15489:     my $outcome;
1.541     raeburn  15490:     my $linefeed =  '<br />'."\n";
                   15491:     if ($context eq 'auto') {
                   15492:         $linefeed = "\n";
                   15493:     }
1.566     albertel 15494: 
                   15495: #
                   15496: # Are we cloning?
                   15497: #
                   15498:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15499:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  15500: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 15501: 	if ($context ne 'auto') {
1.578     raeburn  15502:             if ($clonemsg ne '') {
                   15503: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   15504:             }
1.566     albertel 15505: 	}
                   15506: 	$outcome .= $clonemsg.$linefeed;
                   15507: 
                   15508:         if (!$can_clone) {
                   15509: 	    return (0,$outcome);
                   15510: 	}
                   15511:     }
                   15512: 
1.444     albertel 15513: #
                   15514: # Open course
                   15515: #
                   15516:     my $crstype = lc($args->{'crstype'});
                   15517:     my %cenv=();
                   15518:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   15519:                                              $args->{'cdescr'},
                   15520:                                              $args->{'curl'},
                   15521:                                              $args->{'course_home'},
                   15522:                                              $args->{'nonstandard'},
                   15523:                                              $args->{'crscode'},
                   15524:                                              $args->{'ccuname'}.':'.
                   15525:                                              $args->{'ccdomain'},
1.882     raeburn  15526:                                              $args->{'crstype'},
1.885     raeburn  15527:                                              $cnum,$context,$category);
1.444     albertel 15528: 
                   15529:     # Note: The testing routines depend on this being output; see 
                   15530:     # Utils::Course. This needs to at least be output as a comment
                   15531:     # if anyone ever decides to not show this, and Utils::Course::new
                   15532:     # will need to be suitably modified.
1.541     raeburn  15533:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  15534:     if ($$courseid =~ /^error:/) {
                   15535:         return (0,$outcome);
                   15536:     }
                   15537: 
1.444     albertel 15538: #
                   15539: # Check if created correctly
                   15540: #
1.479     albertel 15541:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 15542:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  15543:     if ($crsuhome eq 'no_host') {
                   15544:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   15545:         return (0,$outcome);
                   15546:     }
1.541     raeburn  15547:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 15548: 
1.444     albertel 15549: #
1.566     albertel 15550: # Do the cloning
                   15551: #   
                   15552:     if ($can_clone && $cloneid) {
                   15553: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   15554: 	if ($context ne 'auto') {
                   15555: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   15556: 	}
                   15557: 	$outcome .= $clonemsg.$linefeed;
                   15558: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 15559: # Copy all files
1.637     www      15560: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 15561: # Restore URL
1.566     albertel 15562: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 15563: # Restore title
1.566     albertel 15564: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  15565: # Restore creation date, creator and creation context.
                   15566:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   15567:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   15568:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 15569: # Mark as cloned
1.566     albertel 15570: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      15571: # Need to clone grading mode
                   15572:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   15573:         $cenv{'grading'}=$newenv{'grading'};
                   15574: # Do not clone these environment entries
                   15575:         &Apache::lonnet::del('environment',
                   15576:                   ['default_enrollment_start_date',
                   15577:                    'default_enrollment_end_date',
                   15578:                    'question.email',
                   15579:                    'policy.email',
                   15580:                    'comment.email',
                   15581:                    'pch.users.denied',
1.725     raeburn  15582:                    'plc.users.denied',
                   15583:                    'hidefromcat',
1.1075.2.36  raeburn  15584:                    'checkforpriv',
1.1075.2.158  raeburn  15585:                    'categories'],
1.638     www      15586:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  15587:         if ($args->{'textbook'}) {
                   15588:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   15589:         }
1.444     albertel 15590:     }
1.566     albertel 15591: 
1.444     albertel 15592: #
                   15593: # Set environment (will override cloned, if existing)
                   15594: #
                   15595:     my @sections = ();
                   15596:     my @xlists = ();
                   15597:     if ($args->{'crstype'}) {
                   15598:         $cenv{'type'}=$args->{'crstype'};
                   15599:     }
                   15600:     if ($args->{'crsid'}) {
                   15601:         $cenv{'courseid'}=$args->{'crsid'};
                   15602:     }
                   15603:     if ($args->{'crscode'}) {
                   15604:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   15605:     }
                   15606:     if ($args->{'crsquota'} ne '') {
                   15607:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   15608:     } else {
                   15609:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   15610:     }
                   15611:     if ($args->{'ccuname'}) {
                   15612:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   15613:                                         ':'.$args->{'ccdomain'};
                   15614:     } else {
                   15615:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   15616:     }
1.1075.2.31  raeburn  15617:     if ($args->{'defaultcredits'}) {
                   15618:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   15619:     }
1.444     albertel 15620:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1075.2.166  raeburn  15621:     my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444     albertel 15622:     if ($args->{'crssections'}) {
                   15623:         $cenv{'internal.sectionnums'} = '';
                   15624:         if ($args->{'crssections'} =~ m/,/) {
                   15625:             @sections = split/,/,$args->{'crssections'};
                   15626:         } else {
                   15627:             $sections[0] = $args->{'crssections'};
                   15628:         }
                   15629:         if (@sections > 0) {
                   15630:             foreach my $item (@sections) {
                   15631:                 my ($sec,$gp) = split/:/,$item;
                   15632:                 my $class = $args->{'crscode'}.$sec;
                   15633:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   15634:                 $cenv{'internal.sectionnums'} .= $item.',';
1.1075.2.166  raeburn  15635:                 if ($addcheck eq 'ok') {
                   15636:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   15637:                         push(@oklcsecs,$gp);
                   15638:                     }
                   15639:                 } else {
1.1075.2.119  raeburn  15640:                     push(@badclasses,$class);
1.444     albertel 15641:                 }
                   15642:             }
                   15643:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   15644:         }
                   15645:     }
                   15646: # do not hide course coordinator from staff listing, 
                   15647: # even if privileged
                   15648:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  15649: # add course coordinator's domain to domains to check for privileged users
                   15650: # if different to course domain
                   15651:     if ($$crsudom ne $args->{'ccdomain'}) {
                   15652:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   15653:     }
1.444     albertel 15654: # add crosslistings
                   15655:     if ($args->{'crsxlist'}) {
                   15656:         $cenv{'internal.crosslistings'}='';
                   15657:         if ($args->{'crsxlist'} =~ m/,/) {
                   15658:             @xlists = split/,/,$args->{'crsxlist'};
                   15659:         } else {
                   15660:             $xlists[0] = $args->{'crsxlist'};
                   15661:         }
                   15662:         if (@xlists > 0) {
                   15663:             foreach my $item (@xlists) {
                   15664:                 my ($xl,$gp) = split/:/,$item;
                   15665:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   15666:                 $cenv{'internal.crosslistings'} .= $item.',';
1.1075.2.166  raeburn  15667:                 if ($addcheck eq 'ok') {
                   15668:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   15669:                         push(@oklcsecs,$gp);
                   15670:                     }
                   15671:                 } else {
1.1075.2.119  raeburn  15672:                     push(@badclasses,$xl);
1.444     albertel 15673:                 }
                   15674:             }
                   15675:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   15676:         }
                   15677:     }
                   15678:     if ($args->{'autoadds'}) {
                   15679:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   15680:     }
                   15681:     if ($args->{'autodrops'}) {
                   15682:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   15683:     }
                   15684: # check for notification of enrollment changes
                   15685:     my @notified = ();
                   15686:     if ($args->{'notify_owner'}) {
                   15687:         if ($args->{'ccuname'} ne '') {
                   15688:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   15689:         }
                   15690:     }
                   15691:     if ($args->{'notify_dc'}) {
                   15692:         if ($uname ne '') { 
1.630     raeburn  15693:             push(@notified,$uname.':'.$udom);
1.444     albertel 15694:         }
                   15695:     }
                   15696:     if (@notified > 0) {
                   15697:         my $notifylist;
                   15698:         if (@notified > 1) {
                   15699:             $notifylist = join(',',@notified);
                   15700:         } else {
                   15701:             $notifylist = $notified[0];
                   15702:         }
                   15703:         $cenv{'internal.notifylist'} = $notifylist;
                   15704:     }
                   15705:     if (@badclasses > 0) {
                   15706:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  15707:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   15708:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   15709:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 15710:         );
1.1075.2.119  raeburn  15711:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   15712:                            &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  15713:         if ($context eq 'auto') {
                   15714:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  15715:         } else {
1.566     albertel 15716:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  15717:         }
                   15718:         foreach my $item (@badclasses) {
1.541     raeburn  15719:             if ($context eq 'auto') {
1.1075.2.119  raeburn  15720:                 $outcome .= " - $item\n";
1.541     raeburn  15721:             } else {
1.1075.2.119  raeburn  15722:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  15723:             }
1.1075.2.119  raeburn  15724:         }
                   15725:         if ($context eq 'auto') {
                   15726:             $outcome .= $linefeed;
                   15727:         } else {
                   15728:             $outcome .= "</ul><br /><br /></div>\n";
                   15729:         }
1.444     albertel 15730:     }
                   15731:     if ($args->{'no_end_date'}) {
                   15732:         $args->{'endaccess'} = 0;
                   15733:     }
1.1075.2.166  raeburn  15734: #  If an official course with institutional sections is created by cloning
                   15735: #  an existing course, section-specific hiding of course totals in student's
                   15736: #  view of grades as copied from cloned course, will be checked for valid
                   15737: #  sections.
                   15738:     if (($can_clone && $cloneid) &&
                   15739:         ($cenv{'internal.coursecode'} ne '') &&
                   15740:         ($cenv{'grading'} eq 'standard') &&
                   15741:         ($cenv{'hidetotals'} ne '') &&
                   15742:         ($cenv{'hidetotals'} ne 'all')) {
                   15743:         my @hidesecs;
                   15744:         my $deletehidetotals;
                   15745:         if (@oklcsecs) {
                   15746:             foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
                   15747:                 if (grep(/^\Q$sec$/,@oklcsecs)) {
                   15748:                     push(@hidesecs,$sec);
                   15749:                 }
                   15750:             }
                   15751:             if (@hidesecs) {
                   15752:                 $cenv{'hidetotals'} = join(',',@hidesecs);
                   15753:             } else {
                   15754:                 $deletehidetotals = 1;
                   15755:             }
                   15756:         } else {
                   15757:             $deletehidetotals = 1;
                   15758:         }
                   15759:         if ($deletehidetotals) {
                   15760:             delete($cenv{'hidetotals'});
                   15761:             &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
                   15762:         }
                   15763:     }
1.444     albertel 15764:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   15765:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   15766:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   15767:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   15768:     if ($args->{'showphotos'}) {
                   15769:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   15770:     }
                   15771:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   15772:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   15773:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   15774:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  15775:             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'); 
                   15776:             if ($context eq 'auto') {
                   15777:                 $outcome .= $krb_msg;
                   15778:             } else {
1.566     albertel 15779:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  15780:             }
                   15781:             $outcome .= $linefeed;
1.444     albertel 15782:         }
                   15783:     }
                   15784:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   15785:        if ($args->{'setpolicy'}) {
                   15786:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15787:        }
                   15788:        if ($args->{'setcontent'}) {
                   15789:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15790:        }
1.1075.2.110  raeburn  15791:        if ($args->{'setcomment'}) {
                   15792:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15793:        }
1.444     albertel 15794:     }
                   15795:     if ($args->{'reshome'}) {
                   15796: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   15797: 	$cenv{'reshome'}=~s/\/+$/\//;
                   15798:     }
                   15799: #
                   15800: # course has keyed access
                   15801: #
                   15802:     if ($args->{'setkeys'}) {
                   15803:        $cenv{'keyaccess'}='yes';
                   15804:     }
                   15805: # if specified, key authority is not course, but user
                   15806: # only active if keyaccess is yes
                   15807:     if ($args->{'keyauth'}) {
1.487     albertel 15808: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   15809: 	$user = &LONCAPA::clean_username($user);
                   15810: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     15811: 	if ($user ne '' && $domain ne '') {
1.487     albertel 15812: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 15813: 	}
                   15814:     }
                   15815: 
1.1075.2.59  raeburn  15816: #
                   15817: #  generate and store uniquecode (available to course requester), if course should have one.
                   15818: #
                   15819:     if ($args->{'uniquecode'}) {
                   15820:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   15821:         if ($code) {
                   15822:             $cenv{'internal.uniquecode'} = $code;
                   15823:             my %crsinfo =
                   15824:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   15825:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   15826:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   15827:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   15828:             }
                   15829:             if (ref($coderef)) {
                   15830:                 $$coderef = $code;
                   15831:             }
                   15832:         }
                   15833:     }
                   15834: 
1.444     albertel 15835:     if ($args->{'disresdis'}) {
                   15836:         $cenv{'pch.roles.denied'}='st';
                   15837:     }
                   15838:     if ($args->{'disablechat'}) {
                   15839:         $cenv{'plc.roles.denied'}='st';
                   15840:     }
                   15841: 
                   15842:     # Record we've not yet viewed the Course Initialization Helper for this 
                   15843:     # course
                   15844:     $cenv{'course.helper.not.run'} = 1;
                   15845:     #
                   15846:     # Use new Randomseed
                   15847:     #
                   15848:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   15849:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   15850:     #
                   15851:     # The encryption code and receipt prefix for this course
                   15852:     #
                   15853:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   15854:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   15855:     #
                   15856:     # By default, use standard grading
                   15857:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   15858: 
1.541     raeburn  15859:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   15860:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15861: #
                   15862: # Open all assignments
                   15863: #
                   15864:     if ($args->{'openall'}) {
1.1075.2.146  raeburn  15865:        my $opendate = time;
                   15866:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   15867:            $opendate = $args->{'openallfrom'};
                   15868:        }
1.444     albertel 15869:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.146  raeburn  15870:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 15871:                            $storeunder.'.type' => 'date_start');
1.1075.2.146  raeburn  15872:        $outcome .= &mt('All assignments open starting [_1]',
                   15873:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   15874:                    &Apache::lonnet::cput
                   15875:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15876:    }
                   15877: #
                   15878: # Set first page
                   15879: #
                   15880:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   15881: 	    || ($cloneid)) {
1.445     albertel 15882: 	use LONCAPA::map;
1.444     albertel 15883: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 15884: 
                   15885: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   15886:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   15887: 
1.444     albertel 15888:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   15889:         my $title; my $url;
                   15890:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   15891: 	    $title=&mt('Syllabus');
1.444     albertel 15892:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   15893:         } else {
1.963     raeburn  15894:             $title=&mt('Table of Contents');
1.444     albertel 15895:             $url='/adm/navmaps';
                   15896:         }
1.445     albertel 15897: 
                   15898:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   15899: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   15900: 
                   15901: 	if ($errtext) { $fatal=2; }
1.541     raeburn  15902:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 15903:     }
1.566     albertel 15904: 
                   15905:     return (1,$outcome);
1.444     albertel 15906: }
                   15907: 
1.1075.2.59  raeburn  15908: sub make_unique_code {
                   15909:     my ($cdom,$cnum) = @_;
                   15910:     # get lock on uniquecodes db
                   15911:     my $lockhash = {
                   15912:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   15913:                                                   ':'.$env{'user.domain'},
                   15914:                    };
                   15915:     my $tries = 0;
                   15916:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15917:     my ($code,$error);
                   15918: 
                   15919:     while (($gotlock ne 'ok') && ($tries<3)) {
                   15920:         $tries ++;
                   15921:         sleep 1;
                   15922:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15923:     }
                   15924:     if ($gotlock eq 'ok') {
                   15925:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   15926:         my $gotcode;
                   15927:         my $attempts = 0;
                   15928:         while ((!$gotcode) && ($attempts < 100)) {
                   15929:             $code = &generate_code();
                   15930:             if (!exists($currcodes{$code})) {
                   15931:                 $gotcode = 1;
                   15932:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   15933:                     $error = 'nostore';
                   15934:                 }
                   15935:             }
                   15936:             $attempts ++;
                   15937:         }
                   15938:         my @del_lock = ($cnum."\0".'uniquecodes');
                   15939:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   15940:     } else {
                   15941:         $error = 'nolock';
                   15942:     }
                   15943:     return ($code,$error);
                   15944: }
                   15945: 
                   15946: sub generate_code {
                   15947:     my $code;
                   15948:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   15949:     for (my $i=0; $i<6; $i++) {
                   15950:         my $lettnum = int (rand 2);
                   15951:         my $item = '';
                   15952:         if ($lettnum) {
                   15953:             $item = $letts[int( rand(18) )];
                   15954:         } else {
                   15955:             $item = 1+int( rand(8) );
                   15956:         }
                   15957:         $code .= $item;
                   15958:     }
                   15959:     return $code;
                   15960: }
                   15961: 
1.444     albertel 15962: ############################################################
                   15963: ############################################################
                   15964: 
1.953     droeschl 15965: #SD
                   15966: # only Community and Course, or anything else?
1.378     raeburn  15967: sub course_type {
                   15968:     my ($cid) = @_;
                   15969:     if (!defined($cid)) {
                   15970:         $cid = $env{'request.course.id'};
                   15971:     }
1.404     albertel 15972:     if (defined($env{'course.'.$cid.'.type'})) {
                   15973:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  15974:     } else {
                   15975:         return 'Course';
1.377     raeburn  15976:     }
                   15977: }
1.156     albertel 15978: 
1.406     raeburn  15979: sub group_term {
                   15980:     my $crstype = &course_type();
                   15981:     my %names = (
                   15982:                   'Course' => 'group',
1.865     raeburn  15983:                   'Community' => 'group',
1.406     raeburn  15984:                 );
                   15985:     return $names{$crstype};
                   15986: }
                   15987: 
1.902     raeburn  15988: sub course_types {
1.1075.2.59  raeburn  15989:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  15990:     my %typename = (
                   15991:                          official   => 'Official course',
                   15992:                          unofficial => 'Unofficial course',
                   15993:                          community  => 'Community',
1.1075.2.59  raeburn  15994:                          textbook   => 'Textbook course',
1.902     raeburn  15995:                    );
                   15996:     return (\@types,\%typename);
                   15997: }
                   15998: 
1.156     albertel 15999: sub icon {
                   16000:     my ($file)=@_;
1.505     albertel 16001:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 16002:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 16003:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 16004:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   16005: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   16006: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   16007: 	            $curfext.".gif") {
                   16008: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   16009: 		$curfext.".gif";
                   16010: 	}
                   16011:     }
1.249     albertel 16012:     return &lonhttpdurl($iconname);
1.154     albertel 16013: } 
1.84      albertel 16014: 
1.575     albertel 16015: sub lonhttpdurl {
1.692     www      16016: #
                   16017: # Had been used for "small fry" static images on separate port 8080.
                   16018: # Modify here if lightweight http functionality desired again.
                   16019: # Currently eliminated due to increasing firewall issues.
                   16020: #
1.575     albertel 16021:     my ($url)=@_;
1.692     www      16022:     return $url;
1.215     albertel 16023: }
                   16024: 
1.213     albertel 16025: sub connection_aborted {
                   16026:     my ($r)=@_;
                   16027:     $r->print(" ");$r->rflush();
                   16028:     my $c = $r->connection;
                   16029:     return $c->aborted();
                   16030: }
                   16031: 
1.221     foxr     16032: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     16033: #    strings as 'strings'.
                   16034: sub escape_single {
1.221     foxr     16035:     my ($input) = @_;
1.223     albertel 16036:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     16037:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   16038:     return $input;
                   16039: }
1.223     albertel 16040: 
1.222     foxr     16041: #  Same as escape_single, but escape's "'s  This 
                   16042: #  can be used for  "strings"
                   16043: sub escape_double {
                   16044:     my ($input) = @_;
                   16045:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   16046:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   16047:     return $input;
                   16048: }
1.223     albertel 16049:  
1.222     foxr     16050: #   Escapes the last element of a full URL.
                   16051: sub escape_url {
                   16052:     my ($url)   = @_;
1.238     raeburn  16053:     my @urlslices = split(/\//, $url,-1);
1.369     www      16054:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  16055:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     16056: }
1.462     albertel 16057: 
1.820     raeburn  16058: sub compare_arrays {
                   16059:     my ($arrayref1,$arrayref2) = @_;
                   16060:     my (@difference,%count);
                   16061:     @difference = ();
                   16062:     %count = ();
                   16063:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   16064:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   16065:         foreach my $element (keys(%count)) {
                   16066:             if ($count{$element} == 1) {
                   16067:                 push(@difference,$element);
                   16068:             }
                   16069:         }
                   16070:     }
                   16071:     return @difference;
                   16072: }
                   16073: 
1.1075.2.152  raeburn  16074: sub lon_status_items {
                   16075:     my %defaults = (
                   16076:                      E         => 100,
                   16077:                      W         => 4,
                   16078:                      N         => 1,
                   16079:                      U         => 5,
                   16080:                      threshold => 200,
                   16081:                      sysmail   => 2500,
                   16082:                    );
                   16083:     my %names = (
                   16084:                    E => 'Errors',
                   16085:                    W => 'Warnings',
                   16086:                    N => 'Notices',
                   16087:                    U => 'Unsent',
                   16088:                 );
                   16089:     return (\%defaults,\%names);
                   16090: }
                   16091: 
1.817     bisitz   16092: # -------------------------------------------------------- Initialize user login
1.462     albertel 16093: sub init_user_environment {
1.463     albertel 16094:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 16095:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   16096: 
                   16097:     my $public=($username eq 'public' && $domain eq 'public');
                   16098: 
                   16099: # See if old ID present, if so, remove
                   16100: 
1.1062    raeburn  16101:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 16102:     my $now=time;
                   16103: 
                   16104:     if ($public) {
                   16105: 	my $max_public=100;
                   16106: 	my $oldest;
                   16107: 	my $oldest_time=0;
                   16108: 	for(my $next=1;$next<=$max_public;$next++) {
                   16109: 	    if (-e $lonids."/publicuser_$next.id") {
                   16110: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   16111: 		if ($mtime<$oldest_time || !$oldest_time) {
                   16112: 		    $oldest_time=$mtime;
                   16113: 		    $oldest=$next;
                   16114: 		}
                   16115: 	    } else {
                   16116: 		$cookie="publicuser_$next";
                   16117: 		last;
                   16118: 	    }
                   16119: 	}
                   16120: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   16121:     } else {
1.463     albertel 16122: 	# if this isn't a robot, kill any existing non-robot sessions
                   16123: 	if (!$args->{'robot'}) {
                   16124: 	    opendir(DIR,$lonids);
                   16125: 	    while ($filename=readdir(DIR)) {
                   16126: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136  raeburn  16127:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   16128:                             &GDBM_READER(),0640)) {
                   16129:                         my $linkedfile;
                   16130:                         if (exists($oldenv{'user.linkedenv'})) {
                   16131:                             $linkedfile = $oldenv{'user.linkedenv'};
                   16132:                         }
                   16133:                         untie(%oldenv);
                   16134:                         if (unlink("$lonids/$filename")) {
                   16135:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   16136:                                 if (-l "$lonids/$linkedfile.id") {
                   16137:                                     unlink("$lonids/$linkedfile.id");
                   16138:                                 }
                   16139:                             }
                   16140:                         }
                   16141:                     } else {
                   16142:                         unlink($lonids.'/'.$filename);
                   16143:                     }
1.463     albertel 16144: 		}
1.462     albertel 16145: 	    }
1.463     albertel 16146: 	    closedir(DIR);
1.1075.2.84  raeburn  16147: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   16148:             my $namespace = 'nohist_courseeditor';
                   16149:             my $lockingkey = 'paste'."\0".'locked_num';
                   16150:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   16151:                                                 $domain,$username);
                   16152:             if (exists($lockhash{$lockingkey})) {
                   16153:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   16154:                 unless ($delresult eq 'ok') {
                   16155:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   16156:                 }
                   16157:             }
1.462     albertel 16158: 	}
                   16159: # Give them a new cookie
1.463     albertel 16160: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      16161: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 16162: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 16163:     
                   16164: # Initialize roles
                   16165: 
1.1062    raeburn  16166: 	($userroles,$firstaccenv,$timerintenv) = 
                   16167:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 16168:     }
                   16169: # ------------------------------------ Check browser type and MathML capability
                   16170: 
1.1075.2.77  raeburn  16171:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   16172:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 16173: 
                   16174: # ------------------------------------------------------------- Get environment
                   16175: 
                   16176:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   16177:     my ($tmp) = keys(%userenv);
                   16178:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   16179:     } else {
                   16180: 	undef(%userenv);
                   16181:     }
                   16182:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   16183: 	$form->{'interface'}=$userenv{'interface'};
                   16184:     }
                   16185:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   16186: 
                   16187: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   16188:     foreach my $option ('interface','localpath','localres') {
                   16189:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 16190:     }
                   16191: # --------------------------------------------------------- Write first profile
                   16192: 
                   16193:     {
1.1075.2.150  raeburn  16194:         my $ip = &Apache::lonnet::get_requestor_ip();
1.462     albertel 16195: 	my %initial_env = 
                   16196: 	    ("user.name"          => $username,
                   16197: 	     "user.domain"        => $domain,
                   16198: 	     "user.home"          => $authhost,
                   16199: 	     "browser.type"       => $clientbrowser,
                   16200: 	     "browser.version"    => $clientversion,
                   16201: 	     "browser.mathml"     => $clientmathml,
                   16202: 	     "browser.unicode"    => $clientunicode,
                   16203: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  16204:              "browser.mobile"     => $clientmobile,
                   16205:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  16206:              "browser.osversion"  => $clientosversion,
1.462     albertel 16207: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   16208: 	     "request.course.fn"  => '',
                   16209: 	     "request.course.uri" => '',
                   16210: 	     "request.course.sec" => '',
                   16211: 	     "request.role"       => 'cm',
                   16212: 	     "request.role.adv"   => $env{'user.adv'},
1.1075.2.150  raeburn  16213: 	     "request.host"       => $ip,);
1.462     albertel 16214: 
                   16215:         if ($form->{'localpath'}) {
                   16216: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   16217: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   16218:         }
                   16219: 	
                   16220: 	if ($form->{'interface'}) {
                   16221: 	    $form->{'interface'}=~s/\W//gs;
                   16222: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   16223: 	    $env{'browser.interface'}=$form->{'interface'};
                   16224: 	}
                   16225: 
1.1075.2.54  raeburn  16226:         if ($form->{'iptoken'}) {
                   16227:             my $lonhost = $r->dir_config('lonHostID');
                   16228:             $initial_env{"user.noloadbalance"} = $lonhost;
                   16229:             $env{'user.noloadbalance'} = $lonhost;
                   16230:         }
                   16231: 
1.1075.2.120  raeburn  16232:         if ($form->{'noloadbalance'}) {
                   16233:             my @hosts = &Apache::lonnet::current_machine_ids();
                   16234:             my $hosthere = $form->{'noloadbalance'};
                   16235:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   16236:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   16237:                 $env{'user.noloadbalance'} = $hosthere;
                   16238:             }
                   16239:         }
                   16240: 
1.1016    raeburn  16241:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  16242:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   16243:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  16244: 
1.1075.2.125  raeburn  16245:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   16246:                 $userenv{'availabletools.'.$tool} = 
                   16247:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   16248:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   16249:             }
1.724     raeburn  16250: 
1.1075.2.125  raeburn  16251:             foreach my $crstype ('official','unofficial','community','textbook') {
                   16252:                 $userenv{'canrequest.'.$crstype} =
                   16253:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   16254:                                                       'reload','requestcourses',
                   16255:                                                       \%userenv,\%domdef,\%is_adv);
                   16256:             }
1.765     raeburn  16257: 
1.1075.2.125  raeburn  16258:             $userenv{'canrequest.author'} =
                   16259:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   16260:                                                   'reload','requestauthor',
                   16261:                                                   \%userenv,\%domdef,\%is_adv);
                   16262:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   16263:                                                  $domain,$username);
                   16264:             my $reqstatus = $reqauthor{'author_status'};
                   16265:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   16266:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   16267:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   16268:                                                       $reqauthor{'author'}{'timestamp'};
                   16269:                 }
1.1075.2.14  raeburn  16270:             }
                   16271:         }
                   16272: 
1.462     albertel 16273: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  16274: 
1.462     albertel 16275: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   16276: 		 &GDBM_WRCREAT(),0640)) {
                   16277: 	    &_add_to_env(\%disk_env,\%initial_env);
                   16278: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   16279: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  16280:             if (ref($firstaccenv) eq 'HASH') {
                   16281:                 &_add_to_env(\%disk_env,$firstaccenv);
                   16282:             }
                   16283:             if (ref($timerintenv) eq 'HASH') {
                   16284:                 &_add_to_env(\%disk_env,$timerintenv);
                   16285:             }
1.463     albertel 16286: 	    if (ref($args->{'extra_env'})) {
                   16287: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   16288: 	    }
1.462     albertel 16289: 	    untie(%disk_env);
                   16290: 	} else {
1.705     tempelho 16291: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   16292: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 16293: 	    return 'error: '.$!;
                   16294: 	}
                   16295:     }
                   16296:     $env{'request.role'}='cm';
                   16297:     $env{'request.role.adv'}=$env{'user.adv'};
                   16298:     $env{'browser.type'}=$clientbrowser;
                   16299: 
                   16300:     return $cookie;
                   16301: 
                   16302: }
                   16303: 
                   16304: sub _add_to_env {
                   16305:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  16306:     if (ref($env_data) eq 'HASH') {
                   16307:         while (my ($key,$value) = each(%$env_data)) {
                   16308: 	    $idf->{$prefix.$key} = $value;
                   16309: 	    $env{$prefix.$key}   = $value;
                   16310:         }
1.462     albertel 16311:     }
                   16312: }
                   16313: 
1.685     tempelho 16314: # --- Get the symbolic name of a problem and the url
                   16315: sub get_symb {
                   16316:     my ($request,$silent) = @_;
1.726     raeburn  16317:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 16318:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   16319:     if ($symb eq '') {
                   16320:         if (!$silent) {
1.1071    raeburn  16321:             if (ref($request)) { 
                   16322:                 $request->print("Unable to handle ambiguous references:$url:.");
                   16323:             }
1.685     tempelho 16324:             return ();
                   16325:         }
                   16326:     }
                   16327:     &Apache::lonenc::check_decrypt(\$symb);
                   16328:     return ($symb);
                   16329: }
                   16330: 
                   16331: # --------------------------------------------------------------Get annotation
                   16332: 
                   16333: sub get_annotation {
                   16334:     my ($symb,$enc) = @_;
                   16335: 
                   16336:     my $key = $symb;
                   16337:     if (!$enc) {
                   16338:         $key =
                   16339:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   16340:     }
                   16341:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   16342:     return $annotation{$key};
                   16343: }
                   16344: 
                   16345: sub clean_symb {
1.731     raeburn  16346:     my ($symb,$delete_enc) = @_;
1.685     tempelho 16347: 
                   16348:     &Apache::lonenc::check_decrypt(\$symb);
                   16349:     my $enc = $env{'request.enc'};
1.731     raeburn  16350:     if ($delete_enc) {
1.730     raeburn  16351:         delete($env{'request.enc'});
                   16352:     }
1.685     tempelho 16353: 
                   16354:     return ($symb,$enc);
                   16355: }
1.462     albertel 16356: 
1.1075.2.69  raeburn  16357: ############################################################
                   16358: ############################################################
                   16359: 
                   16360: =pod
                   16361: 
                   16362: =head1 Routines for building display used to search for courses
                   16363: 
                   16364: 
                   16365: =over 4
                   16366: 
                   16367: =item * &build_filters()
                   16368: 
                   16369: Create markup for a table used to set filters to use when selecting
                   16370: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   16371: and quotacheck.pl
                   16372: 
                   16373: 
                   16374: Inputs:
                   16375: 
                   16376: filterlist - anonymous array of fields to include as potential filters
                   16377: 
                   16378: crstype - course type
                   16379: 
                   16380: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   16381:               to pop-open a course selector (will contain "extra element").
                   16382: 
                   16383: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   16384: 
                   16385: filter - anonymous hash of criteria and their values
                   16386: 
                   16387: action - form action
                   16388: 
                   16389: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   16390: 
                   16391: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   16392: 
                   16393: cloneruname - username of owner of new course who wants to clone
                   16394: 
                   16395: clonerudom - domain of owner of new course who wants to clone
                   16396: 
                   16397: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   16398: 
                   16399: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   16400: 
                   16401: codedom - domain
                   16402: 
                   16403: formname - value of form element named "form".
                   16404: 
                   16405: fixeddom - domain, if fixed.
                   16406: 
                   16407: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   16408: 
                   16409: cnameelement - name of form element in form on opener page which will receive title of selected course
                   16410: 
                   16411: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   16412: 
                   16413: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   16414: 
                   16415: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   16416: 
                   16417: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   16418: 
                   16419: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   16420: 
                   16421: 
                   16422: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   16423: 
                   16424: 
                   16425: Side Effects: None
                   16426: 
                   16427: =cut
                   16428: 
                   16429: # ---------------------------------------------- search for courses based on last activity etc.
                   16430: 
                   16431: sub build_filters {
                   16432:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   16433:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   16434:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   16435:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   16436:         $clonetext,$clonewarning) = @_;
                   16437:     my ($list,$jscript);
                   16438:     my $onchange = 'javascript:updateFilters(this)';
                   16439:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   16440:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   16441:         $typeselectform,$instcodetitle);
                   16442:     if ($formname eq '') {
                   16443:         $formname = $caller;
                   16444:     }
                   16445:     foreach my $item (@{$filterlist}) {
                   16446:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   16447:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   16448:             if ($item eq 'domainfilter') {
                   16449:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   16450:             } elsif ($item eq 'coursefilter') {
                   16451:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   16452:             } elsif ($item eq 'ownerfilter') {
                   16453:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16454:             } elsif ($item eq 'ownerdomfilter') {
                   16455:                 $filter->{'ownerdomfilter'} =
                   16456:                     &LONCAPA::clean_domain($filter->{$item});
                   16457:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   16458:                                                        'ownerdomfilter',1);
                   16459:             } elsif ($item eq 'personfilter') {
                   16460:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16461:             } elsif ($item eq 'persondomfilter') {
                   16462:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   16463:                                                         'persondomfilter',1);
                   16464:             } else {
                   16465:                 $filter->{$item} =~ s/\W//g;
                   16466:             }
                   16467:             if (!$filter->{$item}) {
                   16468:                 $filter->{$item} = '';
                   16469:             }
                   16470:         }
                   16471:         if ($item eq 'domainfilter') {
                   16472:             my $allow_blank = 1;
                   16473:             if ($formname eq 'portform') {
                   16474:                 $allow_blank=0;
                   16475:             } elsif ($formname eq 'studentform') {
                   16476:                 $allow_blank=0;
                   16477:             }
                   16478:             if ($fixeddom) {
                   16479:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   16480:                                     ' value="'.$codedom.'" />'.
                   16481:                                     &Apache::lonnet::domain($codedom,'description');
                   16482:             } else {
                   16483:                 $domainselectform = &select_dom_form($filter->{$item},
                   16484:                                                      'domainfilter',
                   16485:                                                       $allow_blank,'',$onchange);
                   16486:             }
                   16487:         } else {
                   16488:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   16489:         }
                   16490:     }
                   16491: 
                   16492:     # last course activity filter and selection
                   16493:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   16494: 
                   16495:     # course created filter and selection
                   16496:     if (exists($filter->{'createdfilter'})) {
                   16497:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   16498:     }
                   16499: 
                   16500:     my %lt = &Apache::lonlocal::texthash(
                   16501:                 'cac' => "$crstype Activity",
                   16502:                 'ccr' => "$crstype Created",
                   16503:                 'cde' => "$crstype Title",
                   16504:                 'cdo' => "$crstype Domain",
                   16505:                 'ins' => 'Institutional Code',
                   16506:                 'inc' => 'Institutional Categorization',
                   16507:                 'cow' => "$crstype Owner/Co-owner",
                   16508:                 'cop' => "$crstype Personnel Includes",
                   16509:                 'cog' => 'Type',
                   16510:              );
                   16511: 
                   16512:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16513:         my $typeval = 'Course';
                   16514:         if ($crstype eq 'Community') {
                   16515:             $typeval = 'Community';
                   16516:         }
                   16517:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   16518:     } else {
                   16519:         $typeselectform =  '<select name="type" size="1"';
                   16520:         if ($onchange) {
                   16521:             $typeselectform .= ' onchange="'.$onchange.'"';
                   16522:         }
                   16523:         $typeselectform .= '>'."\n";
                   16524:         foreach my $posstype ('Course','Community') {
                   16525:             $typeselectform.='<option value="'.$posstype.'"'.
                   16526:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   16527:         }
                   16528:         $typeselectform.="</select>";
                   16529:     }
                   16530: 
                   16531:     my ($cloneableonlyform,$cloneabletitle);
                   16532:     if (exists($filter->{'cloneableonly'})) {
                   16533:         my $cloneableon = '';
                   16534:         my $cloneableoff = ' checked="checked"';
                   16535:         if ($filter->{'cloneableonly'}) {
                   16536:             $cloneableon = $cloneableoff;
                   16537:             $cloneableoff = '';
                   16538:         }
                   16539:         $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>';
                   16540:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  16541:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  16542:         } else {
                   16543:             $cloneabletitle = &mt('Cloneable by you');
                   16544:         }
                   16545:     }
                   16546:     my $officialjs;
                   16547:     if ($crstype eq 'Course') {
                   16548:         if (exists($filter->{'instcodefilter'})) {
                   16549: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   16550: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   16551:             if ($codedom) {
                   16552:                 $officialjs = 1;
                   16553:                 ($instcodeform,$jscript,$$numtitlesref) =
                   16554:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   16555:                                                                   $officialjs,$codetitlesref);
                   16556:                 if ($jscript) {
                   16557:                     $jscript = '<script type="text/javascript">'."\n".
                   16558:                                '// <![CDATA['."\n".
                   16559:                                $jscript."\n".
                   16560:                                '// ]]>'."\n".
                   16561:                                '</script>'."\n";
                   16562:                 }
                   16563:             }
                   16564:             if ($instcodeform eq '') {
                   16565:                 $instcodeform =
                   16566:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   16567:                     $list->{'instcodefilter'}.'" />';
                   16568:                 $instcodetitle = $lt{'ins'};
                   16569:             } else {
                   16570:                 $instcodetitle = $lt{'inc'};
                   16571:             }
                   16572:             if ($fixeddom) {
                   16573:                 $instcodetitle .= '<br />('.$codedom.')';
                   16574:             }
                   16575:         }
                   16576:     }
                   16577:     my $output = qq|
                   16578: <form method="post" name="filterpicker" action="$action">
                   16579: <input type="hidden" name="form" value="$formname" />
                   16580: |;
                   16581:     if ($formname eq 'modifycourse') {
                   16582:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   16583:                    '<input type="hidden" name="prevphase" value="'.
                   16584:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  16585:     } elsif ($formname eq 'quotacheck') {
                   16586:         $output .= qq|
                   16587: <input type="hidden" name="sortby" value="" />
                   16588: <input type="hidden" name="sortorder" value="" />
                   16589: |;
                   16590:     } else {
1.1075.2.69  raeburn  16591:         my $name_input;
                   16592:         if ($cnameelement ne '') {
                   16593:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   16594:                           $cnameelement.'" />';
                   16595:         }
                   16596:         $output .= qq|
                   16597: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   16598: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   16599: $name_input
                   16600: $roleelement
                   16601: $multelement
                   16602: $typeelement
                   16603: |;
                   16604:         if ($formname eq 'portform') {
                   16605:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   16606:         }
                   16607:     }
                   16608:     if ($fixeddom) {
                   16609:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   16610:     }
                   16611:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   16612:     if ($sincefilterform) {
                   16613:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   16614:                   .$sincefilterform
                   16615:                   .&Apache::lonhtmlcommon::row_closure();
                   16616:     }
                   16617:     if ($createdfilterform) {
                   16618:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   16619:                   .$createdfilterform
                   16620:                   .&Apache::lonhtmlcommon::row_closure();
                   16621:     }
                   16622:     if ($domainselectform) {
                   16623:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   16624:                   .$domainselectform
                   16625:                   .&Apache::lonhtmlcommon::row_closure();
                   16626:     }
                   16627:     if ($typeselectform) {
                   16628:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16629:             $output .= $typeselectform;
                   16630:         } else {
                   16631:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   16632:                       .$typeselectform
                   16633:                       .&Apache::lonhtmlcommon::row_closure();
                   16634:         }
                   16635:     }
                   16636:     if ($instcodeform) {
                   16637:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   16638:                   .$instcodeform
                   16639:                   .&Apache::lonhtmlcommon::row_closure();
                   16640:     }
                   16641:     if (exists($filter->{'ownerfilter'})) {
                   16642:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   16643:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16644:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   16645:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16646:                    $ownerdomselectform.'</td></tr></table>'.
                   16647:                    &Apache::lonhtmlcommon::row_closure();
                   16648:     }
                   16649:     if (exists($filter->{'personfilter'})) {
                   16650:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   16651:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16652:                    '<input type="text" name="personfilter" size="20" value="'.
                   16653:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16654:                    $persondomselectform.'</td></tr></table>'.
                   16655:                    &Apache::lonhtmlcommon::row_closure();
                   16656:     }
                   16657:     if (exists($filter->{'coursefilter'})) {
                   16658:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   16659:                   .'<input type="text" name="coursefilter" size="25" value="'
                   16660:                   .$list->{'coursefilter'}.'" />'
                   16661:                   .&Apache::lonhtmlcommon::row_closure();
                   16662:     }
                   16663:     if ($cloneableonlyform) {
                   16664:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   16665:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   16666:     }
                   16667:     if (exists($filter->{'descriptfilter'})) {
                   16668:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   16669:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   16670:                   .$list->{'descriptfilter'}.'" />'
                   16671:                   .&Apache::lonhtmlcommon::row_closure(1);
                   16672:     }
                   16673:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   16674:                '<input type="hidden" name="updater" value="" />'."\n".
                   16675:                '<input type="submit" name="gosearch" value="'.
                   16676:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   16677:     return $jscript.$clonewarning.$output;
                   16678: }
                   16679: 
                   16680: =pod
                   16681: 
                   16682: =item * &timebased_select_form()
                   16683: 
                   16684: Create markup for a dropdown list used to select a time-based
                   16685: filter e.g., Course Activity, Course Created, when searching for courses
                   16686: or communities
                   16687: 
                   16688: Inputs:
                   16689: 
                   16690: item - name of form element (sincefilter or createdfilter)
                   16691: 
                   16692: filter - anonymous hash of criteria and their values
                   16693: 
                   16694: Returns: HTML for a select box contained a blank, then six time selections,
                   16695:          with value set in incoming form variables currently selected.
                   16696: 
                   16697: Side Effects: None
                   16698: 
                   16699: =cut
                   16700: 
                   16701: sub timebased_select_form {
                   16702:     my ($item,$filter) = @_;
                   16703:     if (ref($filter) eq 'HASH') {
                   16704:         $filter->{$item} =~ s/[^\d-]//g;
                   16705:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   16706:         return &select_form(
                   16707:                             $filter->{$item},
                   16708:                             $item,
                   16709:                             {      '-1' => '',
                   16710:                                 '86400' => &mt('today'),
                   16711:                                '604800' => &mt('last week'),
                   16712:                               '2592000' => &mt('last month'),
                   16713:                               '7776000' => &mt('last three months'),
                   16714:                              '15552000' => &mt('last six months'),
                   16715:                              '31104000' => &mt('last year'),
                   16716:                     'select_form_order' =>
                   16717:                            ['-1','86400','604800','2592000','7776000',
                   16718:                             '15552000','31104000']});
                   16719:     }
                   16720: }
                   16721: 
                   16722: =pod
                   16723: 
                   16724: =item * &js_changer()
                   16725: 
                   16726: Create script tag containing Javascript used to submit course search form
                   16727: when course type or domain is changed, and also to hide 'Searching ...' on
                   16728: page load completion for page showing search result.
                   16729: 
                   16730: Inputs: None
                   16731: 
                   16732: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   16733: 
                   16734: Side Effects: None
                   16735: 
                   16736: =cut
                   16737: 
                   16738: sub js_changer {
                   16739:     return <<ENDJS;
                   16740: <script type="text/javascript">
                   16741: // <![CDATA[
                   16742: function updateFilters(caller) {
                   16743:     if (typeof(caller) != "undefined") {
                   16744:         document.filterpicker.updater.value = caller.name;
                   16745:     }
                   16746:     document.filterpicker.submit();
                   16747: }
                   16748: 
                   16749: function hideSearching() {
                   16750:     if (document.getElementById('searching')) {
                   16751:         document.getElementById('searching').style.display = 'none';
                   16752:     }
                   16753:     return;
                   16754: }
                   16755: 
                   16756: // ]]>
                   16757: </script>
                   16758: 
                   16759: ENDJS
                   16760: }
                   16761: 
                   16762: =pod
                   16763: 
                   16764: =item * &search_courses()
                   16765: 
                   16766: Process selected filters form course search form and pass to lonnet::courseiddump
                   16767: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   16768: 
                   16769: Inputs:
                   16770: 
                   16771: dom - domain being searched
                   16772: 
                   16773: type - course type ('Course' or 'Community' or '.' if any).
                   16774: 
                   16775: filter - anonymous hash of criteria and their values
                   16776: 
                   16777: numtitles - for institutional codes - number of categories
                   16778: 
                   16779: cloneruname - optional username of new course owner
                   16780: 
                   16781: clonerudom - optional domain of new course owner
                   16782: 
1.1075.2.95  raeburn  16783: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  16784:             (used when DC is using course creation form)
                   16785: 
                   16786: codetitles - reference to array of titles of components in institutional codes (official courses).
                   16787: 
1.1075.2.95  raeburn  16788: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   16789:            (and so can clone automatically)
                   16790: 
                   16791: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   16792: 
                   16793: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   16794:               courses to clone
1.1075.2.69  raeburn  16795: 
                   16796: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   16797: 
                   16798: 
                   16799: Side Effects: None
                   16800: 
                   16801: =cut
                   16802: 
                   16803: 
                   16804: sub search_courses {
1.1075.2.95  raeburn  16805:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   16806:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  16807:     my (%courses,%showcourses,$cloner);
                   16808:     if (($filter->{'ownerfilter'} ne '') ||
                   16809:         ($filter->{'ownerdomfilter'} ne '')) {
                   16810:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   16811:                                        $filter->{'ownerdomfilter'};
                   16812:     }
                   16813:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   16814:         if (!$filter->{$item}) {
                   16815:             $filter->{$item}='.';
                   16816:         }
                   16817:     }
                   16818:     my $now = time;
                   16819:     my $timefilter =
                   16820:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   16821:     my ($createdbefore,$createdafter);
                   16822:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   16823:         $createdbefore = $now;
                   16824:         $createdafter = $now-$filter->{'createdfilter'};
                   16825:     }
                   16826:     my ($instcodefilter,$regexpok);
                   16827:     if ($numtitles) {
                   16828:         if ($env{'form.official'} eq 'on') {
                   16829:             $instcodefilter =
                   16830:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16831:             $regexpok = 1;
                   16832:         } elsif ($env{'form.official'} eq 'off') {
                   16833:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16834:             unless ($instcodefilter eq '') {
                   16835:                 $regexpok = -1;
                   16836:             }
                   16837:         }
                   16838:     } else {
                   16839:         $instcodefilter = $filter->{'instcodefilter'};
                   16840:     }
                   16841:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   16842:     if ($type eq '') { $type = '.'; }
                   16843: 
                   16844:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   16845:         $cloner = $cloneruname.':'.$clonerudom;
                   16846:     }
                   16847:     %courses = &Apache::lonnet::courseiddump($dom,
                   16848:                                              $filter->{'descriptfilter'},
                   16849:                                              $timefilter,
                   16850:                                              $instcodefilter,
                   16851:                                              $filter->{'combownerfilter'},
                   16852:                                              $filter->{'coursefilter'},
                   16853:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  16854:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  16855:                                              $filter->{'cloneableonly'},
                   16856:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  16857:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  16858:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   16859:         my $ccrole;
                   16860:         if ($type eq 'Community') {
                   16861:             $ccrole = 'co';
                   16862:         } else {
                   16863:             $ccrole = 'cc';
                   16864:         }
                   16865:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   16866:                                                      $filter->{'persondomfilter'},
                   16867:                                                      'userroles',undef,
                   16868:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   16869:                                                      $dom);
                   16870:         foreach my $role (keys(%rolehash)) {
                   16871:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   16872:             my $cid = $cdom.'_'.$cnum;
                   16873:             if (exists($courses{$cid})) {
                   16874:                 if (ref($courses{$cid}) eq 'HASH') {
                   16875:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   16876:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  16877:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  16878:                         }
                   16879:                     } else {
                   16880:                         $courses{$cid}{roles} = [$courserole];
                   16881:                     }
                   16882:                     $showcourses{$cid} = $courses{$cid};
                   16883:                 }
                   16884:             }
                   16885:         }
                   16886:         %courses = %showcourses;
                   16887:     }
                   16888:     return %courses;
                   16889: }
                   16890: 
                   16891: =pod
                   16892: 
                   16893: =back
                   16894: 
1.1075.2.88  raeburn  16895: =head1 Routines for version requirements for current course.
                   16896: 
                   16897: =over 4
                   16898: 
                   16899: =item * &check_release_required()
                   16900: 
                   16901: Compares required LON-CAPA version with version on server, and
                   16902: if required version is newer looks for a server with the required version.
                   16903: 
                   16904: Looks first at servers in user's owen domain; if none suitable, looks at
                   16905: servers in course's domain are permitted to host sessions for user's domain.
                   16906: 
                   16907: Inputs:
                   16908: 
                   16909: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16910: 
                   16911: $courseid - Course ID of current course
                   16912: 
                   16913: $rolecode - User's current role in course (for switchserver query string).
                   16914: 
                   16915: $required - LON-CAPA version needed by course (format: Major.Minor).
                   16916: 
                   16917: 
                   16918: Returns:
                   16919: 
                   16920: $switchserver - query string tp append to /adm/switchserver call (if
                   16921:                 current server's LON-CAPA version is too old.
                   16922: 
                   16923: $warning - Message is displayed if no suitable server could be found.
                   16924: 
                   16925: =cut
                   16926: 
                   16927: sub check_release_required {
                   16928:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   16929:     my ($switchserver,$warning);
                   16930:     if ($required ne '') {
                   16931:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   16932:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16933:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   16934:             my $otherserver;
                   16935:             if (($major eq '' && $minor eq '') ||
                   16936:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   16937:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   16938:                 my $switchlcrev =
                   16939:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   16940:                                                            $userdomserver);
                   16941:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16942:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   16943:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   16944:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   16945:                     if ($cdom ne $env{'user.domain'}) {
                   16946:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   16947:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   16948:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   16949:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   16950:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   16951:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   16952:                         my $canhost =
                   16953:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   16954:                                                               $coursedomserver,
                   16955:                                                               $remoterev,
                   16956:                                                               $udomdefaults{'remotesessions'},
                   16957:                                                               $defdomdefaults{'hostedsessions'});
                   16958: 
                   16959:                         if ($canhost) {
                   16960:                             $otherserver = $coursedomserver;
                   16961:                         } else {
                   16962:                             $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.");
                   16963:                         }
                   16964:                     } else {
                   16965:                         $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).");
                   16966:                     }
                   16967:                 } else {
                   16968:                     $otherserver = $userdomserver;
                   16969:                 }
                   16970:             }
                   16971:             if ($otherserver ne '') {
                   16972:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   16973:             }
                   16974:         }
                   16975:     }
                   16976:     return ($switchserver,$warning);
                   16977: }
                   16978: 
                   16979: =pod
                   16980: 
                   16981: =item * &check_release_result()
                   16982: 
                   16983: Inputs:
                   16984: 
                   16985: $switchwarning - Warning message if no suitable server found to host session.
                   16986: 
                   16987: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16988:                 and current role.
                   16989: 
                   16990: Returns: HTML to display with information about requirement to switch server.
                   16991:          Either displaying warning with link to Roles/Courses screen or
                   16992:          display link to switchserver.
                   16993: 
1.1075.2.69  raeburn  16994: =cut
                   16995: 
1.1075.2.88  raeburn  16996: sub check_release_result {
                   16997:     my ($switchwarning,$switchserver) = @_;
                   16998:     my $output = &start_page('Selected course unavailable on this server').
                   16999:                  '<p class="LC_warning">';
                   17000:     if ($switchwarning) {
                   17001:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   17002:         if (&show_course()) {
                   17003:             $output .= &mt('Display courses');
                   17004:         } else {
                   17005:             $output .= &mt('Display roles');
                   17006:         }
                   17007:         $output .= '</a>';
                   17008:     } elsif ($switchserver) {
                   17009:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   17010:                    '<br />'.
                   17011:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   17012:                    &mt('Switch Server').
                   17013:                    '</a>';
                   17014:     }
                   17015:     $output .= '</p>'.&end_page();
                   17016:     return $output;
                   17017: }
                   17018: 
                   17019: =pod
                   17020: 
                   17021: =item * &needs_coursereinit()
                   17022: 
                   17023: Determine if course contents stored for user's session needs to be
                   17024: refreshed, because content has changed since "Big Hash" last tied.
                   17025: 
                   17026: Check for change is made if time last checked is more than 10 minutes ago
                   17027: (by default).
                   17028: 
                   17029: Inputs:
                   17030: 
                   17031: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   17032: 
                   17033: $interval (optional) - Time which may elapse (in s) between last check for content
                   17034:                        change in current course. (default: 600 s).
                   17035: 
                   17036: Returns: an array; first element is:
                   17037: 
                   17038: =over 4
                   17039: 
                   17040: 'switch' - if content updates mean user's session
                   17041:            needs to be switched to a server running a newer LON-CAPA version
                   17042: 
                   17043: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   17044:            on current server hosting user's session
                   17045: 
                   17046: ''       - if no action required.
                   17047: 
                   17048: =back
                   17049: 
                   17050: If first item element is 'switch':
                   17051: 
                   17052: second item is $switchwarning - Warning message if no suitable server found to host session.
                   17053: 
                   17054: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   17055:                               and current role.
                   17056: 
                   17057: otherwise: no other elements returned.
                   17058: 
                   17059: =back
                   17060: 
                   17061: =cut
                   17062: 
                   17063: sub needs_coursereinit {
                   17064:     my ($loncaparev,$interval) = @_;
                   17065:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   17066:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   17067:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   17068:     my $now = time;
                   17069:     if ($interval eq '') {
                   17070:         $interval = 600;
                   17071:     }
                   17072:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   17073:         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   17074:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
                   17075:         if ($lastchange > $env{'request.course.tied'}) {
                   17076:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17077:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   17078:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   17079:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   17080:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   17081:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   17082:                     my ($switchserver,$switchwarning) =
                   17083:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   17084:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   17085:                     if ($switchwarning ne '' || $switchserver ne '') {
                   17086:                         return ('switch',$switchwarning,$switchserver);
                   17087:                     }
                   17088:                 }
                   17089:             }
                   17090:             return ('update');
                   17091:         }
                   17092:     }
                   17093:     return ();
                   17094: }
1.1075.2.69  raeburn  17095: 
1.1075.2.11  raeburn  17096: sub update_content_constraints {
                   17097:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17098:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17099:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   17100:     my %checkresponsetypes;
                   17101:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   17102:         my ($item,$name,$value) = split(/:/,$key);
                   17103:         if ($item eq 'resourcetag') {
                   17104:             if ($name eq 'responsetype') {
                   17105:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   17106:             }
                   17107:         }
                   17108:     }
                   17109:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17110:     if (defined($navmap)) {
                   17111:         my %allresponses;
                   17112:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   17113:             my %responses = $res->responseTypes();
                   17114:             foreach my $key (keys(%responses)) {
                   17115:                 next unless(exists($checkresponsetypes{$key}));
                   17116:                 $allresponses{$key} += $responses{$key};
                   17117:             }
                   17118:         }
                   17119:         foreach my $key (keys(%allresponses)) {
                   17120:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   17121:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   17122:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   17123:             }
                   17124:         }
                   17125:         undef($navmap);
                   17126:     }
                   17127:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   17128:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   17129:     }
                   17130:     return;
                   17131: }
                   17132: 
1.1075.2.27  raeburn  17133: sub allmaps_incourse {
                   17134:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17135:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   17136:         $cid = $env{'request.course.id'};
                   17137:         $cdom = $env{'course.'.$cid.'.domain'};
                   17138:         $cnum = $env{'course.'.$cid.'.num'};
                   17139:         $chome = $env{'course.'.$cid.'.home'};
                   17140:     }
                   17141:     my %allmaps = ();
                   17142:     my $lastchange =
                   17143:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   17144:     if ($lastchange > $env{'request.course.tied'}) {
                   17145:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   17146:         unless ($ferr) {
                   17147:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   17148:         }
                   17149:     }
                   17150:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17151:     if (defined($navmap)) {
                   17152:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   17153:             $allmaps{$res->src()} = 1;
                   17154:         }
                   17155:     }
                   17156:     return \%allmaps;
                   17157: }
                   17158: 
1.1075.2.11  raeburn  17159: sub parse_supplemental_title {
                   17160:     my ($title) = @_;
                   17161: 
                   17162:     my ($foldertitle,$renametitle);
                   17163:     if ($title =~ /&amp;&amp;&amp;/) {
                   17164:         $title = &HTML::Entites::decode($title);
                   17165:     }
                   17166:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   17167:         $renametitle=$4;
                   17168:         my ($time,$uname,$udom) = ($1,$2,$3);
                   17169:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   17170:         my $name =  &plainname($uname,$udom);
                   17171:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   17172:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   17173:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   17174:             $name.': <br />'.$foldertitle;
                   17175:     }
                   17176:     if (wantarray) {
                   17177:         return ($title,$foldertitle,$renametitle);
                   17178:     }
                   17179:     return $title;
                   17180: }
                   17181: 
1.1075.2.43  raeburn  17182: sub recurse_supplemental {
                   17183:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   17184:     if ($suppmap) {
                   17185:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   17186:         if ($fatal) {
                   17187:             $errors ++;
                   17188:         } else {
1.1075.2.167  raeburn  17189:             my @order = @LONCAPA::map::order;
                   17190:             if (@order > 0) {
                   17191:                 my @resources = @LONCAPA::map::resources;
                   17192:                 my @resparms = @LONCAPA::map::resparms;
                   17193:                 foreach my $idx (@order) {
                   17194:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1075.2.43  raeburn  17195:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  17196:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   17197:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  17198:                         } else {
                   17199:                             $numfiles ++;
                   17200:                         }
                   17201:                     }
                   17202:                 }
                   17203:             }
                   17204:         }
                   17205:     }
                   17206:     return ($numfiles,$errors);
                   17207: }
                   17208: 
1.1075.2.18  raeburn  17209: sub symb_to_docspath {
1.1075.2.119  raeburn  17210:     my ($symb,$navmapref) = @_;
                   17211:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  17212:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   17213:     if ($resurl=~/\.(sequence|page)$/) {
                   17214:         $mapurl=$resurl;
                   17215:     } elsif ($resurl eq 'adm/navmaps') {
                   17216:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   17217:     }
                   17218:     my $mapresobj;
1.1075.2.119  raeburn  17219:     unless (ref($$navmapref)) {
                   17220:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   17221:     }
                   17222:     if (ref($$navmapref)) {
                   17223:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  17224:     }
                   17225:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   17226:     my $type=$2;
                   17227:     my $path;
                   17228:     if (ref($mapresobj)) {
                   17229:         my $pcslist = $mapresobj->map_hierarchy();
                   17230:         if ($pcslist ne '') {
                   17231:             foreach my $pc (split(/,/,$pcslist)) {
                   17232:                 next if ($pc <= 1);
1.1075.2.119  raeburn  17233:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  17234:                 if (ref($res)) {
                   17235:                     my $thisurl = $res->src();
                   17236:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   17237:                     my $thistitle = $res->title();
                   17238:                     $path .= '&'.
                   17239:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  17240:                              &escape($thistitle).
1.1075.2.18  raeburn  17241:                              ':'.$res->randompick().
                   17242:                              ':'.$res->randomout().
                   17243:                              ':'.$res->encrypted().
                   17244:                              ':'.$res->randomorder().
                   17245:                              ':'.$res->is_page();
                   17246:                 }
                   17247:             }
                   17248:         }
                   17249:         $path =~ s/^\&//;
                   17250:         my $maptitle = $mapresobj->title();
                   17251:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17252:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17253:         }
                   17254:         $path .= (($path ne '')? '&' : '').
                   17255:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17256:                  &escape($maptitle).
1.1075.2.18  raeburn  17257:                  ':'.$mapresobj->randompick().
                   17258:                  ':'.$mapresobj->randomout().
                   17259:                  ':'.$mapresobj->encrypted().
                   17260:                  ':'.$mapresobj->randomorder().
                   17261:                  ':'.$mapresobj->is_page();
                   17262:     } else {
                   17263:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   17264:         my $ispage = (($type eq 'page')? 1 : '');
                   17265:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17266:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17267:         }
                   17268:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17269:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  17270:     }
                   17271:     unless ($mapurl eq 'default') {
                   17272:         $path = 'default&'.
1.1075.2.46  raeburn  17273:                 &escape('Main Content').
1.1075.2.18  raeburn  17274:                 ':::::&'.$path;
                   17275:     }
                   17276:     return $path;
                   17277: }
                   17278: 
1.1075.2.14  raeburn  17279: sub captcha_display {
1.1075.2.137  raeburn  17280:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17281:     my ($output,$error);
1.1075.2.107  raeburn  17282:     my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137  raeburn  17283:         &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17284:     if ($captcha eq 'original') {
                   17285:         $output = &create_captcha();
                   17286:         unless ($output) {
                   17287:             $error = 'captcha';
                   17288:         }
                   17289:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17290:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  17291:         unless ($output) {
                   17292:             $error = 'recaptcha';
                   17293:         }
                   17294:     }
1.1075.2.107  raeburn  17295:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  17296: }
                   17297: 
                   17298: sub captcha_response {
1.1075.2.137  raeburn  17299:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17300:     my ($captcha_chk,$captcha_error);
1.1075.2.137  raeburn  17301:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17302:     if ($captcha eq 'original') {
                   17303:         ($captcha_chk,$captcha_error) = &check_captcha();
                   17304:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17305:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  17306:     } else {
                   17307:         $captcha_chk = 1;
                   17308:     }
                   17309:     return ($captcha_chk,$captcha_error);
                   17310: }
                   17311: 
                   17312: sub get_captcha_config {
1.1075.2.137  raeburn  17313:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107  raeburn  17314:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  17315:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   17316:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   17317:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17318:     if ($context eq 'usercreation') {
                   17319:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   17320:         if (ref($domconfig{$context}) eq 'HASH') {
                   17321:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   17322:             if (ref($hashtocheck) eq 'HASH') {
                   17323:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   17324:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   17325:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   17326:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   17327:                     }
                   17328:                     if ($privkey && $pubkey) {
                   17329:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  17330:                         $version = $hashtocheck->{'recaptchaversion'};
                   17331:                         if ($version ne '2') {
                   17332:                             $version = 1;
                   17333:                         }
1.1075.2.14  raeburn  17334:                     } else {
                   17335:                         $captcha = 'original';
                   17336:                     }
                   17337:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   17338:                     $captcha = 'original';
                   17339:                 }
                   17340:             }
                   17341:         } else {
                   17342:             $captcha = 'captcha';
                   17343:         }
                   17344:     } elsif ($context eq 'login') {
                   17345:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   17346:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   17347:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   17348:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   17349:             if ($privkey && $pubkey) {
                   17350:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  17351:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   17352:                 if ($version ne '2') {
                   17353:                     $version = 1;
                   17354:                 }
1.1075.2.14  raeburn  17355:             } else {
                   17356:                 $captcha = 'original';
                   17357:             }
                   17358:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   17359:             $captcha = 'original';
                   17360:         }
1.1075.2.137  raeburn  17361:     } elsif ($context eq 'passwords') {
                   17362:         if ($dom_in_effect) {
                   17363:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   17364:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   17365:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   17366:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   17367:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   17368:                 }
                   17369:                 if ($privkey && $pubkey) {
                   17370:                     $captcha = 'recaptcha';
                   17371:                     $version = $passwdconf{'recaptchaversion'};
                   17372:                     if ($version ne '2') {
                   17373:                         $version = 1;
                   17374:                     }
                   17375:                 } else {
                   17376:                     $captcha = 'original';
                   17377:                 }
                   17378:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   17379:                 $captcha = 'original';
                   17380:             }
                   17381:         }
1.1075.2.14  raeburn  17382:     }
1.1075.2.107  raeburn  17383:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  17384: }
                   17385: 
                   17386: sub create_captcha {
                   17387:     my %captcha_params = &captcha_settings();
                   17388:     my ($output,$maxtries,$tries) = ('',10,0);
                   17389:     while ($tries < $maxtries) {
                   17390:         $tries ++;
                   17391:         my $captcha = Authen::Captcha->new (
                   17392:                                            output_folder => $captcha_params{'output_dir'},
                   17393:                                            data_folder   => $captcha_params{'db_dir'},
                   17394:                                           );
                   17395:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   17396: 
                   17397:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   17398:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1075.2.158  raeburn  17399:                       '<span class="LC_nobreak">'.
1.1075.2.14  raeburn  17400:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.167  raeburn  17401:                       '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1075.2.158  raeburn  17402:                       '</span><br />'.
1.1075.2.66  raeburn  17403:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  17404:             last;
                   17405:         }
                   17406:     }
1.1075.2.158  raeburn  17407:     if ($output eq '') {
                   17408:         &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
                   17409:     }
1.1075.2.14  raeburn  17410:     return $output;
                   17411: }
                   17412: 
                   17413: sub captcha_settings {
                   17414:     my %captcha_params = (
                   17415:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   17416:                            www_output_dir => "/captchaspool",
                   17417:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   17418:                            numchars       => '5',
                   17419:                          );
                   17420:     return %captcha_params;
                   17421: }
                   17422: 
                   17423: sub check_captcha {
                   17424:     my ($captcha_chk,$captcha_error);
                   17425:     my $code = $env{'form.code'};
                   17426:     my $md5sum = $env{'form.crypt'};
                   17427:     my %captcha_params = &captcha_settings();
                   17428:     my $captcha = Authen::Captcha->new(
                   17429:                       output_folder => $captcha_params{'output_dir'},
                   17430:                       data_folder   => $captcha_params{'db_dir'},
                   17431:                   );
1.1075.2.26  raeburn  17432:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  17433:     my %captcha_hash = (
                   17434:                         0       => 'Code not checked (file error)',
                   17435:                        -1      => 'Failed: code expired',
                   17436:                        -2      => 'Failed: invalid code (not in database)',
                   17437:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   17438:     );
                   17439:     if ($captcha_chk != 1) {
                   17440:         $captcha_error = $captcha_hash{$captcha_chk}
                   17441:     }
                   17442:     return ($captcha_chk,$captcha_error);
                   17443: }
                   17444: 
                   17445: sub create_recaptcha {
1.1075.2.107  raeburn  17446:     my ($pubkey,$version) = @_;
                   17447:     if ($version >= 2) {
1.1075.2.158  raeburn  17448:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
                   17449:                '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1075.2.107  raeburn  17450:     } else {
                   17451:         my $use_ssl;
                   17452:         if ($ENV{'SERVER_PORT'} == 443) {
                   17453:             $use_ssl = 1;
                   17454:         }
                   17455:         my $captcha = Captcha::reCAPTCHA->new;
                   17456:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   17457:                $captcha->get_html($pubkey,undef,$use_ssl).
                   17458:                &mt('If the text is hard to read, [_1] will replace them.',
                   17459:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   17460:                '<br /><br />';
                   17461:      }
1.1075.2.14  raeburn  17462: }
                   17463: 
                   17464: sub check_recaptcha {
1.1075.2.107  raeburn  17465:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  17466:     my $captcha_chk;
1.1075.2.150  raeburn  17467:     my $ip = &Apache::lonnet::get_requestor_ip(); 
1.1075.2.107  raeburn  17468:     if ($version >= 2) {
                   17469:         my $ua = LWP::UserAgent->new;
                   17470:         $ua->timeout(10);
                   17471:         my %info = (
                   17472:                      secret   => $privkey,
                   17473:                      response => $env{'form.g-recaptcha-response'},
1.1075.2.150  raeburn  17474:                      remoteip => $ip,
1.1075.2.107  raeburn  17475:                    );
                   17476:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   17477:         if ($response->is_success)  {
                   17478:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   17479:             if (ref($data) eq 'HASH') {
                   17480:                 if ($data->{'success'}) {
                   17481:                     $captcha_chk = 1;
                   17482:                 }
                   17483:             }
                   17484:         }
                   17485:     } else {
                   17486:         my $captcha = Captcha::reCAPTCHA->new;
                   17487:         my $captcha_result =
                   17488:             $captcha->check_answer(
                   17489:                                     $privkey,
1.1075.2.150  raeburn  17490:                                     $ip,
1.1075.2.107  raeburn  17491:                                     $env{'form.recaptcha_challenge_field'},
                   17492:                                     $env{'form.recaptcha_response_field'},
                   17493:                                   );
                   17494:         if ($captcha_result->{is_valid}) {
                   17495:             $captcha_chk = 1;
                   17496:         }
1.1075.2.14  raeburn  17497:     }
                   17498:     return $captcha_chk;
                   17499: }
                   17500: 
1.1075.2.64  raeburn  17501: sub emailusername_info {
1.1075.2.103  raeburn  17502:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  17503:     my %titles = &Apache::lonlocal::texthash (
                   17504:                      lastname      => 'Last Name',
                   17505:                      firstname     => 'First Name',
                   17506:                      institution   => 'School/college/university',
                   17507:                      location      => "School's city, state/province, country",
                   17508:                      web           => "School's web address",
                   17509:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  17510:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  17511:                  );
                   17512:     return (\@fields,\%titles);
                   17513: }
                   17514: 
1.1075.2.56  raeburn  17515: sub cleanup_html {
                   17516:     my ($incoming) = @_;
                   17517:     my $outgoing;
                   17518:     if ($incoming ne '') {
                   17519:         $outgoing = $incoming;
                   17520:         $outgoing =~ s/;/&#059;/g;
                   17521:         $outgoing =~ s/\#/&#035;/g;
                   17522:         $outgoing =~ s/\&/&#038;/g;
                   17523:         $outgoing =~ s/</&#060;/g;
                   17524:         $outgoing =~ s/>/&#062;/g;
                   17525:         $outgoing =~ s/\(/&#040/g;
                   17526:         $outgoing =~ s/\)/&#041;/g;
                   17527:         $outgoing =~ s/"/&#034;/g;
                   17528:         $outgoing =~ s/'/&#039;/g;
                   17529:         $outgoing =~ s/\$/&#036;/g;
                   17530:         $outgoing =~ s{/}{&#047;}g;
                   17531:         $outgoing =~ s/=/&#061;/g;
                   17532:         $outgoing =~ s/\\/&#092;/g
                   17533:     }
                   17534:     return $outgoing;
                   17535: }
                   17536: 
1.1075.2.74  raeburn  17537: # Checks for critical messages and returns a redirect url if one exists.
                   17538: # $interval indicates how often to check for messages.
                   17539: sub critical_redirect {
                   17540:     my ($interval) = @_;
1.1075.2.158  raeburn  17541:     unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   17542:         return ();
                   17543:     }
1.1075.2.74  raeburn  17544:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
                   17545:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   17546:                                         $env{'user.name'});
                   17547:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   17548:         my $redirecturl;
                   17549:         if ($what[0]) {
1.1075.2.158  raeburn  17550:             if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1075.2.74  raeburn  17551:                 $redirecturl='/adm/email?critical=display';
                   17552:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   17553:                 return (1, $url);
                   17554:             }
                   17555:         }
                   17556:     }
                   17557:     return ();
                   17558: }
                   17559: 
1.1075.2.64  raeburn  17560: # Use:
                   17561: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   17562: #
                   17563: ##################################################
                   17564: #          password associated functions         #
                   17565: ##################################################
                   17566: sub des_keys {
                   17567:     # Make a new key for DES encryption.
                   17568:     # Each key has two parts which are returned separately.
                   17569:     # Please note:  Each key must be passed through the &hex function
                   17570:     # before it is output to the web browser.  The hex versions cannot
                   17571:     # be used to decrypt.
                   17572:     my @hexstr=('0','1','2','3','4','5','6','7',
                   17573:                 '8','9','a','b','c','d','e','f');
                   17574:     my $lkey='';
                   17575:     for (0..7) {
                   17576:         $lkey.=$hexstr[rand(15)];
                   17577:     }
                   17578:     my $ukey='';
                   17579:     for (0..7) {
                   17580:         $ukey.=$hexstr[rand(15)];
                   17581:     }
                   17582:     return ($lkey,$ukey);
                   17583: }
                   17584: 
                   17585: sub des_decrypt {
                   17586:     my ($key,$cyphertext) = @_;
                   17587:     my $keybin=pack("H16",$key);
                   17588:     my $cypher;
                   17589:     if ($Crypt::DES::VERSION>=2.03) {
                   17590:         $cypher=new Crypt::DES $keybin;
                   17591:     } else {
                   17592:         $cypher=new DES $keybin;
                   17593:     }
1.1075.2.106  raeburn  17594:     my $plaintext='';
                   17595:     my $cypherlength = length($cyphertext);
                   17596:     my $numchunks = int($cypherlength/32);
                   17597:     for (my $j=0; $j<$numchunks; $j++) {
                   17598:         my $start = $j*32;
                   17599:         my $cypherblock = substr($cyphertext,$start,32);
                   17600:         my $chunk =
                   17601:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   17602:         $chunk .=
                   17603:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   17604:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   17605:         $plaintext .= $chunk;
                   17606:     }
1.1075.2.64  raeburn  17607:     return $plaintext;
                   17608: }
                   17609: 
1.1075.2.135  raeburn  17610: sub is_nonframeable {
                   17611:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   17612:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
                   17613:     return if (($remprotocol eq '') || ($remhost eq ''));
                   17614: 
                   17615:     $remprotocol = lc($remprotocol);
                   17616:     $remhost = lc($remhost);
                   17617:     my $remport = 80;
                   17618:     if ($remprotocol eq 'https') {
                   17619:         $remport = 443;
                   17620:     }
                   17621:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
                   17622:     if ($cached) {
                   17623:         unless ($nocache) {
                   17624:             if ($result) {
                   17625:                 return 1;
                   17626:             } else {
                   17627:                 return 0;
                   17628:             }
                   17629:         }
                   17630:     }
                   17631:     my $uselink;
                   17632:     my $request = new HTTP::Request('HEAD',$url);
1.1075.2.142  raeburn  17633:     my $ua = LWP::UserAgent->new;
                   17634:     $ua->timeout(5);
                   17635:     my $response=$ua->request($request);
1.1075.2.135  raeburn  17636:     if ($response->is_success()) {
                   17637:         my $secpolicy = lc($response->header('content-security-policy'));
                   17638:         my $xframeop = lc($response->header('x-frame-options'));
                   17639:         $secpolicy =~ s/^\s+|\s+$//g;
                   17640:         $xframeop =~ s/^\s+|\s+$//g;
                   17641:         if (($secpolicy ne '') || ($xframeop ne '')) {
                   17642:             my $remotehost = $remprotocol.'://'.$remhost;
                   17643:             my ($origin,$protocol,$port);
                   17644:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   17645:                 $port = $ENV{'SERVER_PORT'};
                   17646:             } else {
                   17647:                 $port = 80;
                   17648:             }
                   17649:             if ($absolute eq '') {
                   17650:                 $protocol = 'http:';
                   17651:                 if ($port == 443) {
                   17652:                     $protocol = 'https:';
                   17653:                 }
                   17654:                 $origin = $protocol.'//'.lc($hostname);
                   17655:             } else {
                   17656:                 $origin = lc($absolute);
                   17657:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   17658:             }
                   17659:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   17660:                 my $framepolicy = $1;
                   17661:                 $framepolicy =~ s/^\s+|\s+$//g;
                   17662:                 my @policies = split(/\s+/,$framepolicy);
                   17663:                 if (@policies) {
                   17664:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   17665:                         $uselink = 1;
                   17666:                     } else {
                   17667:                         $uselink = 1;
                   17668:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   17669:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   17670:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   17671:                             undef($uselink);
                   17672:                         }
                   17673:                         if ($uselink) {
                   17674:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   17675:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   17676:                                     undef($uselink);
                   17677:                                 }
                   17678:                             }
                   17679:                         }
                   17680:                         if ($uselink) {
                   17681:                             my @possok;
                   17682:                             if ($ip ne '') {
                   17683:                                 push(@possok,$ip);
                   17684:                             }
                   17685:                             my $hoststr = '';
                   17686:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   17687:                                 if ($hoststr eq '') {
                   17688:                                     $hoststr = $part;
                   17689:                                 } else {
                   17690:                                     $hoststr = "$part.$hoststr";
                   17691:                                 }
                   17692:                                 if ($hoststr eq $hostname) {
                   17693:                                     push(@possok,$hostname);
                   17694:                                 } else {
                   17695:                                     push(@possok,"*.$hoststr");
                   17696:                                 }
                   17697:                             }
                   17698:                             if (@possok) {
                   17699:                                 foreach my $poss (@possok) {
                   17700:                                     last if (!$uselink);
                   17701:                                     foreach my $policy (@policies) {
                   17702:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   17703:                                             undef($uselink);
                   17704:                                             last;
                   17705:                                         }
                   17706:                                     }
                   17707:                                 }
                   17708:                             }
                   17709:                         }
                   17710:                     }
                   17711:                 }
                   17712:             } elsif ($xframeop ne '') {
                   17713:                 $uselink = 1;
                   17714:                 my @policies = split(/\s*,\s*/,$xframeop);
                   17715:                 if (@policies) {
                   17716:                     unless (grep(/^deny$/,@policies)) {
                   17717:                         if ($origin ne '') {
                   17718:                             if (grep(/^sameorigin$/,@policies)) {
                   17719:                                 if ($remotehost eq $origin) {
                   17720:                                     undef($uselink);
                   17721:                                 }
                   17722:                             }
                   17723:                             if ($uselink) {
                   17724:                                 foreach my $policy (@policies) {
                   17725:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   17726:                                         my $allowfrom = $1;
                   17727:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   17728:                                             undef($uselink);
                   17729:                                             last;
                   17730:                                         }
                   17731:                                     }
                   17732:                                 }
                   17733:                             }
                   17734:                         }
                   17735:                     }
                   17736:                 }
                   17737:             }
                   17738:         }
                   17739:     }
                   17740:     if ($nocache) {
                   17741:         if ($cached) {
                   17742:             my $devalidate;
                   17743:             if ($uselink && !$result) {
                   17744:                 $devalidate = 1;
                   17745:             } elsif (!$uselink && $result) {
                   17746:                 $devalidate = 1;
                   17747:             }
                   17748:             if ($devalidate) {
                   17749:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   17750:             }
                   17751:         }
                   17752:     } else {
                   17753:         if ($uselink) {
                   17754:             $result = 1;
                   17755:         } else {
                   17756:             $result = 0;
                   17757:         }
                   17758:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   17759:     }
                   17760:     return $uselink;
                   17761: }
                   17762: 
1.112     bowersj2 17763: 1;
                   17764: __END__;
1.41      ng       17765: 

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