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

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.173! raeburn     4: # $Id: loncommon.pm,v 1.1075.2.172 2024/10/07 21:20:09 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.173! raeburn  5920:     my $linkattr;
        !          5921:     if ($args->{'links_disabled'}) {
        !          5922:         $linkattr = 'class="LCisDisabled" aria-disabled="true"';
        !          5923:     }
        !          5924: 
1.1075.2.60  raeburn  5925:     my $help=($no_inline_link?''
1.1075.2.173! raeburn  5926:               :&top_nav_help('Help',$linkattr));
1.1075.2.60  raeburn  5927: 
1.1075.2.12  raeburn  5928:     # Explicit link to get inline menu
                   5929:     my $menu= ($no_inline_link?''
1.1075.2.173! raeburn  5930:                :'<a href="/adm/remote?action=collapse" $linkattr target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.1075.2.12  raeburn  5931: 
                   5932:     if ($dc_info) {
                   5933:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   5934:     }
                   5935: 
1.1075.2.38  raeburn  5936:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   5937:     unless ($public) {
1.1075.2.173! raeburn  5938:         my $class = 'LC_menubuttons_link';
        !          5939:         if ($args->{'links_disabled'}) {
        !          5940:             $class .= ' LCisDisabled';
        !          5941:         }
1.1075.2.38  raeburn  5942:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
1.1075.2.173! raeburn  5943:                                 undef,$class);
1.1075.2.38  raeburn  5944:     }
                   5945: 
1.1075.2.12  raeburn  5946:     unless ($env{'form.inhibitmenu'}) {
1.1075.2.171  raeburn  5947:         $bodytag .= &inline_for_remote($public,$role,$realm,$dc_info,$no_inline_link);
1.1075.2.12  raeburn  5948:     }
1.1075.2.21  raeburn  5949:     return $bodytag."\n".$funclist;
1.182     matthew  5950: }
                   5951: 
1.1075.2.171  raeburn  5952: sub inline_for_remote {
                   5953:     my ($public,$role,$realm,$dc_info,$no_inline_link) = @_;
                   5954:     my $help=($no_inline_link?''
                   5955:               :&Apache::loncommon::top_nav_help('Help'));
                   5956: 
                   5957:     # Explicit link to get inline menu
                   5958:     my $menu= ($no_inline_link?''
                   5959:                :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
                   5960: 
                   5961:     if ($dc_info) {
                   5962:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   5963:     }
                   5964: 
                   5965:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   5966:     unless ($public) {
                   5967:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5968:                                 undef,'LC_menubuttons_link');
                   5969:     }
                   5970: 
                   5971:     return qq|<div id="LC_nav_bar">$name $role</div>
                   5972:               <ol class="LC_primary_menu LC_floatright LC_right">
                   5973:               <li>$help</li>
                   5974:               <li>$menu</li>
                   5975:               </ol><div id="LC_realm"> $realm $dc_info</div>|;
                   5976: }
                   5977: 
1.917     raeburn  5978: sub dc_courseid_toggle {
                   5979:     my ($dc_info) = @_;
1.980     raeburn  5980:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5981:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5982:            &mt('(More ...)').'</a></span>'.
                   5983:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5984: }
                   5985: 
1.330     albertel 5986: sub make_attr_string {
                   5987:     my ($register,$attr_ref) = @_;
                   5988: 
                   5989:     if ($attr_ref && !ref($attr_ref)) {
                   5990: 	die("addentries Must be a hash ref ".
                   5991: 	    join(':',caller(1))." ".
                   5992: 	    join(':',caller(0))." ");
                   5993:     }
                   5994: 
                   5995:     if ($register) {
1.339     albertel 5996: 	my ($on_load,$on_unload);
                   5997: 	foreach my $key (keys(%{$attr_ref})) {
                   5998: 	    if      (lc($key) eq 'onload') {
                   5999: 		$on_load.=$attr_ref->{$key}.';';
                   6000: 		delete($attr_ref->{$key});
                   6001: 
                   6002: 	    } elsif (lc($key) eq 'onunload') {
                   6003: 		$on_unload.=$attr_ref->{$key}.';';
                   6004: 		delete($attr_ref->{$key});
                   6005: 	    }
                   6006: 	}
1.1075.2.12  raeburn  6007:         if ($env{'environment.remote'} eq 'on') {
                   6008:             $attr_ref->{'onload'}  =
                   6009:                 &Apache::lonmenu::loadevents().  $on_load;
                   6010:             $attr_ref->{'onunload'}=
                   6011:                 &Apache::lonmenu::unloadevents().$on_unload;
                   6012:         } else {  
                   6013: 	    $attr_ref->{'onload'}  = $on_load;
                   6014: 	    $attr_ref->{'onunload'}= $on_unload;
                   6015:         }
1.330     albertel 6016:     }
1.339     albertel 6017: 
1.330     albertel 6018:     my $attr_string;
1.1075.2.56  raeburn  6019:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 6020: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   6021:     }
                   6022:     return $attr_string;
                   6023: }
                   6024: 
                   6025: 
1.182     matthew  6026: ###############################################
1.251     albertel 6027: ###############################################
                   6028: 
                   6029: =pod
                   6030: 
                   6031: =item * &endbodytag()
                   6032: 
                   6033: Returns a uniform footer for LON-CAPA web pages.
                   6034: 
1.635     raeburn  6035: Inputs: 1 - optional reference to an args hash
                   6036: If in the hash, key for noredirectlink has a value which evaluates to true,
                   6037: a 'Continue' link is not displayed if the page contains an
                   6038: internal redirect in the <head></head> section,
                   6039: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 6040: 
                   6041: =cut
                   6042: 
                   6043: sub endbodytag {
1.635     raeburn  6044:     my ($args) = @_;
1.1075.2.6  raeburn  6045:     my $endbodytag;
                   6046:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   6047:         $endbodytag='</body>';
                   6048:     }
1.315     albertel 6049:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  6050:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   6051: 	    $endbodytag=
                   6052: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   6053: 	        &mt('Continue').'</a>'.
                   6054: 	        $endbodytag;
                   6055:         }
1.315     albertel 6056:     }
1.1075.2.165  raeburn  6057:     if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
                   6058:         $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
                   6059:     }
1.251     albertel 6060:     return $endbodytag;
                   6061: }
                   6062: 
1.352     albertel 6063: =pod
                   6064: 
                   6065: =item * &standard_css()
                   6066: 
                   6067: Returns a style sheet
                   6068: 
                   6069: Inputs: (all optional)
                   6070:             domain         -> force to color decorate a page for a specific
                   6071:                                domain
                   6072:             function       -> force usage of a specific rolish color scheme
                   6073:             bgcolor        -> override the default page bgcolor
                   6074: 
                   6075: =cut
                   6076: 
1.343     albertel 6077: sub standard_css {
1.345     albertel 6078:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 6079:     $function  = &get_users_function() if (!$function);
                   6080:     my $img    = &designparm($function.'.img',   $domain);
                   6081:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   6082:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 6083:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 6084: #second colour for later usage
1.345     albertel 6085:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 6086:     my $pgbg_or_bgcolor =
                   6087: 	         $bgcolor ||
1.352     albertel 6088: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 6089:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 6090:     my $alink  = &designparm($function.'.alink', $domain);
                   6091:     my $vlink  = &designparm($function.'.vlink', $domain);
                   6092:     my $link   = &designparm($function.'.link',  $domain);
                   6093: 
1.602     albertel 6094:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 6095:     my $mono                 = 'monospace';
1.850     bisitz   6096:     my $data_table_head      = $sidebg;
                   6097:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   6098:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 6099:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 6100:     my $data_table_highlight = '#FFFF00';
1.352     albertel 6101:     my $mail_new             = '#FFBB77';
                   6102:     my $mail_new_hover       = '#DD9955';
                   6103:     my $mail_read            = '#BBBB77';
                   6104:     my $mail_read_hover      = '#999944';
                   6105:     my $mail_replied         = '#AAAA88';
                   6106:     my $mail_replied_hover   = '#888855';
                   6107:     my $mail_other           = '#99BBBB';
                   6108:     my $mail_other_hover     = '#669999';
1.391     albertel 6109:     my $table_header         = '#DDDDDD';
1.489     raeburn  6110:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   6111:     my $lg_border_color      = '#C8C8C8';
1.952     onken    6112:     my $button_hover         = '#BF2317';
1.392     albertel 6113: 
1.608     albertel 6114:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   6115:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   6116:                                              : '0 3px 0 4px';
1.448     albertel 6117: 
1.523     albertel 6118: 
1.343     albertel 6119:     return <<END;
1.947     droeschl 6120: 
                   6121: /* needed for iframe to allow 100% height in FF */
                   6122: body, html { 
                   6123:     margin: 0;
                   6124:     padding: 0 0.5%;
                   6125:     height: 99%; /* to avoid scrollbars */
                   6126: }
                   6127: 
1.795     www      6128: body {
1.911     bisitz   6129:   font-family: $sans;
                   6130:   line-height:130%;
                   6131:   font-size:0.83em;
                   6132:   color:$font;
1.795     www      6133: }
                   6134: 
1.959     onken    6135: a:focus,
                   6136: a:focus img {
1.795     www      6137:   color: red;
                   6138: }
1.698     harmsja  6139: 
1.911     bisitz   6140: form, .inline {
                   6141:   display: inline;
1.795     www      6142: }
1.721     harmsja  6143: 
1.795     www      6144: .LC_right {
1.911     bisitz   6145:   text-align:right;
1.795     www      6146: }
                   6147: 
                   6148: .LC_middle {
1.911     bisitz   6149:   vertical-align:middle;
1.795     www      6150: }
1.721     harmsja  6151: 
1.1075.2.38  raeburn  6152: .LC_floatleft {
                   6153:   float: left;
                   6154: }
                   6155: 
                   6156: .LC_floatright {
                   6157:   float: right;
                   6158: }
                   6159: 
1.911     bisitz   6160: .LC_400Box {
                   6161:   width:400px;
                   6162: }
1.721     harmsja  6163: 
1.947     droeschl 6164: .LC_iframecontainer {
                   6165:     width: 98%;
                   6166:     margin: 0;
                   6167:     position: fixed;
                   6168:     top: 8.5em;
                   6169:     bottom: 0;
                   6170: }
                   6171: 
                   6172: .LC_iframecontainer iframe{
                   6173:     border: none;
                   6174:     width: 100%;
                   6175:     height: 100%;
                   6176: }
                   6177: 
1.778     bisitz   6178: .LC_filename {
                   6179:   font-family: $mono;
                   6180:   white-space:pre;
1.921     bisitz   6181:   font-size: 120%;
1.778     bisitz   6182: }
                   6183: 
                   6184: .LC_fileicon {
                   6185:   border: none;
                   6186:   height: 1.3em;
                   6187:   vertical-align: text-bottom;
                   6188:   margin-right: 0.3em;
                   6189:   text-decoration:none;
                   6190: }
                   6191: 
1.1008    www      6192: .LC_setting {
                   6193:   text-decoration:underline;
                   6194: }
                   6195: 
1.350     albertel 6196: .LC_error {
                   6197:   color: red;
                   6198: }
1.795     www      6199: 
1.1075.2.15  raeburn  6200: .LC_warning {
                   6201:   color: darkorange;
                   6202: }
                   6203: 
1.457     albertel 6204: .LC_diff_removed {
1.733     bisitz   6205:   color: red;
1.394     albertel 6206: }
1.532     albertel 6207: 
                   6208: .LC_info,
1.457     albertel 6209: .LC_success,
                   6210: .LC_diff_added {
1.350     albertel 6211:   color: green;
                   6212: }
1.795     www      6213: 
1.802     bisitz   6214: div.LC_confirm_box {
                   6215:   background-color: #FAFAFA;
                   6216:   border: 1px solid $lg_border_color;
                   6217:   margin-right: 0;
                   6218:   padding: 5px;
                   6219: }
                   6220: 
                   6221: div.LC_confirm_box .LC_error img,
                   6222: div.LC_confirm_box .LC_success img {
                   6223:   vertical-align: middle;
                   6224: }
                   6225: 
1.1075.2.108  raeburn  6226: .LC_maxwidth {
                   6227:   max-width: 100%;
                   6228:   height: auto;
                   6229: }
                   6230: 
                   6231: .LC_textsize_mobile {
                   6232:   \@media only screen and (max-device-width: 480px) {
                   6233:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   6234:   }
                   6235: }
                   6236: 
1.440     albertel 6237: .LC_icon {
1.771     droeschl 6238:   border: none;
1.790     droeschl 6239:   vertical-align: middle;
1.771     droeschl 6240: }
                   6241: 
1.543     albertel 6242: .LC_docs_spacer {
                   6243:   width: 25px;
                   6244:   height: 1px;
1.771     droeschl 6245:   border: none;
1.543     albertel 6246: }
1.346     albertel 6247: 
1.532     albertel 6248: .LC_internal_info {
1.735     bisitz   6249:   color: #999999;
1.532     albertel 6250: }
                   6251: 
1.794     www      6252: .LC_discussion {
1.1050    www      6253:   background: $data_table_dark;
1.911     bisitz   6254:   border: 1px solid black;
                   6255:   margin: 2px;
1.794     www      6256: }
                   6257: 
                   6258: .LC_disc_action_left {
1.1050    www      6259:   background: $sidebg;
1.911     bisitz   6260:   text-align: left;
1.1050    www      6261:   padding: 4px;
                   6262:   margin: 2px;
1.794     www      6263: }
                   6264: 
                   6265: .LC_disc_action_right {
1.1050    www      6266:   background: $sidebg;
1.911     bisitz   6267:   text-align: right;
1.1050    www      6268:   padding: 4px;
                   6269:   margin: 2px;
1.794     www      6270: }
                   6271: 
                   6272: .LC_disc_new_item {
1.911     bisitz   6273:   background: white;
                   6274:   border: 2px solid red;
1.1050    www      6275:   margin: 4px;
                   6276:   padding: 4px;
1.794     www      6277: }
                   6278: 
                   6279: .LC_disc_old_item {
1.911     bisitz   6280:   background: white;
1.1050    www      6281:   margin: 4px;
                   6282:   padding: 4px;
1.794     www      6283: }
                   6284: 
1.458     albertel 6285: table.LC_pastsubmission {
                   6286:   border: 1px solid black;
                   6287:   margin: 2px;
                   6288: }
                   6289: 
1.924     bisitz   6290: table#LC_menubuttons {
1.345     albertel 6291:   width: 100%;
                   6292:   background: $pgbg;
1.392     albertel 6293:   border: 2px;
1.402     albertel 6294:   border-collapse: separate;
1.803     bisitz   6295:   padding: 0;
1.345     albertel 6296: }
1.392     albertel 6297: 
1.801     tempelho 6298: table#LC_title_bar a {
                   6299:   color: $fontmenu;
                   6300: }
1.836     bisitz   6301: 
1.807     droeschl 6302: table#LC_title_bar {
1.819     tempelho 6303:   clear: both;
1.836     bisitz   6304:   display: none;
1.807     droeschl 6305: }
                   6306: 
1.795     www      6307: table#LC_title_bar,
1.933     droeschl 6308: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 6309: table#LC_title_bar.LC_with_remote {
1.359     albertel 6310:   width: 100%;
1.392     albertel 6311:   border-color: $pgbg;
                   6312:   border-style: solid;
                   6313:   border-width: $border;
1.379     albertel 6314:   background: $pgbg;
1.801     tempelho 6315:   color: $fontmenu;
1.392     albertel 6316:   border-collapse: collapse;
1.803     bisitz   6317:   padding: 0;
1.819     tempelho 6318:   margin: 0;
1.359     albertel 6319: }
1.795     www      6320: 
1.933     droeschl 6321: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 6322:     margin: 0;
                   6323:     padding: 0;
1.933     droeschl 6324:     position: relative;
                   6325:     list-style: none;
1.913     droeschl 6326: }
1.933     droeschl 6327: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 6328:     display: inline;
                   6329: }
1.933     droeschl 6330: 
                   6331: .LC_breadcrumb_tools_navigation {
1.913     droeschl 6332:     padding: 0;
1.933     droeschl 6333:     margin: 0;
                   6334:     float: left;
1.913     droeschl 6335: }
1.933     droeschl 6336: .LC_breadcrumb_tools_tools {
                   6337:     padding: 0;
                   6338:     margin: 0;
1.913     droeschl 6339:     float: right;
                   6340: }
                   6341: 
1.359     albertel 6342: table#LC_title_bar td {
                   6343:   background: $tabbg;
                   6344: }
1.795     www      6345: 
1.911     bisitz   6346: table#LC_menubuttons img {
1.803     bisitz   6347:   border: none;
1.346     albertel 6348: }
1.795     www      6349: 
1.842     droeschl 6350: .LC_breadcrumbs_component {
1.911     bisitz   6351:   float: right;
                   6352:   margin: 0 1em;
1.357     albertel 6353: }
1.842     droeschl 6354: .LC_breadcrumbs_component img {
1.911     bisitz   6355:   vertical-align: middle;
1.777     tempelho 6356: }
1.795     www      6357: 
1.1075.2.108  raeburn  6358: .LC_breadcrumbs_hoverable {
                   6359:   background: $sidebg;
                   6360: }
                   6361: 
1.383     albertel 6362: td.LC_table_cell_checkbox {
                   6363:   text-align: center;
                   6364: }
1.795     www      6365: 
                   6366: .LC_fontsize_small {
1.911     bisitz   6367:   font-size: 70%;
1.705     tempelho 6368: }
                   6369: 
1.844     bisitz   6370: #LC_breadcrumbs {
1.911     bisitz   6371:   clear:both;
                   6372:   background: $sidebg;
                   6373:   border-bottom: 1px solid $lg_border_color;
                   6374:   line-height: 2.5em;
1.933     droeschl 6375:   overflow: hidden;
1.911     bisitz   6376:   margin: 0;
                   6377:   padding: 0;
1.995     raeburn  6378:   text-align: left;
1.819     tempelho 6379: }
1.862     bisitz   6380: 
1.1075.2.16  raeburn  6381: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   6382:   clear:both;
                   6383:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 6384:   border: 1px solid $sidebg;
1.1075.2.16  raeburn  6385:   margin: 0 0 10px 0;
1.966     bisitz   6386:   padding: 3px;
1.995     raeburn  6387:   text-align: left;
1.822     bisitz   6388: }
                   6389: 
1.795     www      6390: .LC_fontsize_medium {
1.911     bisitz   6391:   font-size: 85%;
1.705     tempelho 6392: }
                   6393: 
1.795     www      6394: .LC_fontsize_large {
1.911     bisitz   6395:   font-size: 120%;
1.705     tempelho 6396: }
                   6397: 
1.346     albertel 6398: .LC_menubuttons_inline_text {
                   6399:   color: $font;
1.698     harmsja  6400:   font-size: 90%;
1.701     harmsja  6401:   padding-left:3px;
1.346     albertel 6402: }
                   6403: 
1.934     droeschl 6404: .LC_menubuttons_inline_text img{
                   6405:   vertical-align: middle;
                   6406: }
                   6407: 
1.1051    www      6408: li.LC_menubuttons_inline_text img {
1.951     onken    6409:   cursor:pointer;
1.1002    droeschl 6410:   text-decoration: none;
1.951     onken    6411: }
                   6412: 
1.526     www      6413: .LC_menubuttons_link {
                   6414:   text-decoration: none;
                   6415: }
1.795     www      6416: 
1.522     albertel 6417: .LC_menubuttons_category {
1.521     www      6418:   color: $font;
1.526     www      6419:   background: $pgbg;
1.521     www      6420:   font-size: larger;
                   6421:   font-weight: bold;
                   6422: }
                   6423: 
1.346     albertel 6424: td.LC_menubuttons_text {
1.911     bisitz   6425:   color: $font;
1.346     albertel 6426: }
1.706     harmsja  6427: 
1.346     albertel 6428: .LC_current_location {
                   6429:   background: $tabbg;
                   6430: }
1.795     www      6431: 
1.1075.2.134  raeburn  6432: td.LC_zero_height {
                   6433:   line-height: 0;
                   6434:   cellpadding: 0;
                   6435: }
                   6436: 
1.938     bisitz   6437: table.LC_data_table {
1.347     albertel 6438:   border: 1px solid #000000;
1.402     albertel 6439:   border-collapse: separate;
1.426     albertel 6440:   border-spacing: 1px;
1.610     albertel 6441:   background: $pgbg;
1.347     albertel 6442: }
1.795     www      6443: 
1.422     albertel 6444: .LC_data_table_dense {
                   6445:   font-size: small;
                   6446: }
1.795     www      6447: 
1.507     raeburn  6448: table.LC_nested_outer {
                   6449:   border: 1px solid #000000;
1.589     raeburn  6450:   border-collapse: collapse;
1.803     bisitz   6451:   border-spacing: 0;
1.507     raeburn  6452:   width: 100%;
                   6453: }
1.795     www      6454: 
1.879     raeburn  6455: table.LC_innerpickbox,
1.507     raeburn  6456: table.LC_nested {
1.803     bisitz   6457:   border: none;
1.589     raeburn  6458:   border-collapse: collapse;
1.803     bisitz   6459:   border-spacing: 0;
1.507     raeburn  6460:   width: 100%;
                   6461: }
1.795     www      6462: 
1.911     bisitz   6463: table.LC_data_table tr th,
                   6464: table.LC_calendar tr th,
1.879     raeburn  6465: table.LC_prior_tries tr th,
                   6466: table.LC_innerpickbox tr th {
1.349     albertel 6467:   font-weight: bold;
                   6468:   background-color: $data_table_head;
1.801     tempelho 6469:   color:$fontmenu;
1.701     harmsja  6470:   font-size:90%;
1.347     albertel 6471: }
1.795     www      6472: 
1.879     raeburn  6473: table.LC_innerpickbox tr th,
                   6474: table.LC_innerpickbox tr td {
                   6475:   vertical-align: top;
                   6476: }
                   6477: 
1.711     raeburn  6478: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6479:   background-color: #CCCCCC;
1.711     raeburn  6480:   font-weight: bold;
                   6481:   text-align: left;
                   6482: }
1.795     www      6483: 
1.912     bisitz   6484: table.LC_data_table tr.LC_odd_row > td {
                   6485:   background-color: $data_table_light;
                   6486:   padding: 2px;
                   6487:   vertical-align: top;
                   6488: }
                   6489: 
1.809     bisitz   6490: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6491:   background-color: $data_table_light;
1.912     bisitz   6492:   vertical-align: top;
                   6493: }
                   6494: 
                   6495: table.LC_data_table tr.LC_even_row > td {
                   6496:   background-color: $data_table_dark;
1.425     albertel 6497:   padding: 2px;
1.900     bisitz   6498:   vertical-align: top;
1.347     albertel 6499: }
1.795     www      6500: 
1.809     bisitz   6501: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6502:   background-color: $data_table_dark;
1.900     bisitz   6503:   vertical-align: top;
1.347     albertel 6504: }
1.795     www      6505: 
1.425     albertel 6506: table.LC_data_table tr.LC_data_table_highlight td {
                   6507:   background-color: $data_table_darker;
                   6508: }
1.795     www      6509: 
1.639     raeburn  6510: table.LC_data_table tr td.LC_leftcol_header {
                   6511:   background-color: $data_table_head;
                   6512:   font-weight: bold;
                   6513: }
1.795     www      6514: 
1.451     albertel 6515: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6516: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6517:   font-weight: bold;
                   6518:   font-style: italic;
                   6519:   text-align: center;
                   6520:   padding: 8px;
1.347     albertel 6521: }
1.795     www      6522: 
1.1075.2.30  raeburn  6523: table.LC_data_table tr.LC_empty_row td,
                   6524: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6525:   background-color: $sidebg;
                   6526: }
                   6527: 
                   6528: table.LC_nested tr.LC_empty_row td {
                   6529:   background-color: #FFFFFF;
                   6530: }
                   6531: 
1.890     droeschl 6532: table.LC_caption {
                   6533: }
                   6534: 
1.507     raeburn  6535: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6536:   padding: 4ex
                   6537: }
1.795     www      6538: 
1.507     raeburn  6539: table.LC_nested_outer tr th {
                   6540:   font-weight: bold;
1.801     tempelho 6541:   color:$fontmenu;
1.507     raeburn  6542:   background-color: $data_table_head;
1.701     harmsja  6543:   font-size: small;
1.507     raeburn  6544:   border-bottom: 1px solid #000000;
                   6545: }
1.795     www      6546: 
1.507     raeburn  6547: table.LC_nested_outer tr td.LC_subheader {
                   6548:   background-color: $data_table_head;
                   6549:   font-weight: bold;
                   6550:   font-size: small;
                   6551:   border-bottom: 1px solid #000000;
                   6552:   text-align: right;
1.451     albertel 6553: }
1.795     www      6554: 
1.507     raeburn  6555: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6556:   background-color: #CCCCCC;
1.451     albertel 6557:   font-weight: bold;
                   6558:   font-size: small;
1.507     raeburn  6559:   text-align: center;
                   6560: }
1.795     www      6561: 
1.589     raeburn  6562: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6563: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6564:   text-align: left;
1.451     albertel 6565: }
1.795     www      6566: 
1.507     raeburn  6567: table.LC_nested td {
1.735     bisitz   6568:   background-color: #FFFFFF;
1.451     albertel 6569:   font-size: small;
1.507     raeburn  6570: }
1.795     www      6571: 
1.507     raeburn  6572: table.LC_nested_outer tr th.LC_right_item,
                   6573: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6574: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6575: table.LC_nested tr td.LC_right_item {
1.451     albertel 6576:   text-align: right;
                   6577: }
                   6578: 
1.507     raeburn  6579: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6580:   background-color: #EEEEEE;
1.451     albertel 6581: }
                   6582: 
1.473     raeburn  6583: table.LC_createuser {
                   6584: }
                   6585: 
                   6586: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6587:   font-size: small;
1.473     raeburn  6588: }
                   6589: 
                   6590: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6591:   background-color: #CCCCCC;
1.473     raeburn  6592:   font-weight: bold;
                   6593:   text-align: center;
                   6594: }
                   6595: 
1.349     albertel 6596: table.LC_calendar {
                   6597:   border: 1px solid #000000;
                   6598:   border-collapse: collapse;
1.917     raeburn  6599:   width: 98%;
1.349     albertel 6600: }
1.795     www      6601: 
1.349     albertel 6602: table.LC_calendar_pickdate {
                   6603:   font-size: xx-small;
                   6604: }
1.795     www      6605: 
1.349     albertel 6606: table.LC_calendar tr td {
                   6607:   border: 1px solid #000000;
                   6608:   vertical-align: top;
1.917     raeburn  6609:   width: 14%;
1.349     albertel 6610: }
1.795     www      6611: 
1.349     albertel 6612: table.LC_calendar tr td.LC_calendar_day_empty {
                   6613:   background-color: $data_table_dark;
                   6614: }
1.795     www      6615: 
1.779     bisitz   6616: table.LC_calendar tr td.LC_calendar_day_current {
                   6617:   background-color: $data_table_highlight;
1.777     tempelho 6618: }
1.795     www      6619: 
1.938     bisitz   6620: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6621:   background-color: $mail_new;
                   6622: }
1.795     www      6623: 
1.938     bisitz   6624: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6625:   background-color: $mail_new_hover;
                   6626: }
1.795     www      6627: 
1.938     bisitz   6628: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6629:   background-color: $mail_read;
                   6630: }
1.795     www      6631: 
1.938     bisitz   6632: /*
                   6633: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6634:   background-color: $mail_read_hover;
                   6635: }
1.938     bisitz   6636: */
1.795     www      6637: 
1.938     bisitz   6638: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6639:   background-color: $mail_replied;
                   6640: }
1.795     www      6641: 
1.938     bisitz   6642: /*
                   6643: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6644:   background-color: $mail_replied_hover;
                   6645: }
1.938     bisitz   6646: */
1.795     www      6647: 
1.938     bisitz   6648: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6649:   background-color: $mail_other;
                   6650: }
1.795     www      6651: 
1.938     bisitz   6652: /*
                   6653: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6654:   background-color: $mail_other_hover;
                   6655: }
1.938     bisitz   6656: */
1.494     raeburn  6657: 
1.777     tempelho 6658: table.LC_data_table tr > td.LC_browser_file,
                   6659: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6660:   background: #AAEE77;
1.389     albertel 6661: }
1.795     www      6662: 
1.777     tempelho 6663: table.LC_data_table tr > td.LC_browser_file_locked,
                   6664: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6665:   background: #FFAA99;
1.387     albertel 6666: }
1.795     www      6667: 
1.777     tempelho 6668: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6669:   background: #888888;
1.779     bisitz   6670: }
1.795     www      6671: 
1.777     tempelho 6672: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6673: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6674:   background: #F8F866;
1.777     tempelho 6675: }
1.795     www      6676: 
1.696     bisitz   6677: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6678:   background: #E0E8FF;
1.387     albertel 6679: }
1.696     bisitz   6680: 
1.707     bisitz   6681: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6682:   /* background: #77FF77; */
1.707     bisitz   6683: }
1.795     www      6684: 
1.707     bisitz   6685: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6686:   border-right: 8px solid #FFFF77;
1.707     bisitz   6687: }
1.795     www      6688: 
1.707     bisitz   6689: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6690:   border-right: 8px solid #FFAA77;
1.707     bisitz   6691: }
1.795     www      6692: 
1.707     bisitz   6693: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6694:   border-right: 8px solid #FF7777;
1.707     bisitz   6695: }
1.795     www      6696: 
1.707     bisitz   6697: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6698:   border-right: 8px solid #AAFF77;
1.707     bisitz   6699: }
1.795     www      6700: 
1.707     bisitz   6701: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6702:   border-right: 8px solid #11CC55;
1.707     bisitz   6703: }
                   6704: 
1.388     albertel 6705: span.LC_current_location {
1.701     harmsja  6706:   font-size:larger;
1.388     albertel 6707:   background: $pgbg;
                   6708: }
1.387     albertel 6709: 
1.1029    www      6710: span.LC_current_nav_location {
                   6711:   font-weight:bold;
                   6712:   background: $sidebg;
                   6713: }
                   6714: 
1.395     albertel 6715: span.LC_parm_menu_item {
                   6716:   font-size: larger;
                   6717: }
1.795     www      6718: 
1.395     albertel 6719: span.LC_parm_scope_all {
                   6720:   color: red;
                   6721: }
1.795     www      6722: 
1.395     albertel 6723: span.LC_parm_scope_folder {
                   6724:   color: green;
                   6725: }
1.795     www      6726: 
1.395     albertel 6727: span.LC_parm_scope_resource {
                   6728:   color: orange;
                   6729: }
1.795     www      6730: 
1.395     albertel 6731: span.LC_parm_part {
                   6732:   color: blue;
                   6733: }
1.795     www      6734: 
1.911     bisitz   6735: span.LC_parm_folder,
                   6736: span.LC_parm_symb {
1.395     albertel 6737:   font-size: x-small;
                   6738:   font-family: $mono;
                   6739:   color: #AAAAAA;
                   6740: }
                   6741: 
1.977     bisitz   6742: ul.LC_parm_parmlist li {
                   6743:   display: inline-block;
                   6744:   padding: 0.3em 0.8em;
                   6745:   vertical-align: top;
                   6746:   width: 150px;
                   6747:   border-top:1px solid $lg_border_color;
                   6748: }
                   6749: 
1.795     www      6750: td.LC_parm_overview_level_menu,
                   6751: td.LC_parm_overview_map_menu,
                   6752: td.LC_parm_overview_parm_selectors,
                   6753: td.LC_parm_overview_restrictions  {
1.396     albertel 6754:   border: 1px solid black;
                   6755:   border-collapse: collapse;
                   6756: }
1.795     www      6757: 
1.396     albertel 6758: table.LC_parm_overview_restrictions td {
                   6759:   border-width: 1px 4px 1px 4px;
                   6760:   border-style: solid;
                   6761:   border-color: $pgbg;
                   6762:   text-align: center;
                   6763: }
1.795     www      6764: 
1.396     albertel 6765: table.LC_parm_overview_restrictions th {
                   6766:   background: $tabbg;
                   6767:   border-width: 1px 4px 1px 4px;
                   6768:   border-style: solid;
                   6769:   border-color: $pgbg;
                   6770: }
1.795     www      6771: 
1.398     albertel 6772: table#LC_helpmenu {
1.803     bisitz   6773:   border: none;
1.398     albertel 6774:   height: 55px;
1.803     bisitz   6775:   border-spacing: 0;
1.398     albertel 6776: }
                   6777: 
                   6778: table#LC_helpmenu fieldset legend {
                   6779:   font-size: larger;
                   6780: }
1.795     www      6781: 
1.397     albertel 6782: table#LC_helpmenu_links {
                   6783:   width: 100%;
                   6784:   border: 1px solid black;
                   6785:   background: $pgbg;
1.803     bisitz   6786:   padding: 0;
1.397     albertel 6787:   border-spacing: 1px;
                   6788: }
1.795     www      6789: 
1.397     albertel 6790: table#LC_helpmenu_links tr td {
                   6791:   padding: 1px;
                   6792:   background: $tabbg;
1.399     albertel 6793:   text-align: center;
                   6794:   font-weight: bold;
1.397     albertel 6795: }
1.396     albertel 6796: 
1.795     www      6797: table#LC_helpmenu_links a:link,
                   6798: table#LC_helpmenu_links a:visited,
1.397     albertel 6799: table#LC_helpmenu_links a:active {
                   6800:   text-decoration: none;
                   6801:   color: $font;
                   6802: }
1.795     www      6803: 
1.397     albertel 6804: table#LC_helpmenu_links a:hover {
                   6805:   text-decoration: underline;
                   6806:   color: $vlink;
                   6807: }
1.396     albertel 6808: 
1.417     albertel 6809: .LC_chrt_popup_exists {
                   6810:   border: 1px solid #339933;
                   6811:   margin: -1px;
                   6812: }
1.795     www      6813: 
1.417     albertel 6814: .LC_chrt_popup_up {
                   6815:   border: 1px solid yellow;
                   6816:   margin: -1px;
                   6817: }
1.795     www      6818: 
1.417     albertel 6819: .LC_chrt_popup {
                   6820:   border: 1px solid #8888FF;
                   6821:   background: #CCCCFF;
                   6822: }
1.795     www      6823: 
1.421     albertel 6824: table.LC_pick_box {
                   6825:   border-collapse: separate;
                   6826:   background: white;
                   6827:   border: 1px solid black;
                   6828:   border-spacing: 1px;
                   6829: }
1.795     www      6830: 
1.421     albertel 6831: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6832:   background: $sidebg;
1.421     albertel 6833:   font-weight: bold;
1.900     bisitz   6834:   text-align: left;
1.740     bisitz   6835:   vertical-align: top;
1.421     albertel 6836:   width: 184px;
                   6837:   padding: 8px;
                   6838: }
1.795     www      6839: 
1.579     raeburn  6840: table.LC_pick_box td.LC_pick_box_value {
                   6841:   text-align: left;
                   6842:   padding: 8px;
                   6843: }
1.795     www      6844: 
1.579     raeburn  6845: table.LC_pick_box td.LC_pick_box_select {
                   6846:   text-align: left;
                   6847:   padding: 8px;
                   6848: }
1.795     www      6849: 
1.424     albertel 6850: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6851:   padding: 0;
1.421     albertel 6852:   height: 1px;
                   6853:   background: black;
                   6854: }
1.795     www      6855: 
1.421     albertel 6856: table.LC_pick_box td.LC_pick_box_submit {
                   6857:   text-align: right;
                   6858: }
1.795     www      6859: 
1.579     raeburn  6860: table.LC_pick_box td.LC_evenrow_value {
                   6861:   text-align: left;
                   6862:   padding: 8px;
                   6863:   background-color: $data_table_light;
                   6864: }
1.795     www      6865: 
1.579     raeburn  6866: table.LC_pick_box td.LC_oddrow_value {
                   6867:   text-align: left;
                   6868:   padding: 8px;
                   6869:   background-color: $data_table_light;
                   6870: }
1.795     www      6871: 
1.579     raeburn  6872: span.LC_helpform_receipt_cat {
                   6873:   font-weight: bold;
                   6874: }
1.795     www      6875: 
1.424     albertel 6876: table.LC_group_priv_box {
                   6877:   background: white;
                   6878:   border: 1px solid black;
                   6879:   border-spacing: 1px;
                   6880: }
1.795     www      6881: 
1.424     albertel 6882: table.LC_group_priv_box td.LC_pick_box_title {
                   6883:   background: $tabbg;
                   6884:   font-weight: bold;
                   6885:   text-align: right;
                   6886:   width: 184px;
                   6887: }
1.795     www      6888: 
1.424     albertel 6889: table.LC_group_priv_box td.LC_groups_fixed {
                   6890:   background: $data_table_light;
                   6891:   text-align: center;
                   6892: }
1.795     www      6893: 
1.424     albertel 6894: table.LC_group_priv_box td.LC_groups_optional {
                   6895:   background: $data_table_dark;
                   6896:   text-align: center;
                   6897: }
1.795     www      6898: 
1.424     albertel 6899: table.LC_group_priv_box td.LC_groups_functionality {
                   6900:   background: $data_table_darker;
                   6901:   text-align: center;
                   6902:   font-weight: bold;
                   6903: }
1.795     www      6904: 
1.424     albertel 6905: table.LC_group_priv td {
                   6906:   text-align: left;
1.803     bisitz   6907:   padding: 0;
1.424     albertel 6908: }
                   6909: 
                   6910: .LC_navbuttons {
                   6911:   margin: 2ex 0ex 2ex 0ex;
                   6912: }
1.795     www      6913: 
1.423     albertel 6914: .LC_topic_bar {
                   6915:   font-weight: bold;
                   6916:   background: $tabbg;
1.918     wenzelju 6917:   margin: 1em 0em 1em 2em;
1.805     bisitz   6918:   padding: 3px;
1.918     wenzelju 6919:   font-size: 1.2em;
1.423     albertel 6920: }
1.795     www      6921: 
1.423     albertel 6922: .LC_topic_bar span {
1.918     wenzelju 6923:   left: 0.5em;
                   6924:   position: absolute;
1.423     albertel 6925:   vertical-align: middle;
1.918     wenzelju 6926:   font-size: 1.2em;
1.423     albertel 6927: }
1.795     www      6928: 
1.423     albertel 6929: table.LC_course_group_status {
                   6930:   margin: 20px;
                   6931: }
1.795     www      6932: 
1.423     albertel 6933: table.LC_status_selector td {
                   6934:   vertical-align: top;
                   6935:   text-align: center;
1.424     albertel 6936:   padding: 4px;
                   6937: }
1.795     www      6938: 
1.599     albertel 6939: div.LC_feedback_link {
1.616     albertel 6940:   clear: both;
1.829     kalberla 6941:   background: $sidebg;
1.779     bisitz   6942:   width: 100%;
1.829     kalberla 6943:   padding-bottom: 10px;
                   6944:   border: 1px $tabbg solid;
1.833     kalberla 6945:   height: 22px;
                   6946:   line-height: 22px;
                   6947:   padding-top: 5px;
                   6948: }
                   6949: 
                   6950: div.LC_feedback_link img {
                   6951:   height: 22px;
1.867     kalberla 6952:   vertical-align:middle;
1.829     kalberla 6953: }
                   6954: 
1.911     bisitz   6955: div.LC_feedback_link a {
1.829     kalberla 6956:   text-decoration: none;
1.489     raeburn  6957: }
1.795     www      6958: 
1.867     kalberla 6959: div.LC_comblock {
1.911     bisitz   6960:   display:inline;
1.867     kalberla 6961:   color:$font;
                   6962:   font-size:90%;
                   6963: }
                   6964: 
                   6965: div.LC_feedback_link div.LC_comblock {
                   6966:   padding-left:5px;
                   6967: }
                   6968: 
                   6969: div.LC_feedback_link div.LC_comblock a {
                   6970:   color:$font;
                   6971: }
                   6972: 
1.489     raeburn  6973: span.LC_feedback_link {
1.858     bisitz   6974:   /* background: $feedback_link_bg; */
1.599     albertel 6975:   font-size: larger;
                   6976: }
1.795     www      6977: 
1.599     albertel 6978: span.LC_message_link {
1.858     bisitz   6979:   /* background: $feedback_link_bg; */
1.599     albertel 6980:   font-size: larger;
                   6981:   position: absolute;
                   6982:   right: 1em;
1.489     raeburn  6983: }
1.421     albertel 6984: 
1.515     albertel 6985: table.LC_prior_tries {
1.524     albertel 6986:   border: 1px solid #000000;
                   6987:   border-collapse: separate;
                   6988:   border-spacing: 1px;
1.515     albertel 6989: }
1.523     albertel 6990: 
1.515     albertel 6991: table.LC_prior_tries td {
1.524     albertel 6992:   padding: 2px;
1.515     albertel 6993: }
1.523     albertel 6994: 
                   6995: .LC_answer_correct {
1.795     www      6996:   background: lightgreen;
                   6997:   color: darkgreen;
                   6998:   padding: 6px;
1.523     albertel 6999: }
1.795     www      7000: 
1.523     albertel 7001: .LC_answer_charged_try {
1.797     www      7002:   background: #FFAAAA;
1.795     www      7003:   color: darkred;
                   7004:   padding: 6px;
1.523     albertel 7005: }
1.795     www      7006: 
1.779     bisitz   7007: .LC_answer_not_charged_try,
1.523     albertel 7008: .LC_answer_no_grade,
                   7009: .LC_answer_late {
1.795     www      7010:   background: lightyellow;
1.523     albertel 7011:   color: black;
1.795     www      7012:   padding: 6px;
1.523     albertel 7013: }
1.795     www      7014: 
1.523     albertel 7015: .LC_answer_previous {
1.795     www      7016:   background: lightblue;
                   7017:   color: darkblue;
                   7018:   padding: 6px;
1.523     albertel 7019: }
1.795     www      7020: 
1.779     bisitz   7021: .LC_answer_no_message {
1.777     tempelho 7022:   background: #FFFFFF;
                   7023:   color: black;
1.795     www      7024:   padding: 6px;
1.779     bisitz   7025: }
1.795     www      7026: 
1.1075.2.140  raeburn  7027: .LC_answer_unknown,
                   7028: .LC_answer_warning {
1.779     bisitz   7029:   background: orange;
                   7030:   color: black;
1.795     www      7031:   padding: 6px;
1.777     tempelho 7032: }
1.795     www      7033: 
1.529     albertel 7034: span.LC_prior_numerical,
                   7035: span.LC_prior_string,
                   7036: span.LC_prior_custom,
                   7037: span.LC_prior_reaction,
                   7038: span.LC_prior_math {
1.925     bisitz   7039:   font-family: $mono;
1.523     albertel 7040:   white-space: pre;
                   7041: }
                   7042: 
1.525     albertel 7043: span.LC_prior_string {
1.925     bisitz   7044:   font-family: $mono;
1.525     albertel 7045:   white-space: pre;
                   7046: }
                   7047: 
1.523     albertel 7048: table.LC_prior_option {
                   7049:   width: 100%;
                   7050:   border-collapse: collapse;
                   7051: }
1.795     www      7052: 
1.911     bisitz   7053: table.LC_prior_rank,
1.795     www      7054: table.LC_prior_match {
1.528     albertel 7055:   border-collapse: collapse;
                   7056: }
1.795     www      7057: 
1.528     albertel 7058: table.LC_prior_option tr td,
                   7059: table.LC_prior_rank tr td,
                   7060: table.LC_prior_match tr td {
1.524     albertel 7061:   border: 1px solid #000000;
1.515     albertel 7062: }
                   7063: 
1.855     bisitz   7064: .LC_nobreak {
1.544     albertel 7065:   white-space: nowrap;
1.519     raeburn  7066: }
                   7067: 
1.576     raeburn  7068: span.LC_cusr_emph {
                   7069:   font-style: italic;
                   7070: }
                   7071: 
1.633     raeburn  7072: span.LC_cusr_subheading {
                   7073:   font-weight: normal;
                   7074:   font-size: 85%;
                   7075: }
                   7076: 
1.861     bisitz   7077: div.LC_docs_entry_move {
1.859     bisitz   7078:   border: 1px solid #BBBBBB;
1.545     albertel 7079:   background: #DDDDDD;
1.861     bisitz   7080:   width: 22px;
1.859     bisitz   7081:   padding: 1px;
                   7082:   margin: 0;
1.545     albertel 7083: }
                   7084: 
1.861     bisitz   7085: table.LC_data_table tr > td.LC_docs_entry_commands,
                   7086: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 7087:   font-size: x-small;
                   7088: }
1.795     www      7089: 
1.861     bisitz   7090: .LC_docs_entry_parameter {
                   7091:   white-space: nowrap;
                   7092: }
                   7093: 
1.544     albertel 7094: .LC_docs_copy {
1.545     albertel 7095:   color: #000099;
1.544     albertel 7096: }
1.795     www      7097: 
1.544     albertel 7098: .LC_docs_cut {
1.545     albertel 7099:   color: #550044;
1.544     albertel 7100: }
1.795     www      7101: 
1.544     albertel 7102: .LC_docs_rename {
1.545     albertel 7103:   color: #009900;
1.544     albertel 7104: }
1.795     www      7105: 
1.544     albertel 7106: .LC_docs_remove {
1.545     albertel 7107:   color: #990000;
                   7108: }
                   7109: 
1.1075.2.134  raeburn  7110: .LC_domprefs_email,
1.547     albertel 7111: .LC_docs_reinit_warn,
                   7112: .LC_docs_ext_edit {
                   7113:   font-size: x-small;
                   7114: }
                   7115: 
1.545     albertel 7116: table.LC_docs_adddocs td,
                   7117: table.LC_docs_adddocs th {
                   7118:   border: 1px solid #BBBBBB;
                   7119:   padding: 4px;
                   7120:   background: #DDDDDD;
1.543     albertel 7121: }
                   7122: 
1.584     albertel 7123: table.LC_sty_begin {
                   7124:   background: #BBFFBB;
                   7125: }
1.795     www      7126: 
1.584     albertel 7127: table.LC_sty_end {
                   7128:   background: #FFBBBB;
                   7129: }
                   7130: 
1.589     raeburn  7131: table.LC_double_column {
1.803     bisitz   7132:   border-width: 0;
1.589     raeburn  7133:   border-collapse: collapse;
                   7134:   width: 100%;
                   7135:   padding: 2px;
                   7136: }
                   7137: 
                   7138: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  7139:   top: 2px;
1.589     raeburn  7140:   left: 2px;
                   7141:   width: 47%;
                   7142:   vertical-align: top;
                   7143: }
                   7144: 
                   7145: table.LC_double_column tr td.LC_right_col {
                   7146:   top: 2px;
1.779     bisitz   7147:   right: 2px;
1.589     raeburn  7148:   width: 47%;
                   7149:   vertical-align: top;
                   7150: }
                   7151: 
1.591     raeburn  7152: div.LC_left_float {
                   7153:   float: left;
                   7154:   padding-right: 5%;
1.597     albertel 7155:   padding-bottom: 4px;
1.591     raeburn  7156: }
                   7157: 
                   7158: div.LC_clear_float_header {
1.597     albertel 7159:   padding-bottom: 2px;
1.591     raeburn  7160: }
                   7161: 
                   7162: div.LC_clear_float_footer {
1.597     albertel 7163:   padding-top: 10px;
1.591     raeburn  7164:   clear: both;
                   7165: }
                   7166: 
1.597     albertel 7167: div.LC_grade_show_user {
1.941     bisitz   7168: /*  border-left: 5px solid $sidebg; */
                   7169:   border-top: 5px solid #000000;
                   7170:   margin: 50px 0 0 0;
1.936     bisitz   7171:   padding: 15px 0 5px 10px;
1.597     albertel 7172: }
1.795     www      7173: 
1.936     bisitz   7174: div.LC_grade_show_user_odd_row {
1.941     bisitz   7175: /*  border-left: 5px solid #000000; */
                   7176: }
                   7177: 
                   7178: div.LC_grade_show_user div.LC_Box {
                   7179:   margin-right: 50px;
1.597     albertel 7180: }
                   7181: 
                   7182: div.LC_grade_submissions,
                   7183: div.LC_grade_message_center,
1.936     bisitz   7184: div.LC_grade_info_links {
1.597     albertel 7185:   margin: 5px;
                   7186:   width: 99%;
                   7187:   background: #FFFFFF;
                   7188: }
1.795     www      7189: 
1.597     albertel 7190: div.LC_grade_submissions_header,
1.936     bisitz   7191: div.LC_grade_message_center_header {
1.705     tempelho 7192:   font-weight: bold;
                   7193:   font-size: large;
1.597     albertel 7194: }
1.795     www      7195: 
1.597     albertel 7196: div.LC_grade_submissions_body,
1.936     bisitz   7197: div.LC_grade_message_center_body {
1.597     albertel 7198:   border: 1px solid black;
                   7199:   width: 99%;
                   7200:   background: #FFFFFF;
                   7201: }
1.795     www      7202: 
1.613     albertel 7203: table.LC_scantron_action {
                   7204:   width: 100%;
                   7205: }
1.795     www      7206: 
1.613     albertel 7207: table.LC_scantron_action tr th {
1.698     harmsja  7208:   font-weight:bold;
                   7209:   font-style:normal;
1.613     albertel 7210: }
1.795     www      7211: 
1.779     bisitz   7212: .LC_edit_problem_header,
1.614     albertel 7213: div.LC_edit_problem_footer {
1.705     tempelho 7214:   font-weight: normal;
                   7215:   font-size:  medium;
1.602     albertel 7216:   margin: 2px;
1.1060    bisitz   7217:   background-color: $sidebg;
1.600     albertel 7218: }
1.795     www      7219: 
1.600     albertel 7220: div.LC_edit_problem_header,
1.602     albertel 7221: div.LC_edit_problem_header div,
1.614     albertel 7222: div.LC_edit_problem_footer,
                   7223: div.LC_edit_problem_footer div,
1.602     albertel 7224: div.LC_edit_problem_editxml_header,
                   7225: div.LC_edit_problem_editxml_header div {
1.1075.2.112  raeburn  7226:   z-index: 100;
1.600     albertel 7227: }
1.795     www      7228: 
1.600     albertel 7229: div.LC_edit_problem_header_title {
1.705     tempelho 7230:   font-weight: bold;
                   7231:   font-size: larger;
1.602     albertel 7232:   background: $tabbg;
                   7233:   padding: 3px;
1.1060    bisitz   7234:   margin: 0 0 5px 0;
1.602     albertel 7235: }
1.795     www      7236: 
1.602     albertel 7237: table.LC_edit_problem_header_title {
                   7238:   width: 100%;
1.600     albertel 7239:   background: $tabbg;
1.602     albertel 7240: }
                   7241: 
1.1075.2.112  raeburn  7242: div.LC_edit_actionbar {
                   7243:     background-color: $sidebg;
                   7244:     margin: 0;
                   7245:     padding: 0;
                   7246:     line-height: 200%;
1.602     albertel 7247: }
1.795     www      7248: 
1.1075.2.112  raeburn  7249: div.LC_edit_actionbar div{
                   7250:     padding: 0;
                   7251:     margin: 0;
                   7252:     display: inline-block;
1.600     albertel 7253: }
1.795     www      7254: 
1.1075.2.34  raeburn  7255: .LC_edit_opt {
                   7256:   padding-left: 1em;
                   7257:   white-space: nowrap;
                   7258: }
                   7259: 
1.1075.2.57  raeburn  7260: .LC_edit_problem_latexhelper{
                   7261:     text-align: right;
                   7262: }
                   7263: 
                   7264: #LC_edit_problem_colorful div{
                   7265:     margin-left: 40px;
                   7266: }
                   7267: 
1.1075.2.112  raeburn  7268: #LC_edit_problem_codemirror div{
                   7269:     margin-left: 0px;
                   7270: }
                   7271: 
1.911     bisitz   7272: img.stift {
1.803     bisitz   7273:   border-width: 0;
                   7274:   vertical-align: middle;
1.677     riegler  7275: }
1.680     riegler  7276: 
1.923     bisitz   7277: table td.LC_mainmenu_col_fieldset {
1.680     riegler  7278:   vertical-align: top;
1.777     tempelho 7279: }
1.795     www      7280: 
1.716     raeburn  7281: div.LC_createcourse {
1.911     bisitz   7282:   margin: 10px 10px 10px 10px;
1.716     raeburn  7283: }
                   7284: 
1.917     raeburn  7285: .LC_dccid {
1.1075.2.38  raeburn  7286:   float: right;
1.917     raeburn  7287:   margin: 0.2em 0 0 0;
                   7288:   padding: 0;
                   7289:   font-size: 90%;
                   7290:   display:none;
                   7291: }
                   7292: 
1.897     wenzelju 7293: ol.LC_primary_menu a:hover,
1.721     harmsja  7294: ol#LC_MenuBreadcrumbs a:hover,
                   7295: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 7296: ul#LC_secondary_menu a:hover,
1.721     harmsja  7297: .LC_FormSectionClearButton input:hover
1.795     www      7298: ul.LC_TabContent   li:hover a {
1.952     onken    7299:   color:$button_hover;
1.911     bisitz   7300:   text-decoration:none;
1.693     droeschl 7301: }
                   7302: 
1.779     bisitz   7303: h1 {
1.911     bisitz   7304:   padding: 0;
                   7305:   line-height:130%;
1.693     droeschl 7306: }
1.698     harmsja  7307: 
1.911     bisitz   7308: h2,
                   7309: h3,
                   7310: h4,
                   7311: h5,
                   7312: h6 {
                   7313:   margin: 5px 0 5px 0;
                   7314:   padding: 0;
                   7315:   line-height:130%;
1.693     droeschl 7316: }
1.795     www      7317: 
                   7318: .LC_hcell {
1.911     bisitz   7319:   padding:3px 15px 3px 15px;
                   7320:   margin: 0;
                   7321:   background-color:$tabbg;
                   7322:   color:$fontmenu;
                   7323:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 7324: }
1.795     www      7325: 
1.840     bisitz   7326: .LC_Box > .LC_hcell {
1.911     bisitz   7327:   margin: 0 -10px 10px -10px;
1.835     bisitz   7328: }
                   7329: 
1.721     harmsja  7330: .LC_noBorder {
1.911     bisitz   7331:   border: 0;
1.698     harmsja  7332: }
1.693     droeschl 7333: 
1.721     harmsja  7334: .LC_FormSectionClearButton input {
1.911     bisitz   7335:   background-color:transparent;
                   7336:   border: none;
                   7337:   cursor:pointer;
                   7338:   text-decoration:underline;
1.693     droeschl 7339: }
1.763     bisitz   7340: 
                   7341: .LC_help_open_topic {
1.911     bisitz   7342:   color: #FFFFFF;
                   7343:   background-color: #EEEEFF;
                   7344:   margin: 1px;
                   7345:   padding: 4px;
                   7346:   border: 1px solid #000033;
                   7347:   white-space: nowrap;
                   7348:   /* vertical-align: middle; */
1.759     neumanie 7349: }
1.693     droeschl 7350: 
1.911     bisitz   7351: dl,
                   7352: ul,
                   7353: div,
                   7354: fieldset {
                   7355:   margin: 10px 10px 10px 0;
                   7356:   /* overflow: hidden; */
1.693     droeschl 7357: }
1.795     www      7358: 
1.1075.2.90  raeburn  7359: article.geogebraweb div {
                   7360:     margin: 0;
                   7361: }
                   7362: 
1.838     bisitz   7363: fieldset > legend {
1.911     bisitz   7364:   font-weight: bold;
                   7365:   padding: 0 5px 0 5px;
1.838     bisitz   7366: }
                   7367: 
1.813     bisitz   7368: #LC_nav_bar {
1.911     bisitz   7369:   float: left;
1.995     raeburn  7370:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   7371:   margin: 0 0 2px 0;
1.807     droeschl 7372: }
                   7373: 
1.916     droeschl 7374: #LC_realm {
                   7375:   margin: 0.2em 0 0 0;
                   7376:   padding: 0;
                   7377:   font-weight: bold;
                   7378:   text-align: center;
1.995     raeburn  7379:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 7380: }
                   7381: 
1.911     bisitz   7382: #LC_nav_bar em {
                   7383:   font-weight: bold;
                   7384:   font-style: normal;
1.807     droeschl 7385: }
                   7386: 
1.897     wenzelju 7387: ol.LC_primary_menu {
1.934     droeschl 7388:   margin: 0;
1.1075.2.2  raeburn  7389:   padding: 0;
1.807     droeschl 7390: }
                   7391: 
1.852     droeschl 7392: ol#LC_PathBreadcrumbs {
1.911     bisitz   7393:   margin: 0;
1.693     droeschl 7394: }
                   7395: 
1.897     wenzelju 7396: ol.LC_primary_menu li {
1.1075.2.2  raeburn  7397:   color: RGB(80, 80, 80);
                   7398:   vertical-align: middle;
                   7399:   text-align: left;
                   7400:   list-style: none;
1.1075.2.112  raeburn  7401:   position: relative;
1.1075.2.2  raeburn  7402:   float: left;
1.1075.2.112  raeburn  7403:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   7404:   line-height: 1.5em;
1.1075.2.2  raeburn  7405: }
                   7406: 
1.1075.2.113  raeburn  7407: ol.LC_primary_menu li a, 
1.1075.2.112  raeburn  7408: ol.LC_primary_menu li p {
1.1075.2.2  raeburn  7409:   display: block;
                   7410:   margin: 0;
                   7411:   padding: 0 5px 0 10px;
                   7412:   text-decoration: none;
                   7413: }
                   7414: 
1.1075.2.112  raeburn  7415: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   7416:   display: inline-block;
                   7417:   width: 95%;
                   7418:   text-align: left;
                   7419: }
                   7420: 
                   7421: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   7422:   display: inline-block;
                   7423:   width: 5%;
                   7424:   float: right;
                   7425:   text-align: right;
                   7426:   font-size: 70%;
                   7427: }
                   7428: 
                   7429: ol.LC_primary_menu ul {
1.1075.2.2  raeburn  7430:   display: none;
1.1075.2.112  raeburn  7431:   width: 15em;
1.1075.2.2  raeburn  7432:   background-color: $data_table_light;
1.1075.2.112  raeburn  7433:   position: absolute;
                   7434:   top: 100%;
                   7435: }
                   7436: 
                   7437: ol.LC_primary_menu ul ul {
                   7438:   left: 100%;
                   7439:   top: 0;
1.1075.2.2  raeburn  7440: }
                   7441: 
1.1075.2.112  raeburn  7442: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2  raeburn  7443:   display: block;
                   7444:   position: absolute;
                   7445:   margin: 0;
                   7446:   padding: 0;
1.1075.2.5  raeburn  7447:   z-index: 2;
1.1075.2.2  raeburn  7448: }
                   7449: 
                   7450: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112  raeburn  7451: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2  raeburn  7452:   font-size: 90%;
1.911     bisitz   7453:   vertical-align: top;
1.1075.2.2  raeburn  7454:   float: none;
1.1075.2.5  raeburn  7455:   border-left: 1px solid black;
                   7456:   border-right: 1px solid black;
1.1075.2.112  raeburn  7457: /* A dark bottom border to visualize different menu options;
                   7458: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7459:   border-bottom: 1px solid $data_table_dark;
1.1075.2.2  raeburn  7460: }
                   7461: 
1.1075.2.112  raeburn  7462: ol.LC_primary_menu li li p:hover {
                   7463:   color:$button_hover;
                   7464:   text-decoration:none;
                   7465:   background-color:$data_table_dark;
1.1075.2.2  raeburn  7466: }
                   7467: 
                   7468: ol.LC_primary_menu li li a:hover {
                   7469:    color:$button_hover;
                   7470:    background-color:$data_table_dark;
1.693     droeschl 7471: }
                   7472: 
1.1075.2.112  raeburn  7473: /* Font-size equal to the size of the predecessors*/
                   7474: ol.LC_primary_menu li:hover li li {
                   7475:   font-size: 100%;
                   7476: }
                   7477: 
1.897     wenzelju 7478: ol.LC_primary_menu li img {
1.911     bisitz   7479:   vertical-align: bottom;
1.934     droeschl 7480:   height: 1.1em;
1.1075.2.3  raeburn  7481:   margin: 0.2em 0 0 0;
1.693     droeschl 7482: }
                   7483: 
1.897     wenzelju 7484: ol.LC_primary_menu a {
1.911     bisitz   7485:   color: RGB(80, 80, 80);
                   7486:   text-decoration: none;
1.693     droeschl 7487: }
1.795     www      7488: 
1.949     droeschl 7489: ol.LC_primary_menu a.LC_new_message {
                   7490:   font-weight:bold;
                   7491:   color: darkred;
                   7492: }
                   7493: 
1.975     raeburn  7494: ol.LC_docs_parameters {
                   7495:   margin-left: 0;
                   7496:   padding: 0;
                   7497:   list-style: none;
                   7498: }
                   7499: 
                   7500: ol.LC_docs_parameters li {
                   7501:   margin: 0;
                   7502:   padding-right: 20px;
                   7503:   display: inline;
                   7504: }
                   7505: 
1.976     raeburn  7506: ol.LC_docs_parameters li:before {
                   7507:   content: "\\002022 \\0020";
                   7508: }
                   7509: 
                   7510: li.LC_docs_parameters_title {
                   7511:   font-weight: bold;
                   7512: }
                   7513: 
                   7514: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7515:   content: "";
                   7516: }
                   7517: 
1.897     wenzelju 7518: ul#LC_secondary_menu {
1.1075.2.23  raeburn  7519:   clear: right;
1.911     bisitz   7520:   color: $fontmenu;
                   7521:   background: $tabbg;
                   7522:   list-style: none;
                   7523:   padding: 0;
                   7524:   margin: 0;
                   7525:   width: 100%;
1.995     raeburn  7526:   text-align: left;
1.1075.2.4  raeburn  7527:   float: left;
1.808     droeschl 7528: }
                   7529: 
1.897     wenzelju 7530: ul#LC_secondary_menu li {
1.911     bisitz   7531:   font-weight: bold;
                   7532:   line-height: 1.8em;
                   7533:   border-right: 1px solid black;
1.1075.2.4  raeburn  7534:   float: left;
                   7535: }
                   7536: 
                   7537: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7538:   background-color: $data_table_light;
                   7539: }
                   7540: 
                   7541: ul#LC_secondary_menu li a {
                   7542:   padding: 0 0.8em;
                   7543: }
                   7544: 
                   7545: ul#LC_secondary_menu li ul {
                   7546:   display: none;
                   7547: }
                   7548: 
                   7549: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7550:   display: block;
                   7551:   position: absolute;
                   7552:   margin: 0;
                   7553:   padding: 0;
                   7554:   list-style:none;
                   7555:   float: none;
                   7556:   background-color: $data_table_light;
1.1075.2.5  raeburn  7557:   z-index: 2;
1.1075.2.10  raeburn  7558:   margin-left: -1px;
1.1075.2.4  raeburn  7559: }
                   7560: 
                   7561: ul#LC_secondary_menu li ul li {
                   7562:   font-size: 90%;
                   7563:   vertical-align: top;
                   7564:   border-left: 1px solid black;
                   7565:   border-right: 1px solid black;
1.1075.2.33  raeburn  7566:   background-color: $data_table_light;
1.1075.2.4  raeburn  7567:   list-style:none;
                   7568:   float: none;
                   7569: }
                   7570: 
                   7571: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7572:   background-color: $data_table_dark;
1.807     droeschl 7573: }
                   7574: 
1.847     tempelho 7575: ul.LC_TabContent {
1.911     bisitz   7576:   display:block;
                   7577:   background: $sidebg;
                   7578:   border-bottom: solid 1px $lg_border_color;
                   7579:   list-style:none;
1.1020    raeburn  7580:   margin: -1px -10px 0 -10px;
1.911     bisitz   7581:   padding: 0;
1.693     droeschl 7582: }
                   7583: 
1.795     www      7584: ul.LC_TabContent li,
                   7585: ul.LC_TabContentBigger li {
1.911     bisitz   7586:   float:left;
1.741     harmsja  7587: }
1.795     www      7588: 
1.897     wenzelju 7589: ul#LC_secondary_menu li a {
1.911     bisitz   7590:   color: $fontmenu;
                   7591:   text-decoration: none;
1.693     droeschl 7592: }
1.795     www      7593: 
1.721     harmsja  7594: ul.LC_TabContent {
1.952     onken    7595:   min-height:20px;
1.721     harmsja  7596: }
1.795     www      7597: 
                   7598: ul.LC_TabContent li {
1.911     bisitz   7599:   vertical-align:middle;
1.959     onken    7600:   padding: 0 16px 0 10px;
1.911     bisitz   7601:   background-color:$tabbg;
                   7602:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7603:   border-left: solid 1px $font;
1.721     harmsja  7604: }
1.795     www      7605: 
1.847     tempelho 7606: ul.LC_TabContent .right {
1.911     bisitz   7607:   float:right;
1.847     tempelho 7608: }
                   7609: 
1.911     bisitz   7610: ul.LC_TabContent li a,
                   7611: ul.LC_TabContent li {
                   7612:   color:rgb(47,47,47);
                   7613:   text-decoration:none;
                   7614:   font-size:95%;
                   7615:   font-weight:bold;
1.952     onken    7616:   min-height:20px;
                   7617: }
                   7618: 
1.959     onken    7619: ul.LC_TabContent li a:hover,
                   7620: ul.LC_TabContent li a:focus {
1.952     onken    7621:   color: $button_hover;
1.959     onken    7622:   background:none;
                   7623:   outline:none;
1.952     onken    7624: }
                   7625: 
                   7626: ul.LC_TabContent li:hover {
                   7627:   color: $button_hover;
                   7628:   cursor:pointer;
1.721     harmsja  7629: }
1.795     www      7630: 
1.911     bisitz   7631: ul.LC_TabContent li.active {
1.952     onken    7632:   color: $font;
1.911     bisitz   7633:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7634:   border-bottom:solid 1px #FFFFFF;
                   7635:   cursor: default;
1.744     ehlerst  7636: }
1.795     www      7637: 
1.959     onken    7638: ul.LC_TabContent li.active a {
                   7639:   color:$font;
                   7640:   background:#FFFFFF;
                   7641:   outline: none;
                   7642: }
1.1047    raeburn  7643: 
                   7644: ul.LC_TabContent li.goback {
                   7645:   float: left;
                   7646:   border-left: none;
                   7647: }
                   7648: 
1.870     tempelho 7649: #maincoursedoc {
1.911     bisitz   7650:   clear:both;
1.870     tempelho 7651: }
                   7652: 
                   7653: ul.LC_TabContentBigger {
1.911     bisitz   7654:   display:block;
                   7655:   list-style:none;
                   7656:   padding: 0;
1.870     tempelho 7657: }
                   7658: 
1.795     www      7659: ul.LC_TabContentBigger li {
1.911     bisitz   7660:   vertical-align:bottom;
                   7661:   height: 30px;
                   7662:   font-size:110%;
                   7663:   font-weight:bold;
                   7664:   color: #737373;
1.841     tempelho 7665: }
                   7666: 
1.957     onken    7667: ul.LC_TabContentBigger li.active {
                   7668:   position: relative;
                   7669:   top: 1px;
                   7670: }
                   7671: 
1.870     tempelho 7672: ul.LC_TabContentBigger li a {
1.911     bisitz   7673:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7674:   height: 30px;
                   7675:   line-height: 30px;
                   7676:   text-align: center;
                   7677:   display: block;
                   7678:   text-decoration: none;
1.958     onken    7679:   outline: none;  
1.741     harmsja  7680: }
1.795     www      7681: 
1.870     tempelho 7682: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7683:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7684:   color:$font;
1.744     ehlerst  7685: }
1.795     www      7686: 
1.870     tempelho 7687: ul.LC_TabContentBigger li b {
1.911     bisitz   7688:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7689:   display: block;
                   7690:   float: left;
                   7691:   padding: 0 30px;
1.957     onken    7692:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7693: }
                   7694: 
1.956     onken    7695: ul.LC_TabContentBigger li:hover b {
                   7696:   color:$button_hover;
                   7697: }
                   7698: 
1.870     tempelho 7699: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7700:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7701:   color:$font;
1.957     onken    7702:   border: 0;
1.741     harmsja  7703: }
1.693     droeschl 7704: 
1.870     tempelho 7705: 
1.862     bisitz   7706: ul.LC_CourseBreadcrumbs {
                   7707:   background: $sidebg;
1.1020    raeburn  7708:   height: 2em;
1.862     bisitz   7709:   padding-left: 10px;
1.1020    raeburn  7710:   margin: 0;
1.862     bisitz   7711:   list-style-position: inside;
                   7712: }
                   7713: 
1.911     bisitz   7714: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7715: ol#LC_PathBreadcrumbs {
1.911     bisitz   7716:   padding-left: 10px;
                   7717:   margin: 0;
1.933     droeschl 7718:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7719: }
                   7720: 
1.911     bisitz   7721: ol#LC_MenuBreadcrumbs li,
                   7722: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7723: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7724:   display: inline;
1.933     droeschl 7725:   white-space: normal;  
1.693     droeschl 7726: }
                   7727: 
1.823     bisitz   7728: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7729: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7730:   text-decoration: none;
                   7731:   font-size:90%;
1.693     droeschl 7732: }
1.795     www      7733: 
1.969     droeschl 7734: ol#LC_MenuBreadcrumbs h1 {
                   7735:   display: inline;
                   7736:   font-size: 90%;
                   7737:   line-height: 2.5em;
                   7738:   margin: 0;
                   7739:   padding: 0;
                   7740: }
                   7741: 
1.795     www      7742: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7743:   text-decoration:none;
                   7744:   font-size:100%;
                   7745:   font-weight:bold;
1.693     droeschl 7746: }
1.795     www      7747: 
1.840     bisitz   7748: .LC_Box {
1.911     bisitz   7749:   border: solid 1px $lg_border_color;
                   7750:   padding: 0 10px 10px 10px;
1.746     neumanie 7751: }
1.795     www      7752: 
1.1020    raeburn  7753: .LC_DocsBox {
                   7754:   border: solid 1px $lg_border_color;
                   7755:   padding: 0 0 10px 10px;
                   7756: }
                   7757: 
1.795     www      7758: .LC_AboutMe_Image {
1.911     bisitz   7759:   float:left;
                   7760:   margin-right:10px;
1.747     neumanie 7761: }
1.795     www      7762: 
                   7763: .LC_Clear_AboutMe_Image {
1.911     bisitz   7764:   clear:left;
1.747     neumanie 7765: }
1.795     www      7766: 
1.721     harmsja  7767: dl.LC_ListStyleClean dt {
1.911     bisitz   7768:   padding-right: 5px;
                   7769:   display: table-header-group;
1.693     droeschl 7770: }
                   7771: 
1.721     harmsja  7772: dl.LC_ListStyleClean dd {
1.911     bisitz   7773:   display: table-row;
1.693     droeschl 7774: }
                   7775: 
1.721     harmsja  7776: .LC_ListStyleClean,
                   7777: .LC_ListStyleSimple,
                   7778: .LC_ListStyleNormal,
1.795     www      7779: .LC_ListStyleSpecial {
1.911     bisitz   7780:   /* display:block; */
                   7781:   list-style-position: inside;
                   7782:   list-style-type: none;
                   7783:   overflow: hidden;
                   7784:   padding: 0;
1.693     droeschl 7785: }
                   7786: 
1.721     harmsja  7787: .LC_ListStyleSimple li,
                   7788: .LC_ListStyleSimple dd,
                   7789: .LC_ListStyleNormal li,
                   7790: .LC_ListStyleNormal dd,
                   7791: .LC_ListStyleSpecial li,
1.795     www      7792: .LC_ListStyleSpecial dd {
1.911     bisitz   7793:   margin: 0;
                   7794:   padding: 5px 5px 5px 10px;
                   7795:   clear: both;
1.693     droeschl 7796: }
                   7797: 
1.721     harmsja  7798: .LC_ListStyleClean li,
                   7799: .LC_ListStyleClean dd {
1.911     bisitz   7800:   padding-top: 0;
                   7801:   padding-bottom: 0;
1.693     droeschl 7802: }
                   7803: 
1.721     harmsja  7804: .LC_ListStyleSimple dd,
1.795     www      7805: .LC_ListStyleSimple li {
1.911     bisitz   7806:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 7807: }
                   7808: 
1.721     harmsja  7809: .LC_ListStyleSpecial li,
                   7810: .LC_ListStyleSpecial dd {
1.911     bisitz   7811:   list-style-type: none;
                   7812:   background-color: RGB(220, 220, 220);
                   7813:   margin-bottom: 4px;
1.693     droeschl 7814: }
                   7815: 
1.721     harmsja  7816: table.LC_SimpleTable {
1.911     bisitz   7817:   margin:5px;
                   7818:   border:solid 1px $lg_border_color;
1.795     www      7819: }
1.693     droeschl 7820: 
1.721     harmsja  7821: table.LC_SimpleTable tr {
1.911     bisitz   7822:   padding: 0;
                   7823:   border:solid 1px $lg_border_color;
1.693     droeschl 7824: }
1.795     www      7825: 
                   7826: table.LC_SimpleTable thead {
1.911     bisitz   7827:   background:rgb(220,220,220);
1.693     droeschl 7828: }
                   7829: 
1.721     harmsja  7830: div.LC_columnSection {
1.911     bisitz   7831:   display: block;
                   7832:   clear: both;
                   7833:   overflow: hidden;
                   7834:   margin: 0;
1.693     droeschl 7835: }
                   7836: 
1.721     harmsja  7837: div.LC_columnSection>* {
1.911     bisitz   7838:   float: left;
                   7839:   margin: 10px 20px 10px 0;
                   7840:   overflow:hidden;
1.693     droeschl 7841: }
1.721     harmsja  7842: 
1.795     www      7843: table em {
1.911     bisitz   7844:   font-weight: bold;
                   7845:   font-style: normal;
1.748     schulted 7846: }
1.795     www      7847: 
1.779     bisitz   7848: table.LC_tableBrowseRes,
1.795     www      7849: table.LC_tableOfContent {
1.911     bisitz   7850:   border:none;
                   7851:   border-spacing: 1px;
                   7852:   padding: 3px;
                   7853:   background-color: #FFFFFF;
                   7854:   font-size: 90%;
1.753     droeschl 7855: }
1.789     droeschl 7856: 
1.911     bisitz   7857: table.LC_tableOfContent {
                   7858:   border-collapse: collapse;
1.789     droeschl 7859: }
                   7860: 
1.771     droeschl 7861: table.LC_tableBrowseRes a,
1.768     schulted 7862: table.LC_tableOfContent a {
1.911     bisitz   7863:   background-color: transparent;
                   7864:   text-decoration: none;
1.753     droeschl 7865: }
                   7866: 
1.795     www      7867: table.LC_tableOfContent img {
1.911     bisitz   7868:   border: none;
                   7869:   height: 1.3em;
                   7870:   vertical-align: text-bottom;
                   7871:   margin-right: 0.3em;
1.753     droeschl 7872: }
1.757     schulted 7873: 
1.795     www      7874: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7875:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7876: }
                   7877: 
1.795     www      7878: a#LC_content_toolbar_everything {
1.911     bisitz   7879:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7880: }
                   7881: 
1.795     www      7882: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7883:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7884: }
                   7885: 
1.795     www      7886: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7887:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7888: }
                   7889: 
1.795     www      7890: a#LC_content_toolbar_changefolder {
1.911     bisitz   7891:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7892: }
                   7893: 
1.795     www      7894: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7895:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7896: }
                   7897: 
1.1043    raeburn  7898: a#LC_content_toolbar_edittoplevel {
                   7899:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7900: }
                   7901: 
1.795     www      7902: ul#LC_toolbar li a:hover {
1.911     bisitz   7903:   background-position: bottom center;
1.757     schulted 7904: }
                   7905: 
1.795     www      7906: ul#LC_toolbar {
1.911     bisitz   7907:   padding: 0;
                   7908:   margin: 2px;
                   7909:   list-style:none;
                   7910:   position:relative;
                   7911:   background-color:white;
1.1075.2.9  raeburn  7912:   overflow: auto;
1.757     schulted 7913: }
                   7914: 
1.795     www      7915: ul#LC_toolbar li {
1.911     bisitz   7916:   border:1px solid white;
                   7917:   padding: 0;
                   7918:   margin: 0;
                   7919:   float: left;
                   7920:   display:inline;
                   7921:   vertical-align:middle;
1.1075.2.9  raeburn  7922:   white-space: nowrap;
1.911     bisitz   7923: }
1.757     schulted 7924: 
1.783     amueller 7925: 
1.795     www      7926: a.LC_toolbarItem {
1.911     bisitz   7927:   display:block;
                   7928:   padding: 0;
                   7929:   margin: 0;
                   7930:   height: 32px;
                   7931:   width: 32px;
                   7932:   color:white;
                   7933:   border: none;
                   7934:   background-repeat:no-repeat;
                   7935:   background-color:transparent;
1.757     schulted 7936: }
                   7937: 
1.915     droeschl 7938: ul.LC_funclist {
                   7939:     margin: 0;
                   7940:     padding: 0.5em 1em 0.5em 0;
                   7941: }
                   7942: 
1.933     droeschl 7943: ul.LC_funclist > li:first-child {
                   7944:     font-weight:bold; 
                   7945:     margin-left:0.8em;
                   7946: }
                   7947: 
1.915     droeschl 7948: ul.LC_funclist + ul.LC_funclist {
                   7949:     /* 
                   7950:        left border as a seperator if we have more than
                   7951:        one list 
                   7952:     */
                   7953:     border-left: 1px solid $sidebg;
                   7954:     /* 
                   7955:        this hides the left border behind the border of the 
                   7956:        outer box if element is wrapped to the next 'line' 
                   7957:     */
                   7958:     margin-left: -1px;
                   7959: }
                   7960: 
1.843     bisitz   7961: ul.LC_funclist li {
1.915     droeschl 7962:   display: inline;
1.782     bisitz   7963:   white-space: nowrap;
1.915     droeschl 7964:   margin: 0 0 0 25px;
                   7965:   line-height: 150%;
1.782     bisitz   7966: }
                   7967: 
1.974     wenzelju 7968: .LC_hidden {
                   7969:   display: none;
                   7970: }
                   7971: 
1.1030    www      7972: .LCmodal-overlay {
                   7973: 		position:fixed;
                   7974: 		top:0;
                   7975: 		right:0;
                   7976: 		bottom:0;
                   7977: 		left:0;
                   7978: 		height:100%;
                   7979: 		width:100%;
                   7980: 		margin:0;
                   7981: 		padding:0;
                   7982: 		background:#999;
                   7983: 		opacity:.75;
                   7984: 		filter: alpha(opacity=75);
                   7985: 		-moz-opacity: 0.75;
                   7986: 		z-index:101;
                   7987: }
                   7988: 
                   7989: * html .LCmodal-overlay {   
                   7990: 		position: absolute;
                   7991: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7992: }
                   7993: 
                   7994: .LCmodal-window {
                   7995: 		position:fixed;
                   7996: 		top:50%;
                   7997: 		left:50%;
                   7998: 		margin:0;
                   7999: 		padding:0;
                   8000: 		z-index:102;
                   8001: 	}
                   8002: 
                   8003: * html .LCmodal-window {
                   8004: 		position:absolute;
                   8005: }
                   8006: 
                   8007: .LCclose-window {
                   8008: 		position:absolute;
                   8009: 		width:32px;
                   8010: 		height:32px;
                   8011: 		right:8px;
                   8012: 		top:8px;
                   8013: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   8014: 		text-indent:-99999px;
                   8015: 		overflow:hidden;
                   8016: 		cursor:pointer;
                   8017: }
                   8018: 
1.1075.2.158  raeburn  8019: .LCisDisabled {
                   8020:   cursor: not-allowed;
                   8021:   opacity: 0.5;
                   8022: }
                   8023: 
                   8024: a[aria-disabled="true"] {
                   8025:   color: currentColor;
                   8026:   display: inline-block;  /* For IE11/ MS Edge bug */
                   8027:   pointer-events: none;
                   8028:   text-decoration: none;
                   8029: }
                   8030: 
1.1075.2.141  raeburn  8031: pre.LC_wordwrap {
                   8032:   white-space: pre-wrap;
                   8033:   white-space: -moz-pre-wrap;
                   8034:   white-space: -pre-wrap;
                   8035:   white-space: -o-pre-wrap;
                   8036:   word-wrap: break-word;
                   8037: }
                   8038: 
1.1075.2.17  raeburn  8039: /*
                   8040:   styles used by TTH when "Default set of options to pass to tth/m
                   8041:   when converting TeX" in course settings has been set
                   8042: 
                   8043:   option passed: -t
                   8044: 
                   8045: */
                   8046: 
                   8047: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   8048: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   8049: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   8050: td div.norm {line-height:normal;}
                   8051: 
                   8052: /*
                   8053:   option passed -y3
                   8054: */
                   8055: 
                   8056: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   8057: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   8058: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   8059: 
1.1075.2.121  raeburn  8060: #LC_minitab_header {
                   8061:   float:left;
                   8062:   width:100%;
                   8063:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   8064:   font-size:93%;
                   8065:   line-height:normal;
                   8066:   margin: 0.5em 0 0.5em 0;
                   8067: }
                   8068: #LC_minitab_header ul {
                   8069:   margin:0;
                   8070:   padding:10px 10px 0;
                   8071:   list-style:none;
                   8072: }
                   8073: #LC_minitab_header li {
                   8074:   float:left;
                   8075:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   8076:   margin:0;
                   8077:   padding:0 0 0 9px;
                   8078: }
                   8079: #LC_minitab_header a {
                   8080:   display:block;
                   8081:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   8082:   padding:5px 15px 4px 6px;
                   8083: }
                   8084: #LC_minitab_header #LC_current_minitab {
                   8085:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   8086: }
                   8087: #LC_minitab_header #LC_current_minitab a {
                   8088:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   8089:   padding-bottom:5px;
                   8090: }
                   8091: 
                   8092: 
1.343     albertel 8093: END
                   8094: }
                   8095: 
1.306     albertel 8096: =pod
                   8097: 
                   8098: =item * &headtag()
                   8099: 
                   8100: Returns a uniform footer for LON-CAPA web pages.
                   8101: 
1.307     albertel 8102: Inputs: $title - optional title for the head
                   8103:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 8104:         $args - optional arguments
1.319     albertel 8105:             force_register - if is true call registerurl so the remote is 
                   8106:                              informed
1.415     albertel 8107:             redirect       -> array ref of
                   8108:                                    1- seconds before redirect occurs
                   8109:                                    2- url to redirect to
                   8110:                                    3- whether the side effect should occur
1.315     albertel 8111:                            (side effect of setting 
                   8112:                                $env{'internal.head.redirect'} to the url 
                   8113:                                redirected too)
1.1075.2.166  raeburn  8114:                                    4- whether encrypt check should be skipped
1.352     albertel 8115:             domain         -> force to color decorate a page for a specific
                   8116:                                domain
                   8117:             function       -> force usage of a specific rolish color scheme
                   8118:             bgcolor        -> override the default page bgcolor
1.460     albertel 8119:             no_auto_mt_title
                   8120:                            -> prevent &mt()ing the title arg
1.464     albertel 8121: 
1.306     albertel 8122: =cut
                   8123: 
                   8124: sub headtag {
1.313     albertel 8125:     my ($title,$head_extra,$args) = @_;
1.306     albertel 8126:     
1.363     albertel 8127:     my $function = $args->{'function'} || &get_users_function();
                   8128:     my $domain   = $args->{'domain'}   || &determinedomain();
                   8129:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1075.2.52  raeburn  8130:     my $httphost = $args->{'use_absolute'};
1.418     albertel 8131:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 8132: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 8133: 		   #time(),
1.418     albertel 8134: 		   $env{'environment.color.timestamp'},
1.363     albertel 8135: 		   $function,$domain,$bgcolor);
                   8136: 
1.369     www      8137:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 8138: 
1.308     albertel 8139:     my $result =
                   8140: 	'<head>'.
1.1075.2.56  raeburn  8141: 	&font_settings($args);
1.319     albertel 8142: 
1.1075.2.72  raeburn  8143:     my $inhibitprint;
                   8144:     if ($args->{'print_suppress'}) {
                   8145:         $inhibitprint = &print_suppression();
                   8146:     }
1.1064    raeburn  8147: 
1.1075.2.172  raeburn  8148:     if (!$args->{'frameset'} && !$args->{'switchserver'}) {
1.461     albertel 8149: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   8150:     }
1.1075.2.12  raeburn  8151:     if ($args->{'force_register'}) {
                   8152:         $result .= &Apache::lonmenu::registerurl(1);
1.319     albertel 8153:     }
1.436     albertel 8154:     if (!$args->{'no_nav_bar'} 
                   8155: 	&& !$args->{'only_body'}
1.1075.2.172  raeburn  8156: 	&& !$args->{'frameset'}
                   8157: 	&& !$args->{'switchserver'}) {
1.1075.2.52  raeburn  8158: 	$result .= &help_menu_js($httphost);
1.1032    www      8159:         $result.=&modal_window();
1.1038    www      8160:         $result.=&togglebox_script();
1.1034    www      8161:         $result.=&wishlist_window();
1.1041    www      8162:         $result.=&LCprogressbarUpdate_script();
1.1034    www      8163:     } else {
                   8164:         if ($args->{'add_modal'}) {
                   8165:            $result.=&modal_window();
                   8166:         }
                   8167:         if ($args->{'add_wishlist'}) {
                   8168:            $result.=&wishlist_window();
                   8169:         }
1.1038    www      8170:         if ($args->{'add_togglebox'}) {
                   8171:            $result.=&togglebox_script();
                   8172:         }
1.1041    www      8173:         if ($args->{'add_progressbar'}) {
                   8174:            $result.=&LCprogressbarUpdate_script();
                   8175:         }
1.436     albertel 8176:     }
1.314     albertel 8177:     if (ref($args->{'redirect'})) {
1.1075.2.166  raeburn  8178: 	my ($time,$url,$inhibit_continue,$skip_enc_check) = @{$args->{'redirect'}};
                   8179:         if (!$skip_enc_check) {
                   8180:             $url = &Apache::lonenc::check_encrypt($url);
                   8181:         }
1.414     albertel 8182: 	if (!$inhibit_continue) {
                   8183: 	    $env{'internal.head.redirect'} = $url;
                   8184: 	}
1.313     albertel 8185: 	$result.=<<ADDMETA
                   8186: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 8187: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 8188: ADDMETA
1.1075.2.89  raeburn  8189:     } else {
                   8190:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   8191:             my $requrl = $env{'request.uri'};
                   8192:             if ($requrl eq '') {
                   8193:                 $requrl = $ENV{'REQUEST_URI'};
                   8194:                 $requrl =~ s/\?.+$//;
                   8195:             }
                   8196:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   8197:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   8198:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   8199:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   8200:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   8201:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1075.2.145  raeburn  8202:                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1075.2.151  raeburn  8203:                     my ($offload,$offloadoth);
1.1075.2.89  raeburn  8204:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   8205:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1075.2.145  raeburn  8206:                             $offload = 1;
1.1075.2.151  raeburn  8207:                             if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8208:                                 (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8209:                                 unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8210:                                     $offloadoth = 1;
                   8211:                                     $dom_in_use = $env{'user.domain'};
                   8212:                                 }
                   8213:                             }
1.1075.2.145  raeburn  8214:                         }
                   8215:                     }
                   8216:                     unless ($offload) {
                   8217:                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   8218:                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   8219:                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8220:                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8221:                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8222:                                         $offload = 1;
1.1075.2.151  raeburn  8223:                                         $offloadoth = 1;
1.1075.2.145  raeburn  8224:                                         $dom_in_use = $env{'user.domain'};
                   8225:                                     }
1.1075.2.89  raeburn  8226:                                 }
1.1075.2.145  raeburn  8227:                             }
                   8228:                         }
                   8229:                     }
                   8230:                     if ($offload) {
1.1075.2.158  raeburn  8231:                         my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1075.2.151  raeburn  8232:                         if (($newserver eq '') && ($offloadoth)) {
                   8233:                             my @domains = &Apache::lonnet::current_machine_domains();
                   8234:                             if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) { 
                   8235:                                 ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
                   8236:                             }
                   8237:                         }
1.1075.2.145  raeburn  8238:                         if (($newserver) && ($newserver ne $lonhost)) {
                   8239:                             my $numsec = 5;
                   8240:                             my $timeout = $numsec * 1000;
                   8241:                             my ($newurl,$locknum,%locks,$msg);
                   8242:                             if ($env{'request.role.adv'}) {
                   8243:                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   8244:                             }
                   8245:                             my $disable_submit = 0;
                   8246:                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   8247:                                 $disable_submit = 1;
                   8248:                             }
                   8249:                             if ($locknum) {
                   8250:                                 my @lockinfo = sort(values(%locks));
1.1075.2.153  raeburn  8251:                                 $msg = &mt('Once the following tasks are complete:')." \n".
1.1075.2.145  raeburn  8252:                                        join(", ",sort(values(%locks)))."\n";
                   8253:                                 if (&show_course()) {
                   8254:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
1.1075.2.89  raeburn  8255:                                 } else {
1.1075.2.145  raeburn  8256:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
                   8257:                                 }
                   8258:                             } else {
                   8259:                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   8260:                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   8261:                                 }
                   8262:                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   8263:                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   8264:                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   8265:                                     $newurl .= '&role='.$env{'request.role'};
                   8266:                                 }
                   8267:                                 if ($env{'request.symb'}) {
                   8268:                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   8269:                                     if ($shownsymb =~ m{^/enc/}) {
                   8270:                                         my $reqdmajor = 2;
                   8271:                                         my $reqdminor = 11;
                   8272:                                         my $reqdsubminor = 3;
                   8273:                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   8274:                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   8275:                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   8276:                                         if (($major eq '' && $minor eq '') ||
                   8277:                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   8278:                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   8279:                                              ($reqdsubminor > $subminor))))) {
                   8280:                                             undef($shownsymb);
                   8281:                                         }
1.1075.2.89  raeburn  8282:                                     }
1.1075.2.145  raeburn  8283:                                     if ($shownsymb) {
                   8284:                                         &js_escape(\$shownsymb);
                   8285:                                         $newurl .= '&symb='.$shownsymb;
1.1075.2.89  raeburn  8286:                                     }
1.1075.2.145  raeburn  8287:                                 } else {
                   8288:                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   8289:                                     &js_escape(\$shownurl);
                   8290:                                     $newurl .= '&origurl='.$shownurl;
1.1075.2.89  raeburn  8291:                                 }
1.1075.2.145  raeburn  8292:                             }
                   8293:                             &js_escape(\$msg);
                   8294:                             $result.=<<OFFLOAD
1.1075.2.89  raeburn  8295: <meta http-equiv="pragma" content="no-cache" />
                   8296: <script type="text/javascript">
1.1075.2.92  raeburn  8297: // <![CDATA[
1.1075.2.89  raeburn  8298: function LC_Offload_Now() {
                   8299:     var dest = "$newurl";
                   8300:     if (dest != '') {
                   8301:         window.location.href="$newurl";
                   8302:     }
                   8303: }
1.1075.2.92  raeburn  8304: \$(document).ready(function () {
                   8305:     window.alert('$msg');
                   8306:     if ($disable_submit) {
1.1075.2.89  raeburn  8307:         \$(".LC_hwk_submit").prop("disabled", true);
                   8308:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92  raeburn  8309:     }
                   8310:     setTimeout('LC_Offload_Now()', $timeout);
                   8311: });
                   8312: // ]]>
1.1075.2.89  raeburn  8313: </script>
                   8314: OFFLOAD
                   8315:                         }
                   8316:                     }
                   8317:                 }
                   8318:             }
                   8319:         }
1.313     albertel 8320:     }
1.306     albertel 8321:     if (!defined($title)) {
                   8322: 	$title = 'The LearningOnline Network with CAPA';
                   8323:     }
1.460     albertel 8324:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.168  raeburn  8325:     if ($title =~ /^LON-CAPA\s+/) {
                   8326:         $result .= '<title> '.$title.'</title>';
                   8327:     } else {
                   8328:         $result .= '<title> LON-CAPA '.$title.'</title>';
                   8329:     }
                   8330:     $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1075.2.61  raeburn  8331:     if (!$args->{'frameset'}) {
                   8332:         $result .= ' /';
                   8333:     }
                   8334:     $result .= '>'
1.1064    raeburn  8335:         .$inhibitprint
1.414     albertel 8336: 	.$head_extra;
1.1075.2.108  raeburn  8337:     my $clientmobile;
                   8338:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   8339:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   8340:     } else {
                   8341:         $clientmobile = $env{'browser.mobile'};
                   8342:     }
                   8343:     if ($clientmobile) {
1.1075.2.42  raeburn  8344:         $result .= '
                   8345: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   8346: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   8347:     }
1.1075.2.126  raeburn  8348:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 8349:     return $result.'</head>';
1.306     albertel 8350: }
                   8351: 
                   8352: =pod
                   8353: 
1.340     albertel 8354: =item * &font_settings()
                   8355: 
                   8356: Returns neccessary <meta> to set the proper encoding
                   8357: 
1.1075.2.56  raeburn  8358: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 8359: 
                   8360: =cut
                   8361: 
                   8362: sub font_settings {
1.1075.2.56  raeburn  8363:     my ($args) = @_;
1.340     albertel 8364:     my $headerstring='';
1.1075.2.56  raeburn  8365:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   8366:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340     albertel 8367: 	$headerstring.=
1.1075.2.61  raeburn  8368: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   8369:         if (!$args->{'frameset'}) {
                   8370:             $headerstring.= ' /';
                   8371:         }
                   8372:         $headerstring .= '>'."\n";
1.340     albertel 8373:     }
                   8374:     return $headerstring;
                   8375: }
                   8376: 
1.341     albertel 8377: =pod
                   8378: 
1.1064    raeburn  8379: =item * &print_suppression()
                   8380: 
                   8381: In course context returns css which causes the body to be blank when media="print",
                   8382: if printout generation is unavailable for the current resource.
                   8383: 
                   8384: This could be because:
                   8385: 
                   8386: (a) printstartdate is in the future
                   8387: 
                   8388: (b) printenddate is in the past
                   8389: 
                   8390: (c) there is an active exam block with "printout"
                   8391: functionality blocked
                   8392: 
                   8393: Users with pav, pfo or evb privileges are exempt.
                   8394: 
                   8395: Inputs: none
                   8396: 
                   8397: =cut
                   8398: 
                   8399: 
                   8400: sub print_suppression {
                   8401:     my $noprint;
                   8402:     if ($env{'request.course.id'}) {
                   8403:         my $scope = $env{'request.course.id'};
                   8404:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8405:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   8406:             return;
                   8407:         }
                   8408:         if ($env{'request.course.sec'} ne '') {
                   8409:             $scope .= "/$env{'request.course.sec'}";
                   8410:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8411:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  8412:                 return;
1.1064    raeburn  8413:             }
                   8414:         }
                   8415:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8416:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.158  raeburn  8417:         my $clientip = &Apache::lonnet::get_requestor_ip();
                   8418:         my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064    raeburn  8419:         if ($blocked) {
                   8420:             my $checkrole = "cm./$cdom/$cnum";
                   8421:             if ($env{'request.course.sec'} ne '') {
                   8422:                 $checkrole .= "/$env{'request.course.sec'}";
                   8423:             }
                   8424:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   8425:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   8426:                 $noprint = 1;
                   8427:             }
                   8428:         }
                   8429:         unless ($noprint) {
                   8430:             my $symb = &Apache::lonnet::symbread();
                   8431:             if ($symb ne '') {
                   8432:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   8433:                 if (ref($navmap)) {
                   8434:                     my $res = $navmap->getBySymb($symb);
                   8435:                     if (ref($res)) {
                   8436:                         if (!$res->resprintable()) {
                   8437:                             $noprint = 1;
                   8438:                         }
                   8439:                     }
                   8440:                 }
                   8441:             }
                   8442:         }
                   8443:         if ($noprint) {
                   8444:             return <<"ENDSTYLE";
                   8445: <style type="text/css" media="print">
                   8446:     body { display:none }
                   8447: </style>
                   8448: ENDSTYLE
                   8449:         }
                   8450:     }
                   8451:     return;
                   8452: }
                   8453: 
                   8454: =pod
                   8455: 
1.341     albertel 8456: =item * &xml_begin()
                   8457: 
                   8458: Returns the needed doctype and <html>
                   8459: 
                   8460: Inputs: none
                   8461: 
                   8462: =cut
                   8463: 
                   8464: sub xml_begin {
1.1075.2.61  raeburn  8465:     my ($is_frameset) = @_;
1.341     albertel 8466:     my $output='';
                   8467: 
                   8468:     if ($env{'browser.mathml'}) {
                   8469: 	$output='<?xml version="1.0"?>'
                   8470:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   8471: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   8472:             
                   8473: #	    .'<!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">] >'
                   8474: 	    .'<!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">'
                   8475:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   8476: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61  raeburn  8477:     } elsif ($is_frameset) {
                   8478:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   8479:                 '<html>'."\n";
1.341     albertel 8480:     } else {
1.1075.2.61  raeburn  8481: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   8482:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 8483:     }
                   8484:     return $output;
                   8485: }
1.340     albertel 8486: 
                   8487: =pod
                   8488: 
1.306     albertel 8489: =item * &start_page()
                   8490: 
                   8491: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   8492: 
1.648     raeburn  8493: Inputs:
                   8494: 
                   8495: =over 4
                   8496: 
                   8497: $title - optional title for the page
                   8498: 
                   8499: $head_extra - optional extra HTML to incude inside the <head>
                   8500: 
                   8501: $args - additional optional args supported are:
                   8502: 
                   8503: =over 8
                   8504: 
                   8505:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 8506:                                     arg on
1.814     bisitz   8507:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  8508:              add_entries    -> additional attributes to add to the  <body>
                   8509:              domain         -> force to color decorate a page for a 
1.317     albertel 8510:                                     specific domain
1.648     raeburn  8511:              function       -> force usage of a specific rolish color
1.317     albertel 8512:                                     scheme
1.648     raeburn  8513:              redirect       -> see &headtag()
                   8514:              bgcolor        -> override the default page bg color
                   8515:              js_ready       -> return a string ready for being used in 
1.317     albertel 8516:                                     a javascript writeln
1.648     raeburn  8517:              html_encode    -> return a string ready for being used in 
1.320     albertel 8518:                                     a html attribute
1.648     raeburn  8519:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 8520:                                     $forcereg arg
1.648     raeburn  8521:              frameset       -> if true will start with a <frameset>
1.330     albertel 8522:                                     rather than <body>
1.648     raeburn  8523:              skip_phases    -> hash ref of 
1.338     albertel 8524:                                     head -> skip the <html><head> generation
                   8525:                                     body -> skip all <body> generation
1.1075.2.12  raeburn  8526:              no_inline_link -> if true and in remote mode, don't show the
                   8527:                                     'Switch To Inline Menu' link
1.648     raeburn  8528:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 8529:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  8530:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1075.2.123  raeburn  8531:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   8532:                                     to lonhtmlcommon::breadcrumbs
1.1075.2.15  raeburn  8533:              group          -> includes the current group, if page is for a
                   8534:                                specific group
1.1075.2.133  raeburn  8535:              use_absolute   -> for request for external resource or syllabus, this
                   8536:                                will contain https://<hostname> if server uses
                   8537:                                https (as per hosts.tab), but request is for http
                   8538:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.1075.2.158  raeburn  8539:              links_disabled -> Links in primary and secondary menus are disabled
                   8540:                                (Can enable them once page has loaded - see lonroles.pm
                   8541:                                for an example).
1.361     albertel 8542: 
1.648     raeburn  8543: =back
1.460     albertel 8544: 
1.648     raeburn  8545: =back
1.562     albertel 8546: 
1.306     albertel 8547: =cut
                   8548: 
                   8549: sub start_page {
1.309     albertel 8550:     my ($title,$head_extra,$args) = @_;
1.318     albertel 8551:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 8552: 
1.315     albertel 8553:     $env{'internal.start_page'}++;
1.1075.2.15  raeburn  8554:     my ($result,@advtools);
1.964     droeschl 8555: 
1.338     albertel 8556:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62  raeburn  8557:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 8558:     }
                   8559:     
                   8560:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   8561: 	if ($args->{'frameset'}) {
                   8562: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   8563: 						$args->{'add_entries'});
                   8564: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8565:         } else {
                   8566:             $result .=
                   8567:                 &bodytag($title, 
                   8568:                          $args->{'function'},       $args->{'add_entries'},
                   8569:                          $args->{'only_body'},      $args->{'domain'},
                   8570:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12  raeburn  8571:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
1.1075.2.15  raeburn  8572:                          $args,                     \@advtools);
1.831     bisitz   8573:         }
1.330     albertel 8574:     }
1.338     albertel 8575: 
1.315     albertel 8576:     if ($args->{'js_ready'}) {
1.713     kaisler  8577: 		$result = &js_ready($result);
1.315     albertel 8578:     }
1.320     albertel 8579:     if ($args->{'html_encode'}) {
1.713     kaisler  8580: 		$result = &html_encode($result);
                   8581:     }
                   8582: 
1.813     bisitz   8583:     # Preparation for new and consistent functionlist at top of screen
                   8584:     # if ($args->{'functionlist'}) {
                   8585:     #            $result .= &build_functionlist();
                   8586:     #}
                   8587: 
1.964     droeschl 8588:     # Don't add anything more if only_body wanted or in const space
                   8589:     return $result if    $args->{'only_body'} 
                   8590:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8591: 
                   8592:     #Breadcrumbs
1.758     kaisler  8593:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   8594: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8595: 		#if any br links exists, add them to the breadcrumbs
                   8596: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8597: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8598: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8599: 			}
                   8600: 		}
1.1075.2.19  raeburn  8601:                 # if @advtools array contains items add then to the breadcrumbs
                   8602:                 if (@advtools > 0) {
                   8603:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8604:                 }
1.1075.2.123  raeburn  8605:                 my $menulink;
                   8606:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   8607:                 if (exists($args->{'bread_crumbs_nomenu'})) {
                   8608:                     $menulink = 0;
                   8609:                 } else {
                   8610:                     undef($menulink);
                   8611:                 }
1.758     kaisler  8612: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8613: 		if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123  raeburn  8614: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.758     kaisler  8615: 		}else{
1.1075.2.123  raeburn  8616: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  8617: 		}
1.1075.2.24  raeburn  8618:     } elsif (($env{'environment.remote'} eq 'on') &&
                   8619:              ($env{'form.inhibitmenu'} ne 'yes') &&
                   8620:              ($env{'request.noversionuri'} =~ m{^/res/}) &&
                   8621:              ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21  raeburn  8622:         $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320     albertel 8623:     }
1.315     albertel 8624:     return $result;
1.306     albertel 8625: }
                   8626: 
                   8627: sub end_page {
1.315     albertel 8628:     my ($args) = @_;
                   8629:     $env{'internal.end_page'}++;
1.330     albertel 8630:     my $result;
1.335     albertel 8631:     if ($args->{'discussion'}) {
                   8632: 	my ($target,$parser);
                   8633: 	if (ref($args->{'discussion'})) {
                   8634: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8635: 				$args->{'discussion'}{'parser'});
                   8636: 	}
                   8637: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8638:     }
1.330     albertel 8639:     if ($args->{'frameset'}) {
                   8640: 	$result .= '</frameset>';
                   8641:     } else {
1.635     raeburn  8642: 	$result .= &endbodytag($args);
1.330     albertel 8643:     }
1.1075.2.6  raeburn  8644:     unless ($args->{'notbody'}) {
                   8645:         $result .= "\n</html>";
                   8646:     }
1.330     albertel 8647: 
1.315     albertel 8648:     if ($args->{'js_ready'}) {
1.317     albertel 8649: 	$result = &js_ready($result);
1.315     albertel 8650:     }
1.335     albertel 8651: 
1.320     albertel 8652:     if ($args->{'html_encode'}) {
                   8653: 	$result = &html_encode($result);
                   8654:     }
1.335     albertel 8655: 
1.315     albertel 8656:     return $result;
                   8657: }
                   8658: 
1.1034    www      8659: sub wishlist_window {
                   8660:     return(<<'ENDWISHLIST');
1.1046    raeburn  8661: <script type="text/javascript">
1.1034    www      8662: // <![CDATA[
                   8663: // <!-- BEGIN LON-CAPA Internal
                   8664: function set_wishlistlink(title, path) {
                   8665:     if (!title) {
                   8666:         title = document.title;
                   8667:         title = title.replace(/^LON-CAPA /,'');
                   8668:     }
1.1075.2.65  raeburn  8669:     title = encodeURIComponent(title);
1.1075.2.83  raeburn  8670:     title = title.replace("'","\\\'");
1.1034    www      8671:     if (!path) {
                   8672:         path = location.pathname;
                   8673:     }
1.1075.2.65  raeburn  8674:     path = encodeURIComponent(path);
1.1075.2.83  raeburn  8675:     path = path.replace("'","\\\'");
1.1034    www      8676:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   8677:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   8678: }
                   8679: // END LON-CAPA Internal -->
                   8680: // ]]>
                   8681: </script>
                   8682: ENDWISHLIST
                   8683: }
                   8684: 
1.1030    www      8685: sub modal_window {
                   8686:     return(<<'ENDMODAL');
1.1046    raeburn  8687: <script type="text/javascript">
1.1030    www      8688: // <![CDATA[
                   8689: // <!-- BEGIN LON-CAPA Internal
                   8690: var modalWindow = {
                   8691: 	parent:"body",
                   8692: 	windowId:null,
                   8693: 	content:null,
                   8694: 	width:null,
                   8695: 	height:null,
                   8696: 	close:function()
                   8697: 	{
                   8698: 	        $(".LCmodal-window").remove();
                   8699: 	        $(".LCmodal-overlay").remove();
                   8700: 	},
                   8701: 	open:function()
                   8702: 	{
                   8703: 		var modal = "";
                   8704: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   8705: 		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;\">";
                   8706: 		modal += this.content;
                   8707: 		modal += "</div>";	
                   8708: 
                   8709: 		$(this.parent).append(modal);
                   8710: 
                   8711: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   8712: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   8713: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   8714: 	}
                   8715: };
1.1075.2.42  raeburn  8716: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      8717: 	{
1.1075.2.119  raeburn  8718:                 source = source.replace(/'/g,"&#39;");
1.1030    www      8719: 		modalWindow.windowId = "myModal";
                   8720: 		modalWindow.width = width;
                   8721: 		modalWindow.height = height;
1.1075.2.80  raeburn  8722: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      8723: 		modalWindow.open();
1.1075.2.87  raeburn  8724: 	};
1.1030    www      8725: // END LON-CAPA Internal -->
                   8726: // ]]>
                   8727: </script>
                   8728: ENDMODAL
                   8729: }
                   8730: 
                   8731: sub modal_link {
1.1075.2.42  raeburn  8732:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      8733:     unless ($width) { $width=480; }
                   8734:     unless ($height) { $height=400; }
1.1031    www      8735:     unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42  raeburn  8736:     unless ($transparency) { $transparency='true'; }
                   8737: 
1.1074    raeburn  8738:     my $target_attr;
                   8739:     if (defined($target)) {
                   8740:         $target_attr = 'target="'.$target.'"';
                   8741:     }
                   8742:     return <<"ENDLINK";
1.1075.2.143  raeburn  8743: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  8744: ENDLINK
1.1030    www      8745: }
                   8746: 
1.1032    www      8747: sub modal_adhoc_script {
1.1075.2.155  raeburn  8748:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
                   8749:     my $mathjax;
                   8750:     if ($possmathjax) {
                   8751:         $mathjax = <<'ENDJAX';
                   8752:                if (typeof MathJax == 'object') {
                   8753:                    MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
                   8754:                }
                   8755: ENDJAX
                   8756:     }
1.1032    www      8757:     return (<<ENDADHOC);
1.1046    raeburn  8758: <script type="text/javascript">
1.1032    www      8759: // <![CDATA[
                   8760:         var $funcname = function()
                   8761:         {
                   8762:                 modalWindow.windowId = "myModal";
                   8763:                 modalWindow.width = $width;
                   8764:                 modalWindow.height = $height;
                   8765:                 modalWindow.content = '$content';
                   8766:                 modalWindow.open();
1.1075.2.155  raeburn  8767:                 $mathjax
1.1032    www      8768:         };  
                   8769: // ]]>
                   8770: </script>
                   8771: ENDADHOC
                   8772: }
                   8773: 
1.1041    www      8774: sub modal_adhoc_inner {
1.1075.2.155  raeburn  8775:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041    www      8776:     my $innerwidth=$width-20;
                   8777:     $content=&js_ready(
1.1042    www      8778:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  8779:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8780:                  $content.
1.1041    www      8781:                  &end_scrollbox().
1.1075.2.42  raeburn  8782:                  &end_page()
1.1041    www      8783:              );
1.1075.2.155  raeburn  8784:     return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041    www      8785: }
                   8786: 
                   8787: sub modal_adhoc_window {
1.1075.2.155  raeburn  8788:     my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
                   8789:     return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041    www      8790:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8791: }
                   8792: 
                   8793: sub modal_adhoc_launch {
                   8794:     my ($funcname,$width,$height,$content)=@_;
                   8795:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8796: <script type="text/javascript">
                   8797: // <![CDATA[
                   8798: $funcname();
                   8799: // ]]>
                   8800: </script>
                   8801: ENDLAUNCH
                   8802: }
                   8803: 
                   8804: sub modal_adhoc_close {
                   8805:     return (<<ENDCLOSE);
                   8806: <script type="text/javascript">
                   8807: // <![CDATA[
                   8808: modalWindow.close();
                   8809: // ]]>
                   8810: </script>
                   8811: ENDCLOSE
                   8812: }
                   8813: 
1.1038    www      8814: sub togglebox_script {
                   8815:    return(<<ENDTOGGLE);
                   8816: <script type="text/javascript"> 
                   8817: // <![CDATA[
                   8818: function LCtoggleDisplay(id,hidetext,showtext) {
                   8819:    link = document.getElementById(id + "link").childNodes[0];
                   8820:    with (document.getElementById(id).style) {
                   8821:       if (display == "none" ) {
                   8822:           display = "inline";
                   8823:           link.nodeValue = hidetext;
                   8824:         } else {
                   8825:           display = "none";
                   8826:           link.nodeValue = showtext;
                   8827:        }
                   8828:    }
                   8829: }
                   8830: // ]]>
                   8831: </script>
                   8832: ENDTOGGLE
                   8833: }
                   8834: 
1.1039    www      8835: sub start_togglebox {
                   8836:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   8837:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   8838:     unless ($showtext) { $showtext=&mt('show'); }
                   8839:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   8840:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   8841:     return &start_data_table().
                   8842:            &start_data_table_header_row().
                   8843:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   8844:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   8845:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   8846:            &end_data_table_header_row().
                   8847:            '<tr id="'.$id.'" style="display:none""><td>';
                   8848: }
                   8849: 
                   8850: sub end_togglebox {
                   8851:     return '</td></tr>'.&end_data_table();
                   8852: }
                   8853: 
1.1041    www      8854: sub LCprogressbar_script {
1.1075.2.130  raeburn  8855:    my ($id,$number_to_do)=@_;
                   8856:    if ($number_to_do) {
                   8857:        return(<<ENDPROGRESS);
1.1041    www      8858: <script type="text/javascript">
                   8859: // <![CDATA[
1.1045    www      8860: \$('#progressbar$id').progressbar({
1.1041    www      8861:   value: 0,
                   8862:   change: function(event, ui) {
                   8863:     var newVal = \$(this).progressbar('option', 'value');
                   8864:     \$('.pblabel', this).text(LCprogressTxt);
                   8865:   }
                   8866: });
                   8867: // ]]>
                   8868: </script>
                   8869: ENDPROGRESS
1.1075.2.130  raeburn  8870:    } else {
                   8871:        return(<<ENDPROGRESS);
                   8872: <script type="text/javascript">
                   8873: // <![CDATA[
                   8874: \$('#progressbar$id').progressbar({
                   8875:   value: false,
                   8876:   create: function(event, ui) {
                   8877:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   8878:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   8879:   }
                   8880: });
                   8881: // ]]>
                   8882: </script>
                   8883: ENDPROGRESS
                   8884:    }
1.1041    www      8885: }
                   8886: 
                   8887: sub LCprogressbarUpdate_script {
                   8888:    return(<<ENDPROGRESSUPDATE);
                   8889: <style type="text/css">
                   8890: .ui-progressbar { position:relative; }
1.1075.2.130  raeburn  8891: .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      8892: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   8893: </style>
                   8894: <script type="text/javascript">
                   8895: // <![CDATA[
1.1045    www      8896: var LCprogressTxt='---';
                   8897: 
1.1075.2.130  raeburn  8898: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      8899:    LCprogressTxt=progresstext;
1.1075.2.130  raeburn  8900:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   8901:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   8902:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
                   8903:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   8904:    } else {
                   8905:        \$('#progressbar'+id).progressbar('value',percent);
                   8906:    }
1.1041    www      8907: }
                   8908: // ]]>
                   8909: </script>
                   8910: ENDPROGRESSUPDATE
                   8911: }
                   8912: 
1.1042    www      8913: my $LClastpercent;
1.1045    www      8914: my $LCidcnt;
                   8915: my $LCcurrentid;
1.1042    www      8916: 
1.1041    www      8917: sub LCprogressbar {
1.1075.2.130  raeburn  8918:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      8919:     $LClastpercent=0;
1.1045    www      8920:     $LCidcnt++;
                   8921:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130  raeburn  8922:     my ($starting,$content);
                   8923:     if ($number_to_do) {
                   8924:         $starting=&mt('Starting');
                   8925:         $content=(<<ENDPROGBAR);
                   8926: $preamble
1.1045    www      8927:   <div id="progressbar$LCcurrentid">
1.1041    www      8928:     <span class="pblabel">$starting</span>
                   8929:   </div>
                   8930: ENDPROGBAR
1.1075.2.130  raeburn  8931:     } else {
                   8932:         $starting=&mt('Loading...');
                   8933:         $LClastpercent='false';
                   8934:         $content=(<<ENDPROGBAR);
                   8935: $preamble
                   8936:   <div id="progressbar$LCcurrentid">
                   8937:       <div class="progress-label">$starting</div>
                   8938:   </div>
                   8939: ENDPROGBAR
                   8940:     }
                   8941:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      8942: }
                   8943: 
                   8944: sub LCprogressbarUpdate {
1.1075.2.130  raeburn  8945:     my ($r,$val,$text,$number_to_do)=@_;
                   8946:     if ($number_to_do) {
                   8947:         unless ($val) { 
                   8948:             if ($LClastpercent) {
                   8949:                 $val=$LClastpercent;
                   8950:             } else {
                   8951:                 $val=0;
                   8952:             }
                   8953:         }
                   8954:         if ($val<0) { $val=0; }
                   8955:         if ($val>100) { $val=0; }
                   8956:         $LClastpercent=$val;
                   8957:         unless ($text) { $text=$val.'%'; }
                   8958:     } else {
                   8959:         $val = 'false';
1.1042    www      8960:     }
1.1041    www      8961:     $text=&js_ready($text);
1.1044    www      8962:     &r_print($r,<<ENDUPDATE);
1.1041    www      8963: <script type="text/javascript">
                   8964: // <![CDATA[
1.1075.2.130  raeburn  8965: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      8966: // ]]>
                   8967: </script>
                   8968: ENDUPDATE
1.1035    www      8969: }
                   8970: 
1.1042    www      8971: sub LCprogressbarClose {
                   8972:     my ($r)=@_;
                   8973:     $LClastpercent=0;
1.1044    www      8974:     &r_print($r,<<ENDCLOSE);
1.1042    www      8975: <script type="text/javascript">
                   8976: // <![CDATA[
1.1045    www      8977: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      8978: // ]]>
                   8979: </script>
                   8980: ENDCLOSE
1.1044    www      8981: }
                   8982: 
                   8983: sub r_print {
                   8984:     my ($r,$to_print)=@_;
                   8985:     if ($r) {
                   8986:       $r->print($to_print);
                   8987:       $r->rflush();
                   8988:     } else {
                   8989:       print($to_print);
                   8990:     }
1.1042    www      8991: }
                   8992: 
1.320     albertel 8993: sub html_encode {
                   8994:     my ($result) = @_;
                   8995: 
1.322     albertel 8996:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 8997:     
                   8998:     return $result;
                   8999: }
1.1044    www      9000: 
1.317     albertel 9001: sub js_ready {
                   9002:     my ($result) = @_;
                   9003: 
1.323     albertel 9004:     $result =~ s/[\n\r]/ /xmsg;
                   9005:     $result =~ s/\\/\\\\/xmsg;
                   9006:     $result =~ s/'/\\'/xmsg;
1.372     albertel 9007:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 9008:     
                   9009:     return $result;
                   9010: }
                   9011: 
1.315     albertel 9012: sub validate_page {
                   9013:     if (  exists($env{'internal.start_page'})
1.316     albertel 9014: 	  &&     $env{'internal.start_page'} > 1) {
                   9015: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 9016: 				 $env{'internal.start_page'}.' '.
1.316     albertel 9017: 				 $ENV{'request.filename'});
1.315     albertel 9018:     }
                   9019:     if (  exists($env{'internal.end_page'})
1.316     albertel 9020: 	  &&     $env{'internal.end_page'} > 1) {
                   9021: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 9022: 				 $env{'internal.end_page'}.' '.
1.316     albertel 9023: 				 $env{'request.filename'});
1.315     albertel 9024:     }
                   9025:     if (     exists($env{'internal.start_page'})
                   9026: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 9027: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   9028: 				 $env{'request.filename'});
1.315     albertel 9029:     }
                   9030:     if (   ! exists($env{'internal.start_page'})
                   9031: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 9032: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   9033: 				 $env{'request.filename'});
1.315     albertel 9034:     }
1.306     albertel 9035: }
1.315     albertel 9036: 
1.996     www      9037: 
                   9038: sub start_scrollbox {
1.1075.2.56  raeburn  9039:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  9040:     unless ($outerwidth) { $outerwidth='520px'; }
                   9041:     unless ($width) { $width='500px'; }
                   9042:     unless ($height) { $height='200px'; }
1.1075    raeburn  9043:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  9044:     if ($id ne '') {
1.1075.2.42  raeburn  9045:         $table_id = ' id="table_'.$id.'"';
                   9046:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  9047:     }
1.1075    raeburn  9048:     if ($bgcolor ne '') {
                   9049:         $tdcol = "background-color: $bgcolor;";
                   9050:     }
1.1075.2.42  raeburn  9051:     my $nicescroll_js;
                   9052:     if ($env{'browser.mobile'}) {
                   9053:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   9054:     }
1.1075    raeburn  9055:     return <<"END";
1.1075.2.42  raeburn  9056: $nicescroll_js
                   9057: 
                   9058: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  9059: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  9060: END
1.996     www      9061: }
                   9062: 
                   9063: sub end_scrollbox {
1.1036    www      9064:     return '</div></td></tr></table>';
1.996     www      9065: }
                   9066: 
1.1075.2.42  raeburn  9067: sub nicescroll_javascript {
                   9068:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   9069:     my %options;
                   9070:     if (ref($cursor) eq 'HASH') {
                   9071:         %options = %{$cursor};
                   9072:     }
                   9073:     unless ($options{'railalign'} =~ /^left|right$/) {
                   9074:         $options{'railalign'} = 'left';
                   9075:     }
                   9076:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9077:         my $function  = &get_users_function();
                   9078:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   9079:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9080:             $options{'cursorcolor'} = '#00F';
                   9081:         }
                   9082:     }
                   9083:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   9084:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   9085:             $options{'cursoropacity'}='1.0';
                   9086:         }
                   9087:     } else {
                   9088:         $options{'cursoropacity'}='1.0';
                   9089:     }
                   9090:     if ($options{'cursorfixedheight'} eq 'none') {
                   9091:         delete($options{'cursorfixedheight'});
                   9092:     } else {
                   9093:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   9094:     }
                   9095:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   9096:         delete($options{'railoffset'});
                   9097:     }
                   9098:     my @niceoptions;
                   9099:     while (my($key,$value) = each(%options)) {
                   9100:         if ($value =~ /^\{.+\}$/) {
                   9101:             push(@niceoptions,$key.':'.$value);
                   9102:         } else {
                   9103:             push(@niceoptions,$key.':"'.$value.'"');
                   9104:         }
                   9105:     }
                   9106:     my $nicescroll_js = '
                   9107: $(document).ready(
                   9108:       function() {
                   9109:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   9110:       }
                   9111: );
                   9112: ';
                   9113:     if ($framecheck) {
                   9114:         $nicescroll_js .= '
                   9115: function expand_div(caller) {
                   9116:     if (top === self) {
                   9117:         document.getElementById("'.$id.'").style.width = "auto";
                   9118:         document.getElementById("'.$id.'").style.height = "auto";
                   9119:     } else {
                   9120:         try {
                   9121:             if (parent.frames) {
                   9122:                 if (parent.frames.length > 1) {
                   9123:                     var framesrc = parent.frames[1].location.href;
                   9124:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   9125:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   9126:                         document.getElementById("'.$id.'").style.width = "auto";
                   9127:                         document.getElementById("'.$id.'").style.height = "auto";
                   9128:                     }
                   9129:                 }
                   9130:             }
                   9131:         } catch (e) {
                   9132:             return;
                   9133:         }
                   9134:     }
                   9135:     return;
                   9136: }
                   9137: ';
                   9138:     }
                   9139:     if ($needjsready) {
                   9140:         $nicescroll_js = '
                   9141: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   9142:     } else {
                   9143:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   9144:     }
                   9145:     return $nicescroll_js;
                   9146: }
                   9147: 
1.318     albertel 9148: sub simple_error_page {
1.1075.2.49  raeburn  9149:     my ($r,$title,$msg,$args) = @_;
                   9150:     if (ref($args) eq 'HASH') {
                   9151:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   9152:     } else {
                   9153:         $msg = &mt($msg);
                   9154:     }
                   9155: 
1.318     albertel 9156:     my $page =
                   9157: 	&Apache::loncommon::start_page($title).
1.1075.2.49  raeburn  9158: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 9159: 	&Apache::loncommon::end_page();
                   9160:     if (ref($r)) {
                   9161: 	$r->print($page);
1.327     albertel 9162: 	return;
1.318     albertel 9163:     }
                   9164:     return $page;
                   9165: }
1.347     albertel 9166: 
                   9167: {
1.610     albertel 9168:     my @row_count;
1.961     onken    9169: 
                   9170:     sub start_data_table_count {
                   9171:         unshift(@row_count, 0);
                   9172:         return;
                   9173:     }
                   9174: 
                   9175:     sub end_data_table_count {
                   9176:         shift(@row_count);
                   9177:         return;
                   9178:     }
                   9179: 
1.347     albertel 9180:     sub start_data_table {
1.1018    raeburn  9181: 	my ($add_class,$id) = @_;
1.422     albertel 9182: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  9183:         my $table_id;
                   9184:         if (defined($id)) {
                   9185:             $table_id = ' id="'.$id.'"';
                   9186:         }
1.961     onken    9187: 	&start_data_table_count();
1.1018    raeburn  9188: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 9189:     }
                   9190: 
                   9191:     sub end_data_table {
1.961     onken    9192: 	&end_data_table_count();
1.389     albertel 9193: 	return '</table>'."\n";;
1.347     albertel 9194:     }
                   9195: 
                   9196:     sub start_data_table_row {
1.974     wenzelju 9197: 	my ($add_class, $id) = @_;
1.610     albertel 9198: 	$row_count[0]++;
                   9199: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   9200: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 9201:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9202:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 9203:     }
1.471     banghart 9204:     
                   9205:     sub continue_data_table_row {
1.974     wenzelju 9206: 	my ($add_class, $id) = @_;
1.610     albertel 9207: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 9208: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   9209:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9210:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 9211:     }
1.347     albertel 9212: 
                   9213:     sub end_data_table_row {
1.389     albertel 9214: 	return '</tr>'."\n";;
1.347     albertel 9215:     }
1.367     www      9216: 
1.421     albertel 9217:     sub start_data_table_empty_row {
1.707     bisitz   9218: #	$row_count[0]++;
1.421     albertel 9219: 	return  '<tr class="LC_empty_row" >'."\n";;
                   9220:     }
                   9221: 
                   9222:     sub end_data_table_empty_row {
                   9223: 	return '</tr>'."\n";;
                   9224:     }
                   9225: 
1.367     www      9226:     sub start_data_table_header_row {
1.389     albertel 9227: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      9228:     }
                   9229: 
                   9230:     sub end_data_table_header_row {
1.389     albertel 9231: 	return '</tr>'."\n";;
1.367     www      9232:     }
1.890     droeschl 9233: 
                   9234:     sub data_table_caption {
                   9235:         my $caption = shift;
                   9236:         return "<caption class=\"LC_caption\">$caption</caption>";
                   9237:     }
1.347     albertel 9238: }
                   9239: 
1.548     albertel 9240: =pod
                   9241: 
                   9242: =item * &inhibit_menu_check($arg)
                   9243: 
                   9244: Checks for a inhibitmenu state and generates output to preserve it
                   9245: 
                   9246: Inputs:         $arg - can be any of
                   9247:                      - undef - in which case the return value is a string 
                   9248:                                to add  into arguments list of a uri
                   9249:                      - 'input' - in which case the return value is a HTML
                   9250:                                  <form> <input> field of type hidden to
                   9251:                                  preserve the value
                   9252:                      - a url - in which case the return value is the url with
                   9253:                                the neccesary cgi args added to preserve the
                   9254:                                inhibitmenu state
                   9255:                      - a ref to a url - no return value, but the string is
                   9256:                                         updated to include the neccessary cgi
                   9257:                                         args to preserve the inhibitmenu state
                   9258: 
                   9259: =cut
                   9260: 
                   9261: sub inhibit_menu_check {
                   9262:     my ($arg) = @_;
                   9263:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   9264:     if ($arg eq 'input') {
                   9265: 	if ($env{'form.inhibitmenu'}) {
                   9266: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   9267: 	} else {
                   9268: 	    return
                   9269: 	}
                   9270:     }
                   9271:     if ($env{'form.inhibitmenu'}) {
                   9272: 	if (ref($arg)) {
                   9273: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9274: 	} elsif ($arg eq '') {
                   9275: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   9276: 	} else {
                   9277: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9278: 	}
                   9279:     }
                   9280:     if (!ref($arg)) {
                   9281: 	return $arg;
                   9282:     }
                   9283: }
                   9284: 
1.251     albertel 9285: ###############################################
1.182     matthew  9286: 
                   9287: =pod
                   9288: 
1.549     albertel 9289: =back
                   9290: 
                   9291: =head1 User Information Routines
                   9292: 
                   9293: =over 4
                   9294: 
1.405     albertel 9295: =item * &get_users_function()
1.182     matthew  9296: 
                   9297: Used by &bodytag to determine the current users primary role.
                   9298: Returns either 'student','coordinator','admin', or 'author'.
                   9299: 
                   9300: =cut
                   9301: 
                   9302: ###############################################
                   9303: sub get_users_function {
1.815     tempelho 9304:     my $function = 'norole';
1.818     tempelho 9305:     if ($env{'request.role'}=~/^(st)/) {
                   9306:         $function='student';
                   9307:     }
1.907     raeburn  9308:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  9309:         $function='coordinator';
                   9310:     }
1.258     albertel 9311:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  9312:         $function='admin';
                   9313:     }
1.826     bisitz   9314:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  9315:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  9316:         $function='author';
                   9317:     }
                   9318:     return $function;
1.54      www      9319: }
1.99      www      9320: 
                   9321: ###############################################
                   9322: 
1.233     raeburn  9323: =pod
                   9324: 
1.821     raeburn  9325: =item * &show_course()
                   9326: 
                   9327: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   9328: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   9329: 
                   9330: Inputs:
                   9331: None
                   9332: 
                   9333: Outputs:
                   9334: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   9335: 
                   9336: =cut
                   9337: 
                   9338: ###############################################
                   9339: sub show_course {
                   9340:     my $course = !$env{'user.adv'};
                   9341:     if (!$env{'user.adv'}) {
                   9342:         foreach my $env (keys(%env)) {
                   9343:             next if ($env !~ m/^user\.priv\./);
                   9344:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   9345:                 $course = 0;
                   9346:                 last;
                   9347:             }
                   9348:         }
                   9349:     }
                   9350:     return $course;
                   9351: }
                   9352: 
                   9353: ###############################################
                   9354: 
                   9355: =pod
                   9356: 
1.542     raeburn  9357: =item * &check_user_status()
1.274     raeburn  9358: 
                   9359: Determines current status of supplied role for a
                   9360: specific user. Roles can be active, previous or future.
                   9361: 
                   9362: Inputs: 
                   9363: user's domain, user's username, course's domain,
1.375     raeburn  9364: course's number, optional section ID.
1.274     raeburn  9365: 
                   9366: Outputs:
                   9367: role status: active, previous or future. 
                   9368: 
                   9369: =cut
                   9370: 
                   9371: sub check_user_status {
1.412     raeburn  9372:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  9373:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  9374:     my @uroles = keys(%userinfo);
1.274     raeburn  9375:     my $srchstr;
                   9376:     my $active_chk = 'none';
1.412     raeburn  9377:     my $now = time;
1.274     raeburn  9378:     if (@uroles > 0) {
1.908     raeburn  9379:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  9380:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   9381:         } else {
1.412     raeburn  9382:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   9383:         }
                   9384:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  9385:             my $role_end = 0;
                   9386:             my $role_start = 0;
                   9387:             $active_chk = 'active';
1.412     raeburn  9388:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   9389:                 $role_end = $1;
                   9390:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   9391:                     $role_start = $1;
1.274     raeburn  9392:                 }
                   9393:             }
                   9394:             if ($role_start > 0) {
1.412     raeburn  9395:                 if ($now < $role_start) {
1.274     raeburn  9396:                     $active_chk = 'future';
                   9397:                 }
                   9398:             }
                   9399:             if ($role_end > 0) {
1.412     raeburn  9400:                 if ($now > $role_end) {
1.274     raeburn  9401:                     $active_chk = 'previous';
                   9402:                 }
                   9403:             }
                   9404:         }
                   9405:     }
                   9406:     return $active_chk;
                   9407: }
                   9408: 
                   9409: ###############################################
                   9410: 
                   9411: =pod
                   9412: 
1.405     albertel 9413: =item * &get_sections()
1.233     raeburn  9414: 
                   9415: Determines all the sections for a course including
                   9416: sections with students and sections containing other roles.
1.419     raeburn  9417: Incoming parameters: 
                   9418: 
                   9419: 1. domain
                   9420: 2. course number 
                   9421: 3. reference to array containing roles for which sections should 
                   9422: be gathered (optional).
                   9423: 4. reference to array containing status types for which sections 
                   9424: should be gathered (optional).
                   9425: 
                   9426: If the third argument is undefined, sections are gathered for any role. 
                   9427: If the fourth argument is undefined, sections are gathered for any status.
                   9428: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  9429:  
1.374     raeburn  9430: Returns section hash (keys are section IDs, values are
                   9431: number of users in each section), subject to the
1.419     raeburn  9432: optional roles filter, optional status filter 
1.233     raeburn  9433: 
                   9434: =cut
                   9435: 
                   9436: ###############################################
                   9437: sub get_sections {
1.419     raeburn  9438:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 9439:     if (!defined($cdom) || !defined($cnum)) {
                   9440:         my $cid =  $env{'request.course.id'};
                   9441: 
                   9442: 	return if (!defined($cid));
                   9443: 
                   9444:         $cdom = $env{'course.'.$cid.'.domain'};
                   9445:         $cnum = $env{'course.'.$cid.'.num'};
                   9446:     }
                   9447: 
                   9448:     my %sectioncount;
1.419     raeburn  9449:     my $now = time;
1.240     albertel 9450: 
1.1075.2.33  raeburn  9451:     my $check_students = 1;
                   9452:     my $only_students = 0;
                   9453:     if (ref($possible_roles) eq 'ARRAY') {
                   9454:         if (grep(/^st$/,@{$possible_roles})) {
                   9455:             if (@{$possible_roles} == 1) {
                   9456:                 $only_students = 1;
                   9457:             }
                   9458:         } else {
                   9459:             $check_students = 0;
                   9460:         }
                   9461:     }
                   9462: 
                   9463:     if ($check_students) {
1.276     albertel 9464: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 9465: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   9466: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  9467:         my $start_index = &Apache::loncoursedata::CL_START();
                   9468:         my $end_index = &Apache::loncoursedata::CL_END();
                   9469:         my $status;
1.366     albertel 9470: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  9471: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   9472: 				                     $data->[$status_index],
                   9473:                                                      $data->[$start_index],
                   9474:                                                      $data->[$end_index]);
                   9475:             if ($stu_status eq 'Active') {
                   9476:                 $status = 'active';
                   9477:             } elsif ($end < $now) {
                   9478:                 $status = 'previous';
                   9479:             } elsif ($start > $now) {
                   9480:                 $status = 'future';
                   9481:             } 
                   9482: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   9483:                 if ((!defined($possible_status)) || (($status ne '') && 
                   9484:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   9485: 		    $sectioncount{$section}++;
                   9486:                 }
1.240     albertel 9487: 	    }
                   9488: 	}
                   9489:     }
1.1075.2.33  raeburn  9490:     if ($only_students) {
                   9491:         return %sectioncount;
                   9492:     }
1.240     albertel 9493:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9494:     foreach my $user (sort(keys(%courseroles))) {
                   9495: 	if ($user !~ /^(\w{2})/) { next; }
                   9496: 	my ($role) = ($user =~ /^(\w{2})/);
                   9497: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9498: 	my ($section,$status);
1.240     albertel 9499: 	if ($role eq 'cr' &&
                   9500: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9501: 	    $section=$1;
                   9502: 	}
                   9503: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9504: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9505:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9506:         if ($end == -1 && $start == -1) {
                   9507:             next; #deleted role
                   9508:         }
                   9509:         if (!defined($possible_status)) { 
                   9510:             $sectioncount{$section}++;
                   9511:         } else {
                   9512:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9513:                 $status = 'active';
                   9514:             } elsif ($end < $now) {
                   9515:                 $status = 'future';
                   9516:             } elsif ($start > $now) {
                   9517:                 $status = 'previous';
                   9518:             }
                   9519:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9520:                 $sectioncount{$section}++;
                   9521:             }
                   9522:         }
1.233     raeburn  9523:     }
1.366     albertel 9524:     return %sectioncount;
1.233     raeburn  9525: }
                   9526: 
1.274     raeburn  9527: ###############################################
1.294     raeburn  9528: 
                   9529: =pod
1.405     albertel 9530: 
                   9531: =item * &get_course_users()
                   9532: 
1.275     raeburn  9533: Retrieves usernames:domains for users in the specified course
                   9534: with specific role(s), and access status. 
                   9535: 
                   9536: Incoming parameters:
1.277     albertel 9537: 1. course domain
                   9538: 2. course number
                   9539: 3. access status: users must have - either active, 
1.275     raeburn  9540: previous, future, or all.
1.277     albertel 9541: 4. reference to array of permissible roles
1.288     raeburn  9542: 5. reference to array of section restrictions (optional)
                   9543: 6. reference to results object (hash of hashes).
                   9544: 7. reference to optional userdata hash
1.609     raeburn  9545: 8. reference to optional statushash
1.630     raeburn  9546: 9. flag if privileged users (except those set to unhide in
                   9547:    course settings) should be excluded    
1.609     raeburn  9548: Keys of top level results hash are roles.
1.275     raeburn  9549: Keys of inner hashes are username:domain, with 
                   9550: values set to access type.
1.288     raeburn  9551: Optional userdata hash returns an array with arguments in the 
                   9552: same order as loncoursedata::get_classlist() for student data.
                   9553: 
1.609     raeburn  9554: Optional statushash returns
                   9555: 
1.288     raeburn  9556: Entries for end, start, section and status are blank because
                   9557: of the possibility of multiple values for non-student roles.
                   9558: 
1.275     raeburn  9559: =cut
1.405     albertel 9560: 
1.275     raeburn  9561: ###############################################
1.405     albertel 9562: 
1.275     raeburn  9563: sub get_course_users {
1.630     raeburn  9564:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  9565:     my %idx = ();
1.419     raeburn  9566:     my %seclists;
1.288     raeburn  9567: 
                   9568:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   9569:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   9570:     $idx{end} = &Apache::loncoursedata::CL_END();
                   9571:     $idx{start} = &Apache::loncoursedata::CL_START();
                   9572:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   9573:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   9574:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   9575:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   9576: 
1.290     albertel 9577:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 9578:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  9579:         my $now = time;
1.277     albertel 9580:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  9581:             my $match = 0;
1.412     raeburn  9582:             my $secmatch = 0;
1.419     raeburn  9583:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  9584:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  9585:             if ($section eq '') {
                   9586:                 $section = 'none';
                   9587:             }
1.291     albertel 9588:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9589:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9590:                     $secmatch = 1;
                   9591:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 9592:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9593:                         $secmatch = 1;
                   9594:                     }
                   9595:                 } else {  
1.419     raeburn  9596: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  9597: 		        $secmatch = 1;
                   9598:                     }
1.290     albertel 9599: 		}
1.412     raeburn  9600:                 if (!$secmatch) {
                   9601:                     next;
                   9602:                 }
1.419     raeburn  9603:             }
1.275     raeburn  9604:             if (defined($$types{'active'})) {
1.288     raeburn  9605:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  9606:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  9607:                     $match = 1;
1.275     raeburn  9608:                 }
                   9609:             }
                   9610:             if (defined($$types{'previous'})) {
1.609     raeburn  9611:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  9612:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  9613:                     $match = 1;
1.275     raeburn  9614:                 }
                   9615:             }
                   9616:             if (defined($$types{'future'})) {
1.609     raeburn  9617:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  9618:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  9619:                     $match = 1;
1.275     raeburn  9620:                 }
                   9621:             }
1.609     raeburn  9622:             if ($match) {
                   9623:                 push(@{$seclists{$student}},$section);
                   9624:                 if (ref($userdata) eq 'HASH') {
                   9625:                     $$userdata{$student} = $$classlist{$student};
                   9626:                 }
                   9627:                 if (ref($statushash) eq 'HASH') {
                   9628:                     $statushash->{$student}{'st'}{$section} = $status;
                   9629:                 }
1.288     raeburn  9630:             }
1.275     raeburn  9631:         }
                   9632:     }
1.412     raeburn  9633:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9634:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9635:         my $now = time;
1.609     raeburn  9636:         my %displaystatus = ( previous => 'Expired',
                   9637:                               active   => 'Active',
                   9638:                               future   => 'Future',
                   9639:                             );
1.1075.2.36  raeburn  9640:         my (%nothide,@possdoms);
1.630     raeburn  9641:         if ($hidepriv) {
                   9642:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9643:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9644:                 if ($user !~ /:/) {
                   9645:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9646:                 } else {
                   9647:                     $nothide{$user} = 1;
                   9648:                 }
                   9649:             }
1.1075.2.36  raeburn  9650:             my @possdoms = ($cdom);
                   9651:             if ($coursehash{'checkforpriv'}) {
                   9652:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9653:             }
1.630     raeburn  9654:         }
1.439     raeburn  9655:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9656:             my $match = 0;
1.412     raeburn  9657:             my $secmatch = 0;
1.439     raeburn  9658:             my $status;
1.412     raeburn  9659:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9660:             $user =~ s/:$//;
1.439     raeburn  9661:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9662:             if ($end == -1 || $start == -1) {
                   9663:                 next;
                   9664:             }
                   9665:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9666:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9667:                 my ($uname,$udom) = split(/:/,$user);
                   9668:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9669:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9670:                         $secmatch = 1;
                   9671:                     } elsif ($usec eq '') {
1.420     albertel 9672:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9673:                             $secmatch = 1;
                   9674:                         }
                   9675:                     } else {
                   9676:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9677:                             $secmatch = 1;
                   9678:                         }
                   9679:                     }
                   9680:                     if (!$secmatch) {
                   9681:                         next;
                   9682:                     }
1.288     raeburn  9683:                 }
1.419     raeburn  9684:                 if ($usec eq '') {
                   9685:                     $usec = 'none';
                   9686:                 }
1.275     raeburn  9687:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9688:                     if ($hidepriv) {
1.1075.2.36  raeburn  9689:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9690:                             (!$nothide{$uname.':'.$udom})) {
                   9691:                             next;
                   9692:                         }
                   9693:                     }
1.503     raeburn  9694:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9695:                         $status = 'previous';
                   9696:                     } elsif ($start > $now) {
                   9697:                         $status = 'future';
                   9698:                     } else {
                   9699:                         $status = 'active';
                   9700:                     }
1.277     albertel 9701:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9702:                         if ($status eq $type) {
1.420     albertel 9703:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9704:                                 push(@{$$users{$role}{$user}},$type);
                   9705:                             }
1.288     raeburn  9706:                             $match = 1;
                   9707:                         }
                   9708:                     }
1.419     raeburn  9709:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9710:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9711: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9712:                         }
1.420     albertel 9713:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9714:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9715:                         }
1.609     raeburn  9716:                         if (ref($statushash) eq 'HASH') {
                   9717:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9718:                         }
1.275     raeburn  9719:                     }
                   9720:                 }
                   9721:             }
                   9722:         }
1.290     albertel 9723:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9724:             if ((defined($cdom)) && (defined($cnum))) {
                   9725:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9726:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9727:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9728:                     next if ($owner eq '');
                   9729:                     my ($ownername,$ownerdom);
                   9730:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9731:                         $ownername = $1;
                   9732:                         $ownerdom = $2;
                   9733:                     } else {
                   9734:                         $ownername = $owner;
                   9735:                         $ownerdom = $cdom;
                   9736:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9737:                     }
                   9738:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9739:                     if (defined($userdata) && 
1.609     raeburn  9740: 			!exists($$userdata{$owner})) {
                   9741: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9742:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9743:                             push(@{$seclists{$owner}},'none');
                   9744:                         }
                   9745:                         if (ref($statushash) eq 'HASH') {
                   9746:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9747:                         }
1.290     albertel 9748: 		    }
1.279     raeburn  9749:                 }
                   9750:             }
                   9751:         }
1.419     raeburn  9752:         foreach my $user (keys(%seclists)) {
                   9753:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9754:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9755:         }
1.275     raeburn  9756:     }
                   9757:     return;
                   9758: }
                   9759: 
1.288     raeburn  9760: sub get_user_info {
                   9761:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9762:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9763: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9764:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9765:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9766:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9767:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9768:     return;
                   9769: }
1.275     raeburn  9770: 
1.472     raeburn  9771: ###############################################
                   9772: 
                   9773: =pod
                   9774: 
                   9775: =item * &get_user_quota()
                   9776: 
1.1075.2.41  raeburn  9777: Retrieves quota assigned for storage of user files.
                   9778: Default is to report quota for portfolio files.
1.472     raeburn  9779: 
                   9780: Incoming parameters:
                   9781: 1. user's username
                   9782: 2. user's domain
1.1075.2.41  raeburn  9783: 3. quota name - portfolio, author, or course
                   9784:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  9785: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  9786:    course
1.472     raeburn  9787: 
                   9788: Returns:
1.1075.2.58  raeburn  9789: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9790: 2. (Optional) Type of setting: custom or default
                   9791:    (individually assigned or default for user's 
                   9792:    institutional status).
                   9793: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9794:    or student - types as defined in localenroll::inst_usertypes 
                   9795:    for user's domain, which determines default quota for user.
                   9796: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9797: 
                   9798: If a value has been stored in the user's environment, 
1.536     raeburn  9799: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  9800: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9801: 
                   9802: =cut
                   9803: 
                   9804: ###############################################
                   9805: 
                   9806: 
                   9807: sub get_user_quota {
1.1075.2.42  raeburn  9808:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9809:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9810:     if (!defined($udom)) {
                   9811:         $udom = $env{'user.domain'};
                   9812:     }
                   9813:     if (!defined($uname)) {
                   9814:         $uname = $env{'user.name'};
                   9815:     }
                   9816:     if (($udom eq '' || $uname eq '') ||
                   9817:         ($udom eq 'public') && ($uname eq 'public')) {
                   9818:         $quota = 0;
1.536     raeburn  9819:         $quotatype = 'default';
                   9820:         $defquota = 0; 
1.472     raeburn  9821:     } else {
1.536     raeburn  9822:         my $inststatus;
1.1075.2.41  raeburn  9823:         if ($quotaname eq 'course') {
                   9824:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9825:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9826:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9827:             } else {
                   9828:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9829:                 $quota = $cenv{'internal.uploadquota'};
                   9830:             }
1.536     raeburn  9831:         } else {
1.1075.2.41  raeburn  9832:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   9833:                 if ($quotaname eq 'author') {
                   9834:                     $quota = $env{'environment.authorquota'};
                   9835:                 } else {
                   9836:                     $quota = $env{'environment.portfolioquota'};
                   9837:                 }
                   9838:                 $inststatus = $env{'environment.inststatus'};
                   9839:             } else {
                   9840:                 my %userenv = 
                   9841:                     &Apache::lonnet::get('environment',['portfolioquota',
                   9842:                                          'authorquota','inststatus'],$udom,$uname);
                   9843:                 my ($tmp) = keys(%userenv);
                   9844:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9845:                     if ($quotaname eq 'author') {
                   9846:                         $quota = $userenv{'authorquota'};
                   9847:                     } else {
                   9848:                         $quota = $userenv{'portfolioquota'};
                   9849:                     }
                   9850:                     $inststatus = $userenv{'inststatus'};
                   9851:                 } else {
                   9852:                     undef(%userenv);
                   9853:                 }
                   9854:             }
                   9855:         }
                   9856:         if ($quota eq '' || wantarray) {
                   9857:             if ($quotaname eq 'course') {
                   9858:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  9859:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   9860:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  9861:                     $defquota = $domdefs{$crstype.'quota'};
                   9862:                 }
                   9863:                 if ($defquota eq '') {
                   9864:                     $defquota = 500;
                   9865:                 }
1.1075.2.41  raeburn  9866:             } else {
                   9867:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   9868:             }
                   9869:             if ($quota eq '') {
                   9870:                 $quota = $defquota;
                   9871:                 $quotatype = 'default';
                   9872:             } else {
                   9873:                 $quotatype = 'custom';
                   9874:             }
1.472     raeburn  9875:         }
                   9876:     }
1.536     raeburn  9877:     if (wantarray) {
                   9878:         return ($quota,$quotatype,$settingstatus,$defquota);
                   9879:     } else {
                   9880:         return $quota;
                   9881:     }
1.472     raeburn  9882: }
                   9883: 
                   9884: ###############################################
                   9885: 
                   9886: =pod
                   9887: 
                   9888: =item * &default_quota()
                   9889: 
1.536     raeburn  9890: Retrieves default quota assigned for storage of user portfolio files,
                   9891: given an (optional) user's institutional status.
1.472     raeburn  9892: 
                   9893: Incoming parameters:
1.1075.2.42  raeburn  9894: 
1.472     raeburn  9895: 1. domain
1.536     raeburn  9896: 2. (Optional) institutional status(es).  This is a : separated list of 
                   9897:    status types (e.g., faculty, staff, student etc.)
                   9898:    which apply to the user for whom the default is being retrieved.
                   9899:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  9900:    default quota will be returned.
                   9901: 3.  quota name - portfolio, author, or course
                   9902:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  9903: 
                   9904: Returns:
1.1075.2.42  raeburn  9905: 
1.1075.2.58  raeburn  9906: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  9907: 2. (Optional) institutional type which determined the value of the
                   9908:    default quota.
1.472     raeburn  9909: 
                   9910: If a value has been stored in the domain's configuration db,
                   9911: it will return that, otherwise it returns 20 (for backwards 
                   9912: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  9913: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  9914: 
1.536     raeburn  9915: If the user's status includes multiple types (e.g., staff and student),
                   9916: the largest default quota which applies to the user determines the
                   9917: default quota returned.
                   9918: 
1.472     raeburn  9919: =cut
                   9920: 
                   9921: ###############################################
                   9922: 
                   9923: 
                   9924: sub default_quota {
1.1075.2.41  raeburn  9925:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  9926:     my ($defquota,$settingstatus);
                   9927:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  9928:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  9929:     my $key = 'defaultquota';
                   9930:     if ($quotaname eq 'author') {
                   9931:         $key = 'authorquota';
                   9932:     }
1.622     raeburn  9933:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  9934:         if ($inststatus ne '') {
1.765     raeburn  9935:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  9936:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  9937:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9938:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  9939:                         if ($defquota eq '') {
1.1075.2.41  raeburn  9940:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9941:                             $settingstatus = $item;
1.1075.2.41  raeburn  9942:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   9943:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9944:                             $settingstatus = $item;
                   9945:                         }
                   9946:                     }
1.1075.2.41  raeburn  9947:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  9948:                     if ($quotahash{'quotas'}{$item} ne '') {
                   9949:                         if ($defquota eq '') {
                   9950:                             $defquota = $quotahash{'quotas'}{$item};
                   9951:                             $settingstatus = $item;
                   9952:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   9953:                             $defquota = $quotahash{'quotas'}{$item};
                   9954:                             $settingstatus = $item;
                   9955:                         }
1.536     raeburn  9956:                     }
                   9957:                 }
                   9958:             }
                   9959:         }
                   9960:         if ($defquota eq '') {
1.1075.2.41  raeburn  9961:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9962:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   9963:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  9964:                 $defquota = $quotahash{'quotas'}{'default'};
                   9965:             }
1.536     raeburn  9966:             $settingstatus = 'default';
1.1075.2.42  raeburn  9967:             if ($defquota eq '') {
                   9968:                 if ($quotaname eq 'author') {
                   9969:                     $defquota = 500;
                   9970:                 }
                   9971:             }
1.536     raeburn  9972:         }
                   9973:     } else {
                   9974:         $settingstatus = 'default';
1.1075.2.41  raeburn  9975:         if ($quotaname eq 'author') {
                   9976:             $defquota = 500;
                   9977:         } else {
                   9978:             $defquota = 20;
                   9979:         }
1.536     raeburn  9980:     }
                   9981:     if (wantarray) {
                   9982:         return ($defquota,$settingstatus);
1.472     raeburn  9983:     } else {
1.536     raeburn  9984:         return $defquota;
1.472     raeburn  9985:     }
                   9986: }
                   9987: 
1.1075.2.41  raeburn  9988: ###############################################
                   9989: 
                   9990: =pod
                   9991: 
1.1075.2.42  raeburn  9992: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  9993: 
                   9994: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  9995: of existing file within authoring space will cause quota for the authoring
                   9996: space to be exceeded.
                   9997: 
                   9998: Same, if upload of a file directly to a course/community via Course Editor
                   9999: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  10000: 
1.1075.2.61  raeburn  10001: Inputs: 7 
1.1075.2.42  raeburn  10002: 1. username or coursenum
1.1075.2.41  raeburn  10003: 2. domain
1.1075.2.42  raeburn  10004: 3. context ('author' or 'course')
1.1075.2.41  raeburn  10005: 4. filename of file for which action is being requested
                   10006: 5. filesize (kB) of file
                   10007: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  10008: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  10009: 
                   10010: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   10011:          otherwise return null.
                   10012: 
1.1075.2.42  raeburn  10013: =back
                   10014: 
1.1075.2.41  raeburn  10015: =cut
                   10016: 
1.1075.2.42  raeburn  10017: sub excess_filesize_warning {
1.1075.2.59  raeburn  10018:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  10019:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  10020:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  10021:     if ($context eq 'author') {
                   10022:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   10023:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   10024:     } else {
                   10025:         foreach my $subdir ('docs','supplemental') {
                   10026:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   10027:         }
                   10028:     }
1.1075.2.41  raeburn  10029:     $disk_quota = int($disk_quota * 1000);
                   10030:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  10031:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  10032:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  10033:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   10034:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  10035:                             $disk_quota,$current_disk_usage).
                   10036:                '</p>';
                   10037:     }
                   10038:     return;
                   10039: }
                   10040: 
                   10041: ###############################################
                   10042: 
                   10043: 
1.384     raeburn  10044: sub get_secgrprole_info {
                   10045:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   10046:     my %sections_count = &get_sections($cdom,$cnum);
                   10047:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   10048:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   10049:     my @groups = sort(keys(%curr_groups));
                   10050:     my $allroles = [];
                   10051:     my $rolehash;
                   10052:     my $accesshash = {
                   10053:                      active => 'Currently has access',
                   10054:                      future => 'Will have future access',
                   10055:                      previous => 'Previously had access',
                   10056:                   };
                   10057:     if ($needroles) {
                   10058:         $rolehash = {'all' => 'all'};
1.385     albertel 10059:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   10060: 	if (&Apache::lonnet::error(%user_roles)) {
                   10061: 	    undef(%user_roles);
                   10062: 	}
                   10063:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  10064:             my ($role)=split(/\:/,$item,2);
                   10065:             if ($role eq 'cr') { next; }
                   10066:             if ($role =~ /^cr/) {
                   10067:                 $$rolehash{$role} = (split('/',$role))[3];
                   10068:             } else {
                   10069:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   10070:             }
                   10071:         }
                   10072:         foreach my $key (sort(keys(%{$rolehash}))) {
                   10073:             push(@{$allroles},$key);
                   10074:         }
                   10075:         push (@{$allroles},'st');
                   10076:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   10077:     }
                   10078:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   10079: }
                   10080: 
1.555     raeburn  10081: sub user_picker {
1.1075.2.127  raeburn  10082:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  10083:     my $currdom = $dom;
1.1075.2.114  raeburn  10084:     my @alldoms = &Apache::lonnet::all_domains();
                   10085:     if (@alldoms == 1) {
                   10086:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   10087:                                                ['directorysrch'],$alldoms[0]);
                   10088:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   10089:         my $showdom = $domdesc;
                   10090:         if ($showdom eq '') {
                   10091:             $showdom = $dom;
                   10092:         }
                   10093:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   10094:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   10095:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   10096:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   10097:             }
                   10098:         }
                   10099:     }
1.555     raeburn  10100:     my %curr_selected = (
                   10101:                         srchin => 'dom',
1.580     raeburn  10102:                         srchby => 'lastname',
1.555     raeburn  10103:                       );
                   10104:     my $srchterm;
1.625     raeburn  10105:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  10106:         if ($srch->{'srchby'} ne '') {
                   10107:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   10108:         }
                   10109:         if ($srch->{'srchin'} ne '') {
                   10110:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   10111:         }
                   10112:         if ($srch->{'srchtype'} ne '') {
                   10113:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   10114:         }
                   10115:         if ($srch->{'srchdomain'} ne '') {
                   10116:             $currdom = $srch->{'srchdomain'};
                   10117:         }
                   10118:         $srchterm = $srch->{'srchterm'};
                   10119:     }
1.1075.2.98  raeburn  10120:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  10121:                     'usr'       => 'Search criteria',
1.563     raeburn  10122:                     'doma'      => 'Domain/institution to search',
1.558     albertel 10123:                     'uname'     => 'username',
                   10124:                     'lastname'  => 'last name',
1.555     raeburn  10125:                     'lastfirst' => 'last name, first name',
1.558     albertel 10126:                     'crs'       => 'in this course',
1.576     raeburn  10127:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 10128:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  10129:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 10130:                     'exact'     => 'is',
                   10131:                     'contains'  => 'contains',
1.569     raeburn  10132:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  10133:                                        );
                   10134:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  10135:                     'youm'      => "You must include some text to search for.",
                   10136:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   10137:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   10138:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   10139:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   10140:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   10141:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   10142:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  10143:                                        );
1.1075.2.98  raeburn  10144:     &html_escape(\%html_lt);
                   10145:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  10146:     my $domform;
1.1075.2.126  raeburn  10147:     my $allow_blank = 1;
1.1075.2.115  raeburn  10148:     if ($fixeddom) {
1.1075.2.126  raeburn  10149:         $allow_blank = 0;
                   10150:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  10151:     } else {
1.1075.2.126  raeburn  10152:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  10153:     }
1.563     raeburn  10154:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  10155: 
                   10156:     my @srchins = ('crs','dom','alc','instd');
                   10157: 
                   10158:     foreach my $option (@srchins) {
                   10159:         # FIXME 'alc' option unavailable until 
                   10160:         #       loncreateuser::print_user_query_page()
                   10161:         #       has been completed.
                   10162:         next if ($option eq 'alc');
1.880     raeburn  10163:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  10164:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  10165:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  10166:         if ($curr_selected{'srchin'} eq $option) {
                   10167:             $srchinsel .= ' 
1.1075.2.98  raeburn  10168:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  10169:         } else {
                   10170:             $srchinsel .= '
1.1075.2.98  raeburn  10171:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  10172:         }
1.555     raeburn  10173:     }
1.563     raeburn  10174:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  10175: 
                   10176:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  10177:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  10178:         if ($curr_selected{'srchby'} eq $option) {
                   10179:             $srchbysel .= '
1.1075.2.98  raeburn  10180:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10181:         } else {
                   10182:             $srchbysel .= '
1.1075.2.98  raeburn  10183:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10184:          }
                   10185:     }
                   10186:     $srchbysel .= "\n  </select>\n";
                   10187: 
                   10188:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  10189:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  10190:         if ($curr_selected{'srchtype'} eq $option) {
                   10191:             $srchtypesel .= '
1.1075.2.98  raeburn  10192:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10193:         } else {
                   10194:             $srchtypesel .= '
1.1075.2.98  raeburn  10195:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10196:         }
                   10197:     }
                   10198:     $srchtypesel .= "\n  </select>\n";
                   10199: 
1.558     albertel 10200:     my ($newuserscript,$new_user_create);
1.994     raeburn  10201:     my $context_dom = $env{'request.role.domain'};
                   10202:     if ($context eq 'requestcrs') {
                   10203:         if ($env{'form.coursedom'} ne '') { 
                   10204:             $context_dom = $env{'form.coursedom'};
                   10205:         }
                   10206:     }
1.556     raeburn  10207:     if ($forcenewuser) {
1.576     raeburn  10208:         if (ref($srch) eq 'HASH') {
1.994     raeburn  10209:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  10210:                 if ($cancreate) {
                   10211:                     $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>';
                   10212:                 } else {
1.799     bisitz   10213:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  10214:                     my %usertypetext = (
                   10215:                         official   => 'institutional',
                   10216:                         unofficial => 'non-institutional',
                   10217:                     );
1.799     bisitz   10218:                     $new_user_create = '<p class="LC_warning">'
                   10219:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   10220:                                       .' '
                   10221:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   10222:                                           ,'<a href="'.$helplink.'">','</a>')
                   10223:                                       .'</p><br />';
1.627     raeburn  10224:                 }
1.576     raeburn  10225:             }
                   10226:         }
                   10227: 
1.556     raeburn  10228:         $newuserscript = <<"ENDSCRIPT";
                   10229: 
1.570     raeburn  10230: function setSearch(createnew,callingForm) {
1.556     raeburn  10231:     if (createnew == 1) {
1.570     raeburn  10232:         for (var i=0; i<callingForm.srchby.length; i++) {
                   10233:             if (callingForm.srchby.options[i].value == 'uname') {
                   10234:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  10235:             }
                   10236:         }
1.570     raeburn  10237:         for (var i=0; i<callingForm.srchin.length; i++) {
                   10238:             if ( callingForm.srchin.options[i].value == 'dom') {
                   10239: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  10240:             }
                   10241:         }
1.570     raeburn  10242:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   10243:             if (callingForm.srchtype.options[i].value == 'exact') {
                   10244:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  10245:             }
                   10246:         }
1.570     raeburn  10247:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  10248:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  10249:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  10250:             }
                   10251:         }
                   10252:     }
                   10253: }
                   10254: ENDSCRIPT
1.558     albertel 10255: 
1.556     raeburn  10256:     }
                   10257: 
1.555     raeburn  10258:     my $output = <<"END_BLOCK";
1.556     raeburn  10259: <script type="text/javascript">
1.824     bisitz   10260: // <![CDATA[
1.570     raeburn  10261: function validateEntry(callingForm) {
1.558     albertel 10262: 
1.556     raeburn  10263:     var checkok = 1;
1.558     albertel 10264:     var srchin;
1.570     raeburn  10265:     for (var i=0; i<callingForm.srchin.length; i++) {
                   10266: 	if ( callingForm.srchin[i].checked ) {
                   10267: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 10268: 	}
                   10269:     }
                   10270: 
1.570     raeburn  10271:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   10272:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   10273:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   10274:     var srchterm =  callingForm.srchterm.value;
                   10275:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  10276:     var msg = "";
                   10277: 
                   10278:     if (srchterm == "") {
                   10279:         checkok = 0;
1.1075.2.98  raeburn  10280:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  10281:     }
                   10282: 
1.569     raeburn  10283:     if (srchtype== 'begins') {
                   10284:         if (srchterm.length < 2) {
                   10285:             checkok = 0;
1.1075.2.98  raeburn  10286:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  10287:         }
                   10288:     }
                   10289: 
1.556     raeburn  10290:     if (srchtype== 'contains') {
                   10291:         if (srchterm.length < 3) {
                   10292:             checkok = 0;
1.1075.2.98  raeburn  10293:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  10294:         }
                   10295:     }
                   10296:     if (srchin == 'instd') {
                   10297:         if (srchdomain == '') {
                   10298:             checkok = 0;
1.1075.2.98  raeburn  10299:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  10300:         }
                   10301:     }
                   10302:     if (srchin == 'dom') {
                   10303:         if (srchdomain == '') {
                   10304:             checkok = 0;
1.1075.2.98  raeburn  10305:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  10306:         }
                   10307:     }
                   10308:     if (srchby == 'lastfirst') {
                   10309:         if (srchterm.indexOf(",") == -1) {
                   10310:             checkok = 0;
1.1075.2.98  raeburn  10311:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  10312:         }
                   10313:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   10314:             checkok = 0;
1.1075.2.98  raeburn  10315:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  10316:         }
                   10317:     }
                   10318:     if (checkok == 0) {
1.1075.2.98  raeburn  10319:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  10320:         return;
                   10321:     }
                   10322:     if (checkok == 1) {
1.570     raeburn  10323:         callingForm.submit();
1.556     raeburn  10324:     }
                   10325: }
                   10326: 
                   10327: $newuserscript
                   10328: 
1.824     bisitz   10329: // ]]>
1.556     raeburn  10330: </script>
1.558     albertel 10331: 
                   10332: $new_user_create
                   10333: 
1.555     raeburn  10334: END_BLOCK
1.558     albertel 10335: 
1.876     raeburn  10336:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  10337:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  10338:                $domform.
                   10339:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  10340:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  10341:                $srchbysel.
                   10342:                $srchtypesel. 
                   10343:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   10344:                $srchinsel.
                   10345:                &Apache::lonhtmlcommon::row_closure(1). 
                   10346:                &Apache::lonhtmlcommon::end_pick_box().
                   10347:                '<br />';
1.1075.2.114  raeburn  10348:     return ($output,1);
1.555     raeburn  10349: }
                   10350: 
1.612     raeburn  10351: sub user_rule_check {
1.615     raeburn  10352:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  10353:     my ($response,%inst_response);
1.612     raeburn  10354:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  10355:         if (keys(%{$usershash}) > 1) {
                   10356:             my (%by_username,%by_id,%userdoms);
                   10357:             my $checkid;
1.612     raeburn  10358:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  10359:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   10360:                     $checkid = 1;
                   10361:                 }
                   10362:             }
                   10363:             foreach my $user (keys(%{$usershash})) {
                   10364:                 my ($uname,$udom) = split(/:/,$user);
                   10365:                 if ($checkid) {
                   10366:                     if (ref($usershash->{$user}) eq 'HASH') {
                   10367:                         if ($usershash->{$user}->{'id'} ne '') {
                   10368:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   10369:                             $userdoms{$udom} = 1;
                   10370:                             if (ref($inst_results) eq 'HASH') {
                   10371:                                 $inst_results->{$uname.':'.$udom} = {};
                   10372:                             }
                   10373:                         }
                   10374:                     }
                   10375:                 } else {
                   10376:                     $by_username{$udom}{$uname} = 1;
                   10377:                     $userdoms{$udom} = 1;
                   10378:                     if (ref($inst_results) eq 'HASH') {
                   10379:                         $inst_results->{$uname.':'.$udom} = {};
                   10380:                     }
                   10381:                 }
                   10382:             }
                   10383:             foreach my $udom (keys(%userdoms)) {
                   10384:                 if (!$got_rules->{$udom}) {
                   10385:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10386:                                                              ['usercreation'],$udom);
                   10387:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10388:                         foreach my $item ('username','id') {
                   10389:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10390:                                 $$curr_rules{$udom}{$item} =
                   10391:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   10392:                             }
                   10393:                         }
                   10394:                     }
                   10395:                     $got_rules->{$udom} = 1;
                   10396:                 }
                   10397:             }
                   10398:             if ($checkid) {
                   10399:                 foreach my $udom (keys(%by_id)) {
                   10400:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   10401:                     if ($outcome eq 'ok') {
                   10402:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   10403:                             my $uname = $by_id{$udom}{$id};
                   10404:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10405:                         }
                   10406:                         if (ref($results) eq 'HASH') {
                   10407:                             foreach my $uname (keys(%{$results})) {
                   10408:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   10409:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   10410:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10411:                                 }
                   10412:                             }
                   10413:                         }
                   10414:                     }
1.612     raeburn  10415:                 }
1.615     raeburn  10416:             } else {
1.1075.2.99  raeburn  10417:                 foreach my $udom (keys(%by_username)) {
                   10418:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   10419:                     if ($outcome eq 'ok') {
                   10420:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   10421:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10422:                         }
                   10423:                         if (ref($results) eq 'HASH') {
                   10424:                             foreach my $uname (keys(%{$results})) {
                   10425:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10426:                             }
                   10427:                         }
                   10428:                     }
                   10429:                 }
1.612     raeburn  10430:             }
1.1075.2.99  raeburn  10431:         } elsif (keys(%{$usershash}) == 1) {
                   10432:             my $user = (keys(%{$usershash}))[0];
                   10433:             my ($uname,$udom) = split(/:/,$user);
                   10434:             if (($udom ne '') && ($uname ne '')) {
                   10435:                 if (ref($usershash->{$user}) eq 'HASH') {
                   10436:                     if (ref($checks) eq 'HASH') {
                   10437:                         if (defined($checks->{'username'})) {
                   10438:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   10439:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   10440:                         } elsif (defined($checks->{'id'})) {
                   10441:                             if ($usershash->{$user}->{'id'} ne '') {
                   10442:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10443:                                     &Apache::lonnet::get_instuser($udom,undef,
                   10444:                                                                   $usershash->{$user}->{'id'});
                   10445:                             } else {
                   10446:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10447:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   10448:                             }
                   10449:                         }
                   10450:                     } else {
                   10451:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   10452:                             &Apache::lonnet::get_instuser($udom,$uname);
                   10453:                        return;
                   10454:                     }
                   10455:                     if (!$got_rules->{$udom}) {
                   10456:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10457:                                                                  ['usercreation'],$udom);
                   10458:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10459:                             foreach my $item ('username','id') {
                   10460:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10461:                                    $$curr_rules{$udom}{$item} =
                   10462:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   10463:                                 }
                   10464:                             }
1.585     raeburn  10465:                         }
1.1075.2.99  raeburn  10466:                         $got_rules->{$udom} = 1;
1.585     raeburn  10467:                     }
                   10468:                 }
1.1075.2.99  raeburn  10469:             } else {
                   10470:                 return;
                   10471:             }
                   10472:         } else {
                   10473:             return;
                   10474:         }
                   10475:         foreach my $user (keys(%{$usershash})) {
                   10476:             my ($uname,$udom) = split(/:/,$user);
                   10477:             next if (($udom eq '') || ($uname eq ''));
                   10478:             my $id;
                   10479:             if (ref($inst_results) eq 'HASH') {
                   10480:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   10481:                     $id = $inst_results->{$user}->{'id'};
                   10482:                 }
                   10483:             }
                   10484:             if ($id eq '') {
                   10485:                 if (ref($usershash->{$user})) {
                   10486:                     $id = $usershash->{$user}->{'id'};
                   10487:                 }
1.585     raeburn  10488:             }
1.612     raeburn  10489:             foreach my $item (keys(%{$checks})) {
                   10490:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   10491:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   10492:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  10493:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   10494:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  10495:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   10496:                                 if ($rule_check{$rule}) {
                   10497:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10498:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10499:                                         if (ref($inst_results) eq 'HASH') {
                   10500:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10501:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10502:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10503:                                                 } elsif ($item eq 'id') {
                   10504:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10505:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10506:                                                     }
1.615     raeburn  10507:                                                 }
1.612     raeburn  10508:                                             }
                   10509:                                         }
1.615     raeburn  10510:                                     }
                   10511:                                     last;
1.585     raeburn  10512:                                 }
                   10513:                             }
                   10514:                         }
                   10515:                     }
                   10516:                 }
                   10517:             }
                   10518:         }
                   10519:     }
1.612     raeburn  10520:     return;
                   10521: }
                   10522: 
                   10523: sub user_rule_formats {
                   10524:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10525:     my %text = ( 
                   10526:                  'username' => 'Usernames',
                   10527:                  'id'       => 'IDs',
                   10528:                );
                   10529:     my $output;
                   10530:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10531:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10532:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10533:             $output = '<br />'.
                   10534:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10535:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10536:                       ' <ul>';
1.612     raeburn  10537:             foreach my $rule (@{$ruleorder}) {
                   10538:                 if (ref($curr_rules) eq 'ARRAY') {
                   10539:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10540:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10541:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10542:                                         $rules->{$rule}{'desc'}.'</li>';
                   10543:                         }
                   10544:                     }
                   10545:                 }
                   10546:             }
                   10547:             $output .= '</ul>';
                   10548:         }
                   10549:     }
                   10550:     return $output;
                   10551: }
                   10552: 
                   10553: sub instrule_disallow_msg {
1.615     raeburn  10554:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  10555:     my $response;
                   10556:     my %text = (
                   10557:                   item   => 'username',
                   10558:                   items  => 'usernames',
                   10559:                   match  => 'matches',
                   10560:                   do     => 'does',
                   10561:                   action => 'a username',
                   10562:                   one    => 'one',
                   10563:                );
                   10564:     if ($count > 1) {
                   10565:         $text{'item'} = 'usernames';
                   10566:         $text{'match'} ='match';
                   10567:         $text{'do'} = 'do';
                   10568:         $text{'action'} = 'usernames',
                   10569:         $text{'one'} = 'ones';
                   10570:     }
                   10571:     if ($checkitem eq 'id') {
                   10572:         $text{'items'} = 'IDs';
                   10573:         $text{'item'} = 'ID';
                   10574:         $text{'action'} = 'an ID';
1.615     raeburn  10575:         if ($count > 1) {
                   10576:             $text{'item'} = 'IDs';
                   10577:             $text{'action'} = 'IDs';
                   10578:         }
1.612     raeburn  10579:     }
1.674     bisitz   10580:     $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  10581:     if ($mode eq 'upload') {
                   10582:         if ($checkitem eq 'username') {
                   10583:             $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'}.");
                   10584:         } elsif ($checkitem eq 'id') {
1.674     bisitz   10585:             $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  10586:         }
1.669     raeburn  10587:     } elsif ($mode eq 'selfcreate') {
                   10588:         if ($checkitem eq 'id') {
                   10589:             $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.");
                   10590:         }
1.615     raeburn  10591:     } else {
                   10592:         if ($checkitem eq 'username') {
                   10593:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   10594:         } elsif ($checkitem eq 'id') {
                   10595:             $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.");
                   10596:         }
1.612     raeburn  10597:     }
                   10598:     return $response;
1.585     raeburn  10599: }
                   10600: 
1.624     raeburn  10601: sub personal_data_fieldtitles {
                   10602:     my %fieldtitles = &Apache::lonlocal::texthash (
                   10603:                         id => 'Student/Employee ID',
                   10604:                         permanentemail => 'E-mail address',
                   10605:                         lastname => 'Last Name',
                   10606:                         firstname => 'First Name',
                   10607:                         middlename => 'Middle Name',
                   10608:                         generation => 'Generation',
                   10609:                         gen => 'Generation',
1.765     raeburn  10610:                         inststatus => 'Affiliation',
1.624     raeburn  10611:                    );
                   10612:     return %fieldtitles;
                   10613: }
                   10614: 
1.642     raeburn  10615: sub sorted_inst_types {
                   10616:     my ($dom) = @_;
1.1075.2.70  raeburn  10617:     my ($usertypes,$order);
                   10618:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   10619:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   10620:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   10621:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   10622:     } else {
                   10623:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   10624:     }
1.642     raeburn  10625:     my $othertitle = &mt('All users');
                   10626:     if ($env{'request.course.id'}) {
1.668     raeburn  10627:         $othertitle  = &mt('Any users');
1.642     raeburn  10628:     }
                   10629:     my @types;
                   10630:     if (ref($order) eq 'ARRAY') {
                   10631:         @types = @{$order};
                   10632:     }
                   10633:     if (@types == 0) {
                   10634:         if (ref($usertypes) eq 'HASH') {
                   10635:             @types = sort(keys(%{$usertypes}));
                   10636:         }
                   10637:     }
                   10638:     if (keys(%{$usertypes}) > 0) {
                   10639:         $othertitle = &mt('Other users');
                   10640:     }
                   10641:     return ($othertitle,$usertypes,\@types);
                   10642: }
                   10643: 
1.645     raeburn  10644: sub get_institutional_codes {
1.1075.2.157  raeburn  10645:     my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645     raeburn  10646: # Get complete list of course sections to update
                   10647:     my @currsections = ();
                   10648:     my @currxlists = ();
1.1075.2.157  raeburn  10649:     my (%unclutteredsec,%unclutteredlcsec);
1.645     raeburn  10650:     my $coursecode = $$settings{'internal.coursecode'};
1.1075.2.157  raeburn  10651:     my $crskey = $crs.':'.$coursecode;
                   10652:     @{$unclutteredsec{$crskey}} = ();
                   10653:     @{$unclutteredlcsec{$crskey}} = ();
1.645     raeburn  10654: 
                   10655:     if ($$settings{'internal.sectionnums'} ne '') {
                   10656:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   10657:     }
                   10658: 
                   10659:     if ($$settings{'internal.crosslistings'} ne '') {
                   10660:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   10661:     }
                   10662: 
                   10663:     if (@currxlists > 0) {
1.1075.2.157  raeburn  10664:         foreach my $xl (@currxlists) {
                   10665:             if ($xl =~ /^([^:]+):(\w*)$/) {
1.645     raeburn  10666:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  10667:                     push(@{$allcourses},$1);
1.645     raeburn  10668:                     $$LC_code{$1} = $2;
                   10669:                 }
                   10670:             }
                   10671:         }
                   10672:     }
1.1075.2.157  raeburn  10673: 
1.645     raeburn  10674:     if (@currsections > 0) {
1.1075.2.157  raeburn  10675:         foreach my $sec (@currsections) {
                   10676:             if ($sec =~ m/^(\w+):(\w*)$/ ) {
                   10677:                 my $instsec = $1;
1.645     raeburn  10678:                 my $lc_sec = $2;
1.1075.2.157  raeburn  10679:                 unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
                   10680:                     push(@{$unclutteredsec{$crskey}},$instsec);
                   10681:                     push(@{$unclutteredlcsec{$crskey}},$lc_sec);
                   10682:                 }
                   10683:             }
                   10684:         }
                   10685:     }
                   10686: 
                   10687:     if (@{$unclutteredsec{$crskey}} > 0) {
                   10688:         my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
                   10689:         if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
                   10690:             for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
                   10691:                 my $sec = $coursecode.$formattedsec{$crskey}[$i];
                   10692:                 unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1075.2.119  raeburn  10693:                     push(@{$allcourses},$sec);
1.1075.2.157  raeburn  10694:                     $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645     raeburn  10695:                 }
                   10696:             }
                   10697:         }
                   10698:     }
                   10699:     return;
                   10700: }
                   10701: 
1.971     raeburn  10702: sub get_standard_codeitems {
                   10703:     return ('Year','Semester','Department','Number','Section');
                   10704: }
                   10705: 
1.112     bowersj2 10706: =pod
                   10707: 
1.780     raeburn  10708: =head1 Slot Helpers
                   10709: 
                   10710: =over 4
                   10711: 
                   10712: =item * sorted_slots()
                   10713: 
1.1040    raeburn  10714: Sorts an array of slot names in order of an optional sort key,
                   10715: default sort is by slot start time (earliest first). 
1.780     raeburn  10716: 
                   10717: Inputs:
                   10718: 
                   10719: =over 4
                   10720: 
                   10721: slotsarr  - Reference to array of unsorted slot names.
                   10722: 
                   10723: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   10724: 
1.1040    raeburn  10725: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   10726: 
1.549     albertel 10727: =back
                   10728: 
1.780     raeburn  10729: Returns:
                   10730: 
                   10731: =over 4
                   10732: 
1.1040    raeburn  10733: sorted   - An array of slot names sorted by a specified sort key 
                   10734:            (default sort key is start time of the slot).
1.780     raeburn  10735: 
                   10736: =back
                   10737: 
                   10738: =cut
                   10739: 
                   10740: 
                   10741: sub sorted_slots {
1.1040    raeburn  10742:     my ($slotsarr,$slots,$sortkey) = @_;
                   10743:     if ($sortkey eq '') {
                   10744:         $sortkey = 'starttime';
                   10745:     }
1.780     raeburn  10746:     my @sorted;
                   10747:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   10748:         @sorted =
                   10749:             sort {
                   10750:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  10751:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  10752:                      }
                   10753:                      if (ref($slots->{$a})) { return -1;}
                   10754:                      if (ref($slots->{$b})) { return 1;}
                   10755:                      return 0;
                   10756:                  } @{$slotsarr};
                   10757:     }
                   10758:     return @sorted;
                   10759: }
                   10760: 
1.1040    raeburn  10761: =pod
                   10762: 
                   10763: =item * get_future_slots()
                   10764: 
                   10765: Inputs:
                   10766: 
                   10767: =over 4
                   10768: 
                   10769: cnum - course number
                   10770: 
                   10771: cdom - course domain
                   10772: 
                   10773: now - current UNIX time
                   10774: 
                   10775: symb - optional symb
                   10776: 
                   10777: =back
                   10778: 
                   10779: Returns:
                   10780: 
                   10781: =over 4
                   10782: 
                   10783: sorted_reservable - ref to array of student_schedulable slots currently 
                   10784:                     reservable, ordered by end date of reservation period.
                   10785: 
                   10786: reservable_now - ref to hash of student_schedulable slots currently
                   10787:                  reservable.
                   10788: 
                   10789:     Keys in inner hash are:
                   10790:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  10791:     (b) endreserve: end date of reservation period.
                   10792:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10793:         selected.
1.1040    raeburn  10794: 
                   10795: sorted_future - ref to array of student_schedulable slots reservable in
                   10796:                 the future, ordered by start date of reservation period.
                   10797: 
                   10798: future_reservable - ref to hash of student_schedulable slots reservable
                   10799:                     in the future.
                   10800: 
                   10801:     Keys in inner hash are:
                   10802:     (a) symb: either blank or symb to which slot use is restricted.
                   10803:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  10804:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10805:         selected.
1.1040    raeburn  10806: 
                   10807: =back
                   10808: 
                   10809: =cut
                   10810: 
                   10811: sub get_future_slots {
                   10812:     my ($cnum,$cdom,$now,$symb) = @_;
                   10813:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10814:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10815:     foreach my $slot (keys(%slots)) {
                   10816:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10817:         if ($symb) {
                   10818:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10819:                      ($slots{$slot}->{'symb'} ne $symb));
                   10820:         }
                   10821:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10822:             ($slots{$slot}->{'endtime'} > $now)) {
                   10823:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10824:                 my $userallowed = 0;
                   10825:                 if ($slots{$slot}->{'allowedsections'}) {
                   10826:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10827:                     if (!defined($env{'request.role.sec'})
                   10828:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10829:                         $userallowed=1;
                   10830:                     } else {
                   10831:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   10832:                             $userallowed=1;
                   10833:                         }
                   10834:                     }
                   10835:                     unless ($userallowed) {
                   10836:                         if (defined($env{'request.course.groups'})) {
                   10837:                             my @groups = split(/:/,$env{'request.course.groups'});
                   10838:                             foreach my $group (@groups) {
                   10839:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   10840:                                     $userallowed=1;
                   10841:                                     last;
                   10842:                                 }
                   10843:                             }
                   10844:                         }
                   10845:                     }
                   10846:                 }
                   10847:                 if ($slots{$slot}->{'allowedusers'}) {
                   10848:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   10849:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   10850:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   10851:                         $userallowed = 1;
                   10852:                     }
                   10853:                 }
                   10854:                 next unless($userallowed);
                   10855:             }
                   10856:             my $startreserve = $slots{$slot}->{'startreserve'};
                   10857:             my $endreserve = $slots{$slot}->{'endreserve'};
                   10858:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  10859:             my $uniqueperiod;
                   10860:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   10861:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   10862:             }
1.1040    raeburn  10863:             if (($startreserve < $now) &&
                   10864:                 (!$endreserve || $endreserve > $now)) {
                   10865:                 my $lastres = $endreserve;
                   10866:                 if (!$lastres) {
                   10867:                     $lastres = $slots{$slot}->{'starttime'};
                   10868:                 }
                   10869:                 $reservable_now{$slot} = {
                   10870:                                            symb       => $symb,
1.1075.2.104  raeburn  10871:                                            endreserve => $lastres,
                   10872:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  10873:                                          };
                   10874:             } elsif (($startreserve > $now) &&
                   10875:                      (!$endreserve || $endreserve > $startreserve)) {
                   10876:                 $future_reservable{$slot} = {
                   10877:                                               symb         => $symb,
1.1075.2.104  raeburn  10878:                                               startreserve => $startreserve,
                   10879:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  10880:                                             };
                   10881:             }
                   10882:         }
                   10883:     }
                   10884:     my @unsorted_reservable = keys(%reservable_now);
                   10885:     if (@unsorted_reservable > 0) {
                   10886:         @sorted_reservable = 
                   10887:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   10888:     }
                   10889:     my @unsorted_future = keys(%future_reservable);
                   10890:     if (@unsorted_future > 0) {
                   10891:         @sorted_future =
                   10892:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   10893:     }
                   10894:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   10895: }
1.780     raeburn  10896: 
                   10897: =pod
                   10898: 
1.1057    foxr     10899: =back
                   10900: 
1.549     albertel 10901: =head1 HTTP Helpers
                   10902: 
                   10903: =over 4
                   10904: 
1.648     raeburn  10905: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 10906: 
1.258     albertel 10907: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 10908: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 10909: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 10910: 
                   10911: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   10912: $possible_names is an ref to an array of form element names.  As an example:
                   10913: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 10914: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 10915: 
                   10916: =cut
1.1       albertel 10917: 
1.6       albertel 10918: sub get_unprocessed_cgi {
1.25      albertel 10919:   my ($query,$possible_names)= @_;
1.26      matthew  10920:   # $Apache::lonxml::debug=1;
1.356     albertel 10921:   foreach my $pair (split(/&/,$query)) {
                   10922:     my ($name, $value) = split(/=/,$pair);
1.369     www      10923:     $name = &unescape($name);
1.25      albertel 10924:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   10925:       $value =~ tr/+/ /;
                   10926:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 10927:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 10928:     }
1.16      harris41 10929:   }
1.6       albertel 10930: }
                   10931: 
1.112     bowersj2 10932: =pod
                   10933: 
1.648     raeburn  10934: =item * &cacheheader() 
1.112     bowersj2 10935: 
                   10936: returns cache-controlling header code
                   10937: 
                   10938: =cut
                   10939: 
1.7       albertel 10940: sub cacheheader {
1.258     albertel 10941:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 10942:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   10943:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 10944:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   10945:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 10946:     return $output;
1.7       albertel 10947: }
                   10948: 
1.112     bowersj2 10949: =pod
                   10950: 
1.648     raeburn  10951: =item * &no_cache($r) 
1.112     bowersj2 10952: 
                   10953: specifies header code to not have cache
                   10954: 
                   10955: =cut
                   10956: 
1.9       albertel 10957: sub no_cache {
1.216     albertel 10958:     my ($r) = @_;
                   10959:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 10960: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 10961:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   10962:     $r->no_cache(1);
                   10963:     $r->header_out("Expires" => $date);
                   10964:     $r->header_out("Pragma" => "no-cache");
1.123     www      10965: }
                   10966: 
                   10967: sub content_type {
1.181     albertel 10968:     my ($r,$type,$charset) = @_;
1.299     foxr     10969:     if ($r) {
                   10970: 	#  Note that printout.pl calls this with undef for $r.
                   10971: 	&no_cache($r);
                   10972:     }
1.258     albertel 10973:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 10974:     unless ($charset) {
                   10975: 	$charset=&Apache::lonlocal::current_encoding;
                   10976:     }
                   10977:     if ($charset) { $type.='; charset='.$charset; }
                   10978:     if ($r) {
                   10979: 	$r->content_type($type);
                   10980:     } else {
                   10981: 	print("Content-type: $type\n\n");
                   10982:     }
1.9       albertel 10983: }
1.25      albertel 10984: 
1.112     bowersj2 10985: =pod
                   10986: 
1.648     raeburn  10987: =item * &add_to_env($name,$value) 
1.112     bowersj2 10988: 
1.258     albertel 10989: adds $name to the %env hash with value
1.112     bowersj2 10990: $value, if $name already exists, the entry is converted to an array
                   10991: reference and $value is added to the array.
                   10992: 
                   10993: =cut
                   10994: 
1.25      albertel 10995: sub add_to_env {
                   10996:   my ($name,$value)=@_;
1.258     albertel 10997:   if (defined($env{$name})) {
                   10998:     if (ref($env{$name})) {
1.25      albertel 10999:       #already have multiple values
1.258     albertel 11000:       push(@{ $env{$name} },$value);
1.25      albertel 11001:     } else {
                   11002:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 11003:       my $first=$env{$name};
                   11004:       undef($env{$name});
                   11005:       push(@{ $env{$name} },$first,$value);
1.25      albertel 11006:     }
                   11007:   } else {
1.258     albertel 11008:     $env{$name}=$value;
1.25      albertel 11009:   }
1.31      albertel 11010: }
1.149     albertel 11011: 
                   11012: =pod
                   11013: 
1.648     raeburn  11014: =item * &get_env_multiple($name) 
1.149     albertel 11015: 
1.258     albertel 11016: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 11017: values may be defined and end up as an array ref.
                   11018: 
                   11019: returns an array of values
                   11020: 
                   11021: =cut
                   11022: 
                   11023: sub get_env_multiple {
                   11024:     my ($name) = @_;
                   11025:     my @values;
1.258     albertel 11026:     if (defined($env{$name})) {
1.149     albertel 11027:         # exists is it an array
1.258     albertel 11028:         if (ref($env{$name})) {
                   11029:             @values=@{ $env{$name} };
1.149     albertel 11030:         } else {
1.258     albertel 11031:             $values[0]=$env{$name};
1.149     albertel 11032:         }
                   11033:     }
                   11034:     return(@values);
                   11035: }
                   11036: 
1.660     raeburn  11037: sub ask_for_embedded_content {
                   11038:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  11039:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  11040:         %currsubfile,%unused,$rem);
1.1071    raeburn  11041:     my $counter = 0;
                   11042:     my $numnew = 0;
1.987     raeburn  11043:     my $numremref = 0;
                   11044:     my $numinvalid = 0;
                   11045:     my $numpathchg = 0;
                   11046:     my $numexisting = 0;
1.1071    raeburn  11047:     my $numunused = 0;
                   11048:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  11049:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  11050:     my $heading = &mt('Upload embedded files');
                   11051:     my $buttontext = &mt('Upload');
                   11052: 
1.1075.2.11  raeburn  11053:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  11054:         if ($actionurl eq '/adm/dependencies') {
                   11055:             $navmap = Apache::lonnavmaps::navmap->new();
                   11056:         }
                   11057:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   11058:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  11059:     }
1.1075.2.35  raeburn  11060:     if (($actionurl eq '/adm/portfolio') ||
                   11061:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  11062:         my $current_path='/';
                   11063:         if ($env{'form.currentpath'}) {
                   11064:             $current_path = $env{'form.currentpath'};
                   11065:         }
                   11066:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  11067:             $udom = $cdom;
                   11068:             $uname = $cnum;
1.984     raeburn  11069:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   11070:         } else {
                   11071:             $udom = $env{'user.domain'};
                   11072:             $uname = $env{'user.name'};
                   11073:             $url = '/userfiles/portfolio';
                   11074:         }
1.987     raeburn  11075:         $toplevel = $url.'/';
1.984     raeburn  11076:         $url .= $current_path;
                   11077:         $getpropath = 1;
1.987     raeburn  11078:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   11079:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      11080:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  11081:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  11082:         $toplevel = $url;
1.984     raeburn  11083:         if ($rest ne '') {
1.987     raeburn  11084:             $url .= $rest;
                   11085:         }
                   11086:     } elsif ($actionurl eq '/adm/coursedocs') {
                   11087:         if (ref($args) eq 'HASH') {
1.1071    raeburn  11088:             $url = $args->{'docs_url'};
                   11089:             $toplevel = $url;
1.1075.2.11  raeburn  11090:             if ($args->{'context'} eq 'paste') {
                   11091:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   11092:                 ($path) =
                   11093:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11094:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11095:                 $fileloc =~ s{^/}{};
                   11096:             }
1.1071    raeburn  11097:         }
                   11098:     } elsif ($actionurl eq '/adm/dependencies') {
                   11099:         if ($env{'request.course.id'} ne '') {
                   11100:             if (ref($args) eq 'HASH') {
                   11101:                 $url = $args->{'docs_url'};
                   11102:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  11103:                 $toplevel = $url;
                   11104:                 unless ($toplevel =~ m{^/}) {
                   11105:                     $toplevel = "/$url";
                   11106:                 }
1.1075.2.11  raeburn  11107:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  11108:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   11109:                     $path = $1;
                   11110:                 } else {
                   11111:                     ($path) =
                   11112:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11113:                 }
1.1075.2.79  raeburn  11114:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   11115:                     $fileloc = $toplevel;
                   11116:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   11117:                     my ($udom,$uname,$fname) =
                   11118:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   11119:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   11120:                 } else {
                   11121:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11122:                 }
1.1071    raeburn  11123:                 $fileloc =~ s{^/}{};
                   11124:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   11125:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   11126:             }
1.987     raeburn  11127:         }
1.1075.2.35  raeburn  11128:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11129:         $udom = $cdom;
                   11130:         $uname = $cnum;
                   11131:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   11132:         $toplevel = $url;
                   11133:         $path = $url;
                   11134:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   11135:         $fileloc =~ s{^/}{};
                   11136:     }
                   11137:     foreach my $file (keys(%{$allfiles})) {
                   11138:         my $embed_file;
                   11139:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   11140:             $embed_file = $1;
                   11141:         } else {
                   11142:             $embed_file = $file;
                   11143:         }
1.1075.2.55  raeburn  11144:         my ($absolutepath,$cleaned_file);
                   11145:         if ($embed_file =~ m{^\w+://}) {
                   11146:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  11147:             $newfiles{$cleaned_file} = 1;
                   11148:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11149:         } else {
1.1075.2.55  raeburn  11150:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  11151:             if ($embed_file =~ m{^/}) {
                   11152:                 $absolutepath = $embed_file;
                   11153:             }
1.1075.2.47  raeburn  11154:             if ($cleaned_file =~ m{/}) {
                   11155:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  11156:                 $path = &check_for_traversal($path,$url,$toplevel);
                   11157:                 my $item = $fname;
                   11158:                 if ($path ne '') {
                   11159:                     $item = $path.'/'.$fname;
                   11160:                     $subdependencies{$path}{$fname} = 1;
                   11161:                 } else {
                   11162:                     $dependencies{$item} = 1;
                   11163:                 }
                   11164:                 if ($absolutepath) {
                   11165:                     $mapping{$item} = $absolutepath;
                   11166:                 } else {
                   11167:                     $mapping{$item} = $embed_file;
                   11168:                 }
                   11169:             } else {
                   11170:                 $dependencies{$embed_file} = 1;
                   11171:                 if ($absolutepath) {
1.1075.2.47  raeburn  11172:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  11173:                 } else {
1.1075.2.47  raeburn  11174:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11175:                 }
                   11176:             }
1.984     raeburn  11177:         }
                   11178:     }
1.1071    raeburn  11179:     my $dirptr = 16384;
1.984     raeburn  11180:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  11181:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  11182:         if (($actionurl eq '/adm/portfolio') ||
                   11183:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  11184:             my ($sublistref,$listerror) =
                   11185:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   11186:             if (ref($sublistref) eq 'ARRAY') {
                   11187:                 foreach my $line (@{$sublistref}) {
                   11188:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  11189:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  11190:                 }
1.984     raeburn  11191:             }
1.987     raeburn  11192:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11193:             if (opendir(my $dir,$url.'/'.$path)) {
                   11194:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  11195:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   11196:             }
1.1075.2.11  raeburn  11197:         } elsif (($actionurl eq '/adm/dependencies') ||
                   11198:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11199:                   ($args->{'context'} eq 'paste')) ||
                   11200:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11201:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  11202:                 my $dir;
                   11203:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11204:                     $dir = $fileloc;
                   11205:                 } else {
                   11206:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11207:                 }
1.1071    raeburn  11208:                 if ($dir ne '') {
                   11209:                     my ($sublistref,$listerror) =
                   11210:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   11211:                     if (ref($sublistref) eq 'ARRAY') {
                   11212:                         foreach my $line (@{$sublistref}) {
                   11213:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   11214:                                 undef,$mtime)=split(/\&/,$line,12);
                   11215:                             unless (($testdir&$dirptr) ||
                   11216:                                     ($file_name =~ /^\.\.?$/)) {
                   11217:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   11218:                             }
                   11219:                         }
                   11220:                     }
                   11221:                 }
1.984     raeburn  11222:             }
                   11223:         }
                   11224:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  11225:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  11226:                 my $item = $path.'/'.$file;
                   11227:                 unless ($mapping{$item} eq $item) {
                   11228:                     $pathchanges{$item} = 1;
                   11229:                 }
                   11230:                 $existing{$item} = 1;
                   11231:                 $numexisting ++;
                   11232:             } else {
                   11233:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  11234:             }
                   11235:         }
1.1071    raeburn  11236:         if ($actionurl eq '/adm/dependencies') {
                   11237:             foreach my $path (keys(%currsubfile)) {
                   11238:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   11239:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   11240:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  11241:                              next if (($rem ne '') &&
                   11242:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   11243:                                        (ref($navmap) &&
                   11244:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   11245:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11246:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  11247:                              $unused{$path.'/'.$file} = 1; 
                   11248:                          }
                   11249:                     }
                   11250:                 }
                   11251:             }
                   11252:         }
1.984     raeburn  11253:     }
1.987     raeburn  11254:     my %currfile;
1.1075.2.35  raeburn  11255:     if (($actionurl eq '/adm/portfolio') ||
                   11256:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  11257:         my ($dirlistref,$listerror) =
                   11258:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   11259:         if (ref($dirlistref) eq 'ARRAY') {
                   11260:             foreach my $line (@{$dirlistref}) {
                   11261:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   11262:                 $currfile{$file_name} = 1;
                   11263:             }
1.984     raeburn  11264:         }
1.987     raeburn  11265:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11266:         if (opendir(my $dir,$url)) {
1.987     raeburn  11267:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  11268:             map {$currfile{$_} = 1;} @dir_list;
                   11269:         }
1.1075.2.11  raeburn  11270:     } elsif (($actionurl eq '/adm/dependencies') ||
                   11271:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11272:               ($args->{'context'} eq 'paste')) ||
                   11273:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11274:         if ($env{'request.course.id'} ne '') {
                   11275:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11276:             if ($dir ne '') {
                   11277:                 my ($dirlistref,$listerror) =
                   11278:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   11279:                 if (ref($dirlistref) eq 'ARRAY') {
                   11280:                     foreach my $line (@{$dirlistref}) {
                   11281:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   11282:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   11283:                         unless (($testdir&$dirptr) ||
                   11284:                                 ($file_name =~ /^\.\.?$/)) {
                   11285:                             $currfile{$file_name} = [$size,$mtime];
                   11286:                         }
                   11287:                     }
                   11288:                 }
                   11289:             }
                   11290:         }
1.984     raeburn  11291:     }
                   11292:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  11293:         if (exists($currfile{$file})) {
1.987     raeburn  11294:             unless ($mapping{$file} eq $file) {
                   11295:                 $pathchanges{$file} = 1;
                   11296:             }
                   11297:             $existing{$file} = 1;
                   11298:             $numexisting ++;
                   11299:         } else {
1.984     raeburn  11300:             $newfiles{$file} = 1;
                   11301:         }
                   11302:     }
1.1071    raeburn  11303:     foreach my $file (keys(%currfile)) {
                   11304:         unless (($file eq $filename) ||
                   11305:                 ($file eq $filename.'.bak') ||
                   11306:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  11307:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  11308:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   11309:                     next if (($rem ne '') &&
                   11310:                              (($env{"httpref.$rem".$file} ne '') ||
                   11311:                               (ref($navmap) &&
                   11312:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   11313:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11314:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   11315:                 }
1.1075.2.11  raeburn  11316:             }
1.1071    raeburn  11317:             $unused{$file} = 1;
                   11318:         }
                   11319:     }
1.1075.2.11  raeburn  11320:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   11321:         ($args->{'context'} eq 'paste')) {
                   11322:         $counter = scalar(keys(%existing));
                   11323:         $numpathchg = scalar(keys(%pathchanges));
                   11324:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  11325:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   11326:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   11327:         $counter = scalar(keys(%existing));
                   11328:         $numpathchg = scalar(keys(%pathchanges));
                   11329:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  11330:     }
1.984     raeburn  11331:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  11332:         if ($actionurl eq '/adm/dependencies') {
                   11333:             next if ($embed_file =~ m{^\w+://});
                   11334:         }
1.660     raeburn  11335:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11336:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  11337:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  11338:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  11339:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   11340:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  11341:         }
1.1075.2.35  raeburn  11342:         $upload_output .= '</td>';
1.1071    raeburn  11343:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  11344:             $upload_output.='<td align="right">'.
                   11345:                             '<span class="LC_info LC_fontsize_medium">'.
                   11346:                             &mt("URL points to web address").'</span>';
1.987     raeburn  11347:             $numremref++;
1.660     raeburn  11348:         } elsif ($args->{'error_on_invalid_names'}
                   11349:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  11350:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   11351:                             &mt('Invalid characters').'</span>';
1.987     raeburn  11352:             $numinvalid++;
1.660     raeburn  11353:         } else {
1.1075.2.35  raeburn  11354:             $upload_output .= '<td>'.
                   11355:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  11356:                                                      $embed_file,\%mapping,
1.1071    raeburn  11357:                                                      $allfiles,$codebase,'upload');
                   11358:             $counter ++;
                   11359:             $numnew ++;
1.987     raeburn  11360:         }
                   11361:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   11362:     }
                   11363:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  11364:         if ($actionurl eq '/adm/dependencies') {
                   11365:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   11366:             $modify_output .= &start_data_table_row().
                   11367:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   11368:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   11369:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   11370:                               '<td>'.$size.'</td>'.
                   11371:                               '<td>'.$mtime.'</td>'.
                   11372:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   11373:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   11374:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   11375:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   11376:                               &embedded_file_element('upload_embedded',$counter,
                   11377:                                                      $embed_file,\%mapping,
                   11378:                                                      $allfiles,$codebase,'modify').
                   11379:                               '</div></td>'.
                   11380:                               &end_data_table_row()."\n";
                   11381:             $counter ++;
                   11382:         } else {
                   11383:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11384:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   11385:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   11386:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  11387:                               &Apache::loncommon::end_data_table_row()."\n";
                   11388:         }
                   11389:     }
                   11390:     my $delidx = $counter;
                   11391:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   11392:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   11393:         $delete_output .= &start_data_table_row().
                   11394:                           '<td><img src="'.&icon($oldfile).'" />'.
                   11395:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   11396:                           '<td>'.$size.'</td>'.
                   11397:                           '<td>'.$mtime.'</td>'.
                   11398:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   11399:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   11400:                           &embedded_file_element('upload_embedded',$delidx,
                   11401:                                                  $oldfile,\%mapping,$allfiles,
                   11402:                                                  $codebase,'delete').'</td>'.
                   11403:                           &end_data_table_row()."\n"; 
                   11404:         $numunused ++;
                   11405:         $delidx ++;
1.987     raeburn  11406:     }
                   11407:     if ($upload_output) {
                   11408:         $upload_output = &start_data_table().
                   11409:                          $upload_output.
                   11410:                          &end_data_table()."\n";
                   11411:     }
1.1071    raeburn  11412:     if ($modify_output) {
                   11413:         $modify_output = &start_data_table().
                   11414:                          &start_data_table_header_row().
                   11415:                          '<th>'.&mt('File').'</th>'.
                   11416:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11417:                          '<th>'.&mt('Modified').'</th>'.
                   11418:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   11419:                          &end_data_table_header_row().
                   11420:                          $modify_output.
                   11421:                          &end_data_table()."\n";
                   11422:     }
                   11423:     if ($delete_output) {
                   11424:         $delete_output = &start_data_table().
                   11425:                          &start_data_table_header_row().
                   11426:                          '<th>'.&mt('File').'</th>'.
                   11427:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11428:                          '<th>'.&mt('Modified').'</th>'.
                   11429:                          '<th>'.&mt('Delete?').'</th>'.
                   11430:                          &end_data_table_header_row().
                   11431:                          $delete_output.
                   11432:                          &end_data_table()."\n";
                   11433:     }
1.987     raeburn  11434:     my $applies = 0;
                   11435:     if ($numremref) {
                   11436:         $applies ++;
                   11437:     }
                   11438:     if ($numinvalid) {
                   11439:         $applies ++;
                   11440:     }
                   11441:     if ($numexisting) {
                   11442:         $applies ++;
                   11443:     }
1.1071    raeburn  11444:     if ($counter || $numunused) {
1.987     raeburn  11445:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   11446:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  11447:                   $state.'<h3>'.$heading.'</h3>'; 
                   11448:         if ($actionurl eq '/adm/dependencies') {
                   11449:             if ($numnew) {
                   11450:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   11451:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   11452:                            $upload_output.'<br />'."\n";
                   11453:             }
                   11454:             if ($numexisting) {
                   11455:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   11456:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   11457:                            $modify_output.'<br />'."\n";
                   11458:                            $buttontext = &mt('Save changes');
                   11459:             }
                   11460:             if ($numunused) {
                   11461:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   11462:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   11463:                            $delete_output.'<br />'."\n";
                   11464:                            $buttontext = &mt('Save changes');
                   11465:             }
                   11466:         } else {
                   11467:             $output .= $upload_output.'<br />'."\n";
                   11468:         }
                   11469:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   11470:                    $counter.'" />'."\n";
                   11471:         if ($actionurl eq '/adm/dependencies') { 
                   11472:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   11473:                        $numnew.'" />'."\n";
                   11474:         } elsif ($actionurl eq '') {
1.987     raeburn  11475:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   11476:         }
                   11477:     } elsif ($applies) {
                   11478:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   11479:         if ($applies > 1) {
                   11480:             $output .=  
1.1075.2.35  raeburn  11481:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  11482:             if ($numremref) {
                   11483:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   11484:             }
                   11485:             if ($numinvalid) {
                   11486:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   11487:             }
                   11488:             if ($numexisting) {
                   11489:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   11490:             }
                   11491:             $output .= '</ul><br />';
                   11492:         } elsif ($numremref) {
                   11493:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   11494:         } elsif ($numinvalid) {
                   11495:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   11496:         } elsif ($numexisting) {
                   11497:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   11498:         }
                   11499:         $output .= $upload_output.'<br />';
                   11500:     }
                   11501:     my ($pathchange_output,$chgcount);
1.1071    raeburn  11502:     $chgcount = $counter;
1.987     raeburn  11503:     if (keys(%pathchanges) > 0) {
                   11504:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  11505:             if ($counter) {
1.987     raeburn  11506:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   11507:                                                   $embed_file,\%mapping,
1.1071    raeburn  11508:                                                   $allfiles,$codebase,'change');
1.987     raeburn  11509:             } else {
                   11510:                 $pathchange_output .= 
                   11511:                     &start_data_table_row().
                   11512:                     '<td><input type ="checkbox" name="namechange" value="'.
                   11513:                     $chgcount.'" checked="checked" /></td>'.
                   11514:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11515:                     '<td>'.$embed_file.
                   11516:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11517:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11518:                     '</td>'.&end_data_table_row();
1.660     raeburn  11519:             }
1.987     raeburn  11520:             $numpathchg ++;
                   11521:             $chgcount ++;
1.660     raeburn  11522:         }
                   11523:     }
1.1075.2.35  raeburn  11524:     if (($counter) || ($numunused)) {
1.987     raeburn  11525:         if ($numpathchg) {
                   11526:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11527:                        $numpathchg.'" />'."\n";
                   11528:         }
                   11529:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11530:             ($actionurl eq '/adm/imsimport')) {
                   11531:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11532:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11533:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11534:         } elsif ($actionurl eq '/adm/dependencies') {
                   11535:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11536:         }
1.1075.2.35  raeburn  11537:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11538:     } elsif ($numpathchg) {
                   11539:         my %pathchange = ();
                   11540:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11541:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11542:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  11543:         }
1.987     raeburn  11544:     }
1.1071    raeburn  11545:     return ($output,$counter,$numpathchg);
1.987     raeburn  11546: }
                   11547: 
1.1075.2.47  raeburn  11548: =pod
                   11549: 
                   11550: =item * clean_path($name)
                   11551: 
                   11552: Performs clean-up of directories, subdirectories and filename in an
                   11553: embedded object, referenced in an HTML file which is being uploaded
                   11554: to a course or portfolio, where
                   11555: "Upload embedded images/multimedia files if HTML file" checkbox was
                   11556: checked.
                   11557: 
                   11558: Clean-up is similar to replacements in lonnet::clean_filename()
                   11559: except each / between sub-directory and next level is preserved.
                   11560: 
                   11561: =cut
                   11562: 
                   11563: sub clean_path {
                   11564:     my ($embed_file) = @_;
                   11565:     $embed_file =~s{^/+}{};
                   11566:     my @contents;
                   11567:     if ($embed_file =~ m{/}) {
                   11568:         @contents = split(/\//,$embed_file);
                   11569:     } else {
                   11570:         @contents = ($embed_file);
                   11571:     }
                   11572:     my $lastidx = scalar(@contents)-1;
                   11573:     for (my $i=0; $i<=$lastidx; $i++) {
                   11574:         $contents[$i]=~s{\\}{/}g;
                   11575:         $contents[$i]=~s/\s+/\_/g;
                   11576:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   11577:         if ($i == $lastidx) {
                   11578:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   11579:         }
                   11580:     }
                   11581:     if ($lastidx > 0) {
                   11582:         return join('/',@contents);
                   11583:     } else {
                   11584:         return $contents[0];
                   11585:     }
                   11586: }
                   11587: 
1.987     raeburn  11588: sub embedded_file_element {
1.1071    raeburn  11589:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  11590:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   11591:                    (ref($codebase) eq 'HASH'));
                   11592:     my $output;
1.1071    raeburn  11593:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  11594:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   11595:     }
                   11596:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   11597:                &escape($embed_file).'" />';
                   11598:     unless (($context eq 'upload_embedded') && 
                   11599:             ($mapping->{$embed_file} eq $embed_file)) {
                   11600:         $output .='
                   11601:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   11602:     }
                   11603:     my $attrib;
                   11604:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   11605:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   11606:     }
                   11607:     $output .=
                   11608:         "\n\t\t".
                   11609:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   11610:         $attrib.'" />';
                   11611:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   11612:         $output .=
                   11613:             "\n\t\t".
                   11614:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   11615:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  11616:     }
1.987     raeburn  11617:     return $output;
1.660     raeburn  11618: }
                   11619: 
1.1071    raeburn  11620: sub get_dependency_details {
                   11621:     my ($currfile,$currsubfile,$embed_file) = @_;
                   11622:     my ($size,$mtime,$showsize,$showmtime);
                   11623:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   11624:         if ($embed_file =~ m{/}) {
                   11625:             my ($path,$fname) = split(/\//,$embed_file);
                   11626:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   11627:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   11628:             }
                   11629:         } else {
                   11630:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   11631:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   11632:             }
                   11633:         }
                   11634:         $showsize = $size/1024.0;
                   11635:         $showsize = sprintf("%.1f",$showsize);
                   11636:         if ($mtime > 0) {
                   11637:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   11638:         }
                   11639:     }
                   11640:     return ($showsize,$showmtime);
                   11641: }
                   11642: 
                   11643: sub ask_embedded_js {
                   11644:     return <<"END";
                   11645: <script type="text/javascript"">
                   11646: // <![CDATA[
                   11647: function toggleBrowse(counter) {
                   11648:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   11649:     var fileid = document.getElementById('embedded_item_'+counter);
                   11650:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   11651:     if (chkboxid.checked == true) {
                   11652:         uploaddivid.style.display='block';
                   11653:     } else {
                   11654:         uploaddivid.style.display='none';
                   11655:         fileid.value = '';
                   11656:     }
                   11657: }
                   11658: // ]]>
                   11659: </script>
                   11660: 
                   11661: END
                   11662: }
                   11663: 
1.661     raeburn  11664: sub upload_embedded {
                   11665:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  11666:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   11667:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  11668:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   11669:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   11670:         my $orig_uploaded_filename =
                   11671:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  11672:         foreach my $type ('orig','ref','attrib','codebase') {
                   11673:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   11674:                 $env{'form.embedded_'.$type.'_'.$i} =
                   11675:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   11676:             }
                   11677:         }
1.661     raeburn  11678:         my ($path,$fname) =
                   11679:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   11680:         # no path, whole string is fname
                   11681:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   11682:         $fname = &Apache::lonnet::clean_filename($fname);
                   11683:         # See if there is anything left
                   11684:         next if ($fname eq '');
                   11685: 
                   11686:         # Check if file already exists as a file or directory.
                   11687:         my ($state,$msg);
                   11688:         if ($context eq 'portfolio') {
                   11689:             my $port_path = $dirpath;
                   11690:             if ($group ne '') {
                   11691:                 $port_path = "groups/$group/$port_path";
                   11692:             }
1.987     raeburn  11693:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   11694:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  11695:                                               $dir_root,$port_path,$disk_quota,
                   11696:                                               $current_disk_usage,$uname,$udom);
                   11697:             if ($state eq 'will_exceed_quota'
1.984     raeburn  11698:                 || $state eq 'file_locked') {
1.661     raeburn  11699:                 $output .= $msg;
                   11700:                 next;
                   11701:             }
                   11702:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   11703:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   11704:             if ($state eq 'exists') {
                   11705:                 $output .= $msg;
                   11706:                 next;
                   11707:             }
                   11708:         }
                   11709:         # Check if extension is valid
                   11710:         if (($fname =~ /\.(\w+)$/) &&
                   11711:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  11712:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   11713:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  11714:             next;
                   11715:         } elsif (($fname =~ /\.(\w+)$/) &&
                   11716:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  11717:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  11718:             next;
                   11719:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  11720:             $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  11721:             next;
                   11722:         }
                   11723:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  11724:         my $subdir = $path;
                   11725:         $subdir =~ s{/+$}{};
1.661     raeburn  11726:         if ($context eq 'portfolio') {
1.984     raeburn  11727:             my $result;
                   11728:             if ($state eq 'existingfile') {
                   11729:                 $result=
                   11730:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  11731:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  11732:             } else {
1.984     raeburn  11733:                 $result=
                   11734:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  11735:                                                     $dirpath.
1.1075.2.35  raeburn  11736:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  11737:                 if ($result !~ m|^/uploaded/|) {
                   11738:                     $output .= '<span class="LC_error">'
                   11739:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11740:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11741:                                .'</span><br />';
                   11742:                     next;
                   11743:                 } else {
1.987     raeburn  11744:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11745:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  11746:                 }
1.661     raeburn  11747:             }
1.1075.2.35  raeburn  11748:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   11749:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   11750:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  11751:             my $result =
1.1075.2.35  raeburn  11752:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  11753:             if ($result !~ m|^/uploaded/|) {
                   11754:                 $output .= '<span class="LC_error">'
                   11755:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11756:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11757:                            .'</span><br />';
                   11758:                     next;
                   11759:             } else {
                   11760:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11761:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  11762:                 if ($context eq 'syllabus') {
                   11763:                     &Apache::lonnet::make_public_indefinitely($result);
                   11764:                 }
1.987     raeburn  11765:             }
1.661     raeburn  11766:         } else {
                   11767: # Save the file
                   11768:             my $target = $env{'form.embedded_item_'.$i};
                   11769:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   11770:             my $dest = $fullpath.$fname;
                   11771:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  11772:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  11773:             my $count;
                   11774:             my $filepath = $dir_root;
1.1027    raeburn  11775:             foreach my $subdir (@parts) {
                   11776:                 $filepath .= "/$subdir";
                   11777:                 if (!-e $filepath) {
1.661     raeburn  11778:                     mkdir($filepath,0770);
                   11779:                 }
                   11780:             }
                   11781:             my $fh;
                   11782:             if (!open($fh,'>'.$dest)) {
                   11783:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11784:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11785:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11786:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11787:                            '</span><br />';
                   11788:             } else {
                   11789:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11790:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11791:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11792:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11793:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11794:                               '</span><br />';
                   11795:                 } else {
1.987     raeburn  11796:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11797:                                $url.'</span>').'<br />';
                   11798:                     unless ($context eq 'testbank') {
                   11799:                         $footer .= &mt('View embedded file: [_1]',
                   11800:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11801:                     }
                   11802:                 }
                   11803:                 close($fh);
                   11804:             }
                   11805:         }
                   11806:         if ($env{'form.embedded_ref_'.$i}) {
                   11807:             $pathchange{$i} = 1;
                   11808:         }
                   11809:     }
                   11810:     if ($output) {
                   11811:         $output = '<p>'.$output.'</p>';
                   11812:     }
                   11813:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11814:     $returnflag = 'ok';
1.1071    raeburn  11815:     my $numpathchgs = scalar(keys(%pathchange));
                   11816:     if ($numpathchgs > 0) {
1.987     raeburn  11817:         if ($context eq 'portfolio') {
                   11818:             $output .= '<p>'.&mt('or').'</p>';
                   11819:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11820:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11821:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11822:             $returnflag = 'modify_orightml';
                   11823:         }
                   11824:     }
1.1071    raeburn  11825:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11826: }
                   11827: 
                   11828: sub modify_html_form {
                   11829:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11830:     my $end = 0;
                   11831:     my $modifyform;
                   11832:     if ($context eq 'upload_embedded') {
                   11833:         return unless (ref($pathchange) eq 'HASH');
                   11834:         if ($env{'form.number_embedded_items'}) {
                   11835:             $end += $env{'form.number_embedded_items'};
                   11836:         }
                   11837:         if ($env{'form.number_pathchange_items'}) {
                   11838:             $end += $env{'form.number_pathchange_items'};
                   11839:         }
                   11840:         if ($end) {
                   11841:             for (my $i=0; $i<$end; $i++) {
                   11842:                 if ($i < $env{'form.number_embedded_items'}) {
                   11843:                     next unless($pathchange->{$i});
                   11844:                 }
                   11845:                 $modifyform .=
                   11846:                     &start_data_table_row().
                   11847:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   11848:                     'checked="checked" /></td>'.
                   11849:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   11850:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   11851:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   11852:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   11853:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   11854:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   11855:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   11856:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   11857:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   11858:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   11859:                     &end_data_table_row();
1.1071    raeburn  11860:             }
1.987     raeburn  11861:         }
                   11862:     } else {
                   11863:         $modifyform = $pathchgtable;
                   11864:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   11865:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   11866:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11867:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   11868:         }
                   11869:     }
                   11870:     if ($modifyform) {
1.1071    raeburn  11871:         if ($actionurl eq '/adm/dependencies') {
                   11872:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   11873:         }
1.987     raeburn  11874:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   11875:                '<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".
                   11876:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   11877:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   11878:                '</ol></p>'."\n".'<p>'.
                   11879:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   11880:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   11881:                &start_data_table()."\n".
                   11882:                &start_data_table_header_row().
                   11883:                '<th>'.&mt('Change?').'</th>'.
                   11884:                '<th>'.&mt('Current reference').'</th>'.
                   11885:                '<th>'.&mt('Required reference').'</th>'.
                   11886:                &end_data_table_header_row()."\n".
                   11887:                $modifyform.
                   11888:                &end_data_table().'<br />'."\n".$hiddenstate.
                   11889:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   11890:                '</form>'."\n";
                   11891:     }
                   11892:     return;
                   11893: }
                   11894: 
                   11895: sub modify_html_refs {
1.1075.2.35  raeburn  11896:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  11897:     my $container;
                   11898:     if ($context eq 'portfolio') {
                   11899:         $container = $env{'form.container'};
                   11900:     } elsif ($context eq 'coursedoc') {
                   11901:         $container = $env{'form.primaryurl'};
1.1071    raeburn  11902:     } elsif ($context eq 'manage_dependencies') {
                   11903:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   11904:         $container = "/$container";
1.1075.2.35  raeburn  11905:     } elsif ($context eq 'syllabus') {
                   11906:         $container = $url;
1.987     raeburn  11907:     } else {
1.1027    raeburn  11908:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  11909:     }
                   11910:     my (%allfiles,%codebase,$output,$content);
                   11911:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  11912:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  11913:         if (wantarray) {
                   11914:             return ('',0,0); 
                   11915:         } else {
                   11916:             return;
                   11917:         }
                   11918:     }
                   11919:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11920:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  11921:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   11922:             if (wantarray) {
                   11923:                 return ('',0,0);
                   11924:             } else {
                   11925:                 return;
                   11926:             }
                   11927:         } 
1.987     raeburn  11928:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  11929:         if ($content eq '-1') {
                   11930:             if (wantarray) {
                   11931:                 return ('',0,0);
                   11932:             } else {
                   11933:                 return;
                   11934:             }
                   11935:         }
1.987     raeburn  11936:     } else {
1.1071    raeburn  11937:         unless ($container =~ /^\Q$dir_root\E/) {
                   11938:             if (wantarray) {
                   11939:                 return ('',0,0);
                   11940:             } else {
                   11941:                 return;
                   11942:             }
                   11943:         } 
1.1075.2.128  raeburn  11944:         if (open(my $fh,'<',$container)) {
1.987     raeburn  11945:             $content = join('', <$fh>);
                   11946:             close($fh);
                   11947:         } else {
1.1071    raeburn  11948:             if (wantarray) {
                   11949:                 return ('',0,0);
                   11950:             } else {
                   11951:                 return;
                   11952:             }
1.987     raeburn  11953:         }
                   11954:     }
                   11955:     my ($count,$codebasecount) = (0,0);
                   11956:     my $mm = new File::MMagic;
                   11957:     my $mime_type = $mm->checktype_contents($content);
                   11958:     if ($mime_type eq 'text/html') {
                   11959:         my $parse_result = 
                   11960:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   11961:                                                     \%codebase,\$content);
                   11962:         if ($parse_result eq 'ok') {
                   11963:             foreach my $i (@changes) {
                   11964:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   11965:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   11966:                 if ($allfiles{$ref}) {
                   11967:                     my $newname =  $orig;
                   11968:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  11969:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  11970:                     if ($attrib_regexp =~ /:/) {
                   11971:                         $attrib_regexp =~ s/\:/|/g;
                   11972:                     }
                   11973:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11974:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11975:                         $count += $numchg;
1.1075.2.35  raeburn  11976:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  11977:                         delete($allfiles{$ref});
1.987     raeburn  11978:                     }
                   11979:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  11980:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  11981:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   11982:                         $codebasecount ++;
                   11983:                     }
                   11984:                 }
                   11985:             }
1.1075.2.35  raeburn  11986:             my $skiprewrites;
1.987     raeburn  11987:             if ($count || $codebasecount) {
                   11988:                 my $saveresult;
1.1071    raeburn  11989:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11990:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  11991:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11992:                     if ($url eq $container) {
                   11993:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   11994:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11995:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  11996:                                             $fname.'</span>').'</p>';
1.987     raeburn  11997:                     } else {
                   11998:                          $output = '<p class="LC_error">'.
                   11999:                                    &mt('Error: update failed for: [_1].',
                   12000:                                    '<span class="LC_filename">'.
                   12001:                                    $container.'</span>').'</p>';
                   12002:                     }
1.1075.2.35  raeburn  12003:                     if ($context eq 'syllabus') {
                   12004:                         unless ($saveresult eq 'ok') {
                   12005:                             $skiprewrites = 1;
                   12006:                         }
                   12007:                     }
1.987     raeburn  12008:                 } else {
1.1075.2.128  raeburn  12009:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  12010:                         print $fh $content;
                   12011:                         close($fh);
                   12012:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   12013:                                   $count,'<span class="LC_filename">'.
                   12014:                                   $container.'</span>').'</p>';
1.661     raeburn  12015:                     } else {
1.987     raeburn  12016:                          $output = '<p class="LC_error">'.
                   12017:                                    &mt('Error: could not update [_1].',
                   12018:                                    '<span class="LC_filename">'.
                   12019:                                    $container.'</span>').'</p>';
1.661     raeburn  12020:                     }
                   12021:                 }
                   12022:             }
1.1075.2.35  raeburn  12023:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   12024:                 my ($actionurl,$state);
                   12025:                 $actionurl = "/public/$udom/$uname/syllabus";
                   12026:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   12027:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   12028:                                               \%codebase,
                   12029:                                               {'context' => 'rewrites',
                   12030:                                                'ignore_remote_references' => 1,});
                   12031:                 if (ref($mapping) eq 'HASH') {
                   12032:                     my $rewrites = 0;
                   12033:                     foreach my $key (keys(%{$mapping})) {
                   12034:                         next if ($key =~ m{^https?://});
                   12035:                         my $ref = $mapping->{$key};
                   12036:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   12037:                         my $attrib;
                   12038:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   12039:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   12040:                         }
                   12041:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   12042:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   12043:                             $rewrites += $numchg;
                   12044:                         }
                   12045:                     }
                   12046:                     if ($rewrites) {
                   12047:                         my $saveresult;
                   12048:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   12049:                         if ($url eq $container) {
                   12050:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   12051:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   12052:                                             $count,'<span class="LC_filename">'.
                   12053:                                             $fname.'</span>').'</p>';
                   12054:                         } else {
                   12055:                             $output .= '<p class="LC_error">'.
                   12056:                                        &mt('Error: could not update links in [_1].',
                   12057:                                        '<span class="LC_filename">'.
                   12058:                                        $container.'</span>').'</p>';
                   12059: 
                   12060:                         }
                   12061:                     }
                   12062:                 }
                   12063:             }
1.987     raeburn  12064:         } else {
                   12065:             &logthis('Failed to parse '.$container.
                   12066:                      ' to modify references: '.$parse_result);
1.661     raeburn  12067:         }
                   12068:     }
1.1071    raeburn  12069:     if (wantarray) {
                   12070:         return ($output,$count,$codebasecount);
                   12071:     } else {
                   12072:         return $output;
                   12073:     }
1.661     raeburn  12074: }
                   12075: 
                   12076: sub check_for_existing {
                   12077:     my ($path,$fname,$element) = @_;
                   12078:     my ($state,$msg);
                   12079:     if (-d $path.'/'.$fname) {
                   12080:         $state = 'exists';
                   12081:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12082:     } elsif (-e $path.'/'.$fname) {
                   12083:         $state = 'exists';
                   12084:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12085:     }
                   12086:     if ($state eq 'exists') {
                   12087:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   12088:     }
                   12089:     return ($state,$msg);
                   12090: }
                   12091: 
                   12092: sub check_for_upload {
                   12093:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   12094:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  12095:     my $filesize = length($env{'form.'.$element});
                   12096:     if (!$filesize) {
                   12097:         my $msg = '<span class="LC_error">'.
                   12098:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   12099:                       '<span class="LC_filename">'.$fname.'</span>',
                   12100:                       $filesize).'<br />'.
1.1007    raeburn  12101:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  12102:                   '</span>';
                   12103:         return ('zero_bytes',$msg);
                   12104:     }
                   12105:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  12106:     my $getpropath = 1;
1.1021    raeburn  12107:     my ($dirlistref,$listerror) =
                   12108:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  12109:     my $found_file = 0;
                   12110:     my $locked_file = 0;
1.991     raeburn  12111:     my @lockers;
                   12112:     my $navmap;
                   12113:     if ($env{'request.course.id'}) {
                   12114:         $navmap = Apache::lonnavmaps::navmap->new();
                   12115:     }
1.1021    raeburn  12116:     if (ref($dirlistref) eq 'ARRAY') {
                   12117:         foreach my $line (@{$dirlistref}) {
                   12118:             my ($file_name,$rest)=split(/\&/,$line,2);
                   12119:             if ($file_name eq $fname){
                   12120:                 $file_name = $path.$file_name;
                   12121:                 if ($group ne '') {
                   12122:                     $file_name = $group.$file_name;
                   12123:                 }
                   12124:                 $found_file = 1;
                   12125:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   12126:                     foreach my $lock (@lockers) {
                   12127:                         if (ref($lock) eq 'ARRAY') {
                   12128:                             my ($symb,$crsid) = @{$lock};
                   12129:                             if ($crsid eq $env{'request.course.id'}) {
                   12130:                                 if (ref($navmap)) {
                   12131:                                     my $res = $navmap->getBySymb($symb);
                   12132:                                     foreach my $part (@{$res->parts()}) { 
                   12133:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   12134:                                         unless (($slot_status == $res->RESERVED) ||
                   12135:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   12136:                                             $locked_file = 1;
                   12137:                                         }
1.991     raeburn  12138:                                     }
1.1021    raeburn  12139:                                 } else {
                   12140:                                     $locked_file = 1;
1.991     raeburn  12141:                                 }
                   12142:                             } else {
                   12143:                                 $locked_file = 1;
                   12144:                             }
                   12145:                         }
1.1021    raeburn  12146:                    }
                   12147:                 } else {
                   12148:                     my @info = split(/\&/,$rest);
                   12149:                     my $currsize = $info[6]/1000;
                   12150:                     if ($currsize < $filesize) {
                   12151:                         my $extra = $filesize - $currsize;
                   12152:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  12153:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  12154:                                       &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  12155:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   12156:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   12157:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  12158:                             return ('will_exceed_quota',$msg);
                   12159:                         }
1.984     raeburn  12160:                     }
                   12161:                 }
1.661     raeburn  12162:             }
                   12163:         }
                   12164:     }
                   12165:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  12166:         my $msg = '<p class="LC_warning">'.
                   12167:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   12168:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  12169:         return ('will_exceed_quota',$msg);
                   12170:     } elsif ($found_file) {
                   12171:         if ($locked_file) {
1.1075.2.69  raeburn  12172:             my $msg = '<p class="LC_warning">';
1.661     raeburn  12173:             $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  12174:             $msg .= '</p>';
1.661     raeburn  12175:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   12176:             return ('file_locked',$msg);
                   12177:         } else {
1.1075.2.69  raeburn  12178:             my $msg = '<p class="LC_error">';
1.984     raeburn  12179:             $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  12180:             $msg .= '</p>';
1.984     raeburn  12181:             return ('existingfile',$msg);
1.661     raeburn  12182:         }
                   12183:     }
                   12184: }
                   12185: 
1.987     raeburn  12186: sub check_for_traversal {
                   12187:     my ($path,$url,$toplevel) = @_;
                   12188:     my @parts=split(/\//,$path);
                   12189:     my $cleanpath;
                   12190:     my $fullpath = $url;
                   12191:     for (my $i=0;$i<@parts;$i++) {
                   12192:         next if ($parts[$i] eq '.');
                   12193:         if ($parts[$i] eq '..') {
                   12194:             $fullpath =~ s{([^/]+/)$}{};
                   12195:         } else {
                   12196:             $fullpath .= $parts[$i].'/';
                   12197:         }
                   12198:     }
                   12199:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   12200:         $cleanpath = $1;
                   12201:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   12202:         my $curr_toprel = $1;
                   12203:         my @parts = split(/\//,$curr_toprel);
                   12204:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   12205:         my @urlparts = split(/\//,$url_toprel);
                   12206:         my $doubledots;
                   12207:         my $startdiff = -1;
                   12208:         for (my $i=0; $i<@urlparts; $i++) {
                   12209:             if ($startdiff == -1) {
                   12210:                 unless ($urlparts[$i] eq $parts[$i]) {
                   12211:                     $startdiff = $i;
                   12212:                     $doubledots .= '../';
                   12213:                 }
                   12214:             } else {
                   12215:                 $doubledots .= '../';
                   12216:             }
                   12217:         }
                   12218:         if ($startdiff > -1) {
                   12219:             $cleanpath = $doubledots;
                   12220:             for (my $i=$startdiff; $i<@parts; $i++) {
                   12221:                 $cleanpath .= $parts[$i].'/';
                   12222:             }
                   12223:         }
                   12224:     }
                   12225:     $cleanpath =~ s{(/)$}{};
                   12226:     return $cleanpath;
                   12227: }
1.31      albertel 12228: 
1.1053    raeburn  12229: sub is_archive_file {
                   12230:     my ($mimetype) = @_;
                   12231:     if (($mimetype eq 'application/octet-stream') ||
                   12232:         ($mimetype eq 'application/x-stuffit') ||
                   12233:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   12234:         return 1;
                   12235:     }
                   12236:     return;
                   12237: }
                   12238: 
                   12239: sub decompress_form {
1.1065    raeburn  12240:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  12241:     my %lt = &Apache::lonlocal::texthash (
                   12242:         this => 'This file is an archive file.',
1.1067    raeburn  12243:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  12244:         itsc => 'Its contents are as follows:',
1.1053    raeburn  12245:         youm => 'You may wish to extract its contents.',
                   12246:         extr => 'Extract contents',
1.1067    raeburn  12247:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   12248:         proa => 'Process automatically?',
1.1053    raeburn  12249:         yes  => 'Yes',
                   12250:         no   => 'No',
1.1067    raeburn  12251:         fold => 'Title for folder containing movie',
                   12252:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  12253:     );
1.1065    raeburn  12254:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  12255:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  12256:     my $info = &list_archive_contents($fileloc,\@paths);
                   12257:     if (@paths) {
                   12258:         foreach my $path (@paths) {
                   12259:             $path =~ s{^/}{};
1.1067    raeburn  12260:             if ($path =~ m{^([^/]+)/$}) {
                   12261:                 $topdir = $1;
                   12262:             }
1.1065    raeburn  12263:             if ($path =~ m{^([^/]+)/}) {
                   12264:                 $toplevel{$1} = $path;
                   12265:             } else {
                   12266:                 $toplevel{$path} = $path;
                   12267:             }
                   12268:         }
                   12269:     }
1.1067    raeburn  12270:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  12271:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  12272:                         "$topdir/media/",
                   12273:                         "$topdir/media/$topdir.mp4",
                   12274:                         "$topdir/media/FirstFrame.png",
                   12275:                         "$topdir/media/player.swf",
                   12276:                         "$topdir/media/swfobject.js",
                   12277:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  12278:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  12279:                          "$topdir/$topdir.mp4",
                   12280:                          "$topdir/$topdir\_config.xml",
                   12281:                          "$topdir/$topdir\_controller.swf",
                   12282:                          "$topdir/$topdir\_embed.css",
                   12283:                          "$topdir/$topdir\_First_Frame.png",
                   12284:                          "$topdir/$topdir\_player.html",
                   12285:                          "$topdir/$topdir\_Thumbnails.png",
                   12286:                          "$topdir/playerProductInstall.swf",
                   12287:                          "$topdir/scripts/",
                   12288:                          "$topdir/scripts/config_xml.js",
                   12289:                          "$topdir/scripts/handlebars.js",
                   12290:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   12291:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   12292:                          "$topdir/scripts/modernizr.js",
                   12293:                          "$topdir/scripts/player-min.js",
                   12294:                          "$topdir/scripts/swfobject.js",
                   12295:                          "$topdir/skins/",
                   12296:                          "$topdir/skins/configuration_express.xml",
                   12297:                          "$topdir/skins/express_show/",
                   12298:                          "$topdir/skins/express_show/player-min.css",
                   12299:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  12300:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   12301:                          "$topdir/$topdir.mp4",
                   12302:                          "$topdir/$topdir\_config.xml",
                   12303:                          "$topdir/$topdir\_controller.swf",
                   12304:                          "$topdir/$topdir\_embed.css",
                   12305:                          "$topdir/$topdir\_First_Frame.png",
                   12306:                          "$topdir/$topdir\_player.html",
                   12307:                          "$topdir/$topdir\_Thumbnails.png",
                   12308:                          "$topdir/playerProductInstall.swf",
                   12309:                          "$topdir/scripts/",
                   12310:                          "$topdir/scripts/config_xml.js",
                   12311:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   12312:                          "$topdir/skins/",
                   12313:                          "$topdir/skins/configuration_express.xml",
                   12314:                          "$topdir/skins/express_show/",
                   12315:                          "$topdir/skins/express_show/spritesheet.min.css",
                   12316:                          "$topdir/skins/express_show/spritesheet.png",
                   12317:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  12318:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  12319:         if (@diffs == 0) {
1.1075.2.59  raeburn  12320:             $is_camtasia = 6;
                   12321:         } else {
1.1075.2.81  raeburn  12322:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  12323:             if (@diffs == 0) {
                   12324:                 $is_camtasia = 8;
1.1075.2.81  raeburn  12325:             } else {
                   12326:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   12327:                 if (@diffs == 0) {
                   12328:                     $is_camtasia = 8;
                   12329:                 }
1.1075.2.59  raeburn  12330:             }
1.1067    raeburn  12331:         }
                   12332:     }
                   12333:     my $output;
                   12334:     if ($is_camtasia) {
                   12335:         $output = <<"ENDCAM";
                   12336: <script type="text/javascript" language="Javascript">
                   12337: // <![CDATA[
                   12338: 
                   12339: function camtasiaToggle() {
                   12340:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   12341:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  12342:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  12343:                 document.getElementById('camtasia_titles').style.display='block';
                   12344:             } else {
                   12345:                 document.getElementById('camtasia_titles').style.display='none';
                   12346:             }
                   12347:         }
                   12348:     }
                   12349:     return;
                   12350: }
                   12351: 
                   12352: // ]]>
                   12353: </script>
                   12354: <p>$lt{'camt'}</p>
                   12355: ENDCAM
1.1065    raeburn  12356:     } else {
1.1067    raeburn  12357:         $output = '<p>'.$lt{'this'};
                   12358:         if ($info eq '') {
                   12359:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   12360:         } else {
                   12361:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   12362:                        '<div><pre>'.$info.'</pre></div>';
                   12363:         }
1.1065    raeburn  12364:     }
1.1067    raeburn  12365:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  12366:     my $duplicates;
                   12367:     my $num = 0;
                   12368:     if (ref($dirlist) eq 'ARRAY') {
                   12369:         foreach my $item (@{$dirlist}) {
                   12370:             if (ref($item) eq 'ARRAY') {
                   12371:                 if (exists($toplevel{$item->[0]})) {
                   12372:                     $duplicates .= 
                   12373:                         &start_data_table_row().
                   12374:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12375:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   12376:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12377:                         'value="1" />'.&mt('Yes').'</label>'.
                   12378:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   12379:                         '<td>'.$item->[0].'</td>';
                   12380:                     if ($item->[2]) {
                   12381:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   12382:                     } else {
                   12383:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   12384:                     }
                   12385:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   12386:                                    '<td>'.
                   12387:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   12388:                                    '</td>'.
                   12389:                                    &end_data_table_row();
                   12390:                     $num ++;
                   12391:                 }
                   12392:             }
                   12393:         }
                   12394:     }
                   12395:     my $itemcount;
                   12396:     if (@paths > 0) {
                   12397:         $itemcount = scalar(@paths);
                   12398:     } else {
                   12399:         $itemcount = 1;
                   12400:     }
1.1067    raeburn  12401:     if ($is_camtasia) {
                   12402:         $output .= $lt{'auto'}.'<br />'.
                   12403:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  12404:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  12405:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   12406:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   12407:                    $lt{'no'}.'</label></span><br />'.
                   12408:                    '<div id="camtasia_titles" style="display:block">'.
                   12409:                    &Apache::lonhtmlcommon::start_pick_box().
                   12410:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   12411:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   12412:                    &Apache::lonhtmlcommon::row_closure().
                   12413:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   12414:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   12415:                    &Apache::lonhtmlcommon::row_closure(1).
                   12416:                    &Apache::lonhtmlcommon::end_pick_box().
                   12417:                    '</div>';
                   12418:     }
1.1065    raeburn  12419:     $output .= 
                   12420:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  12421:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   12422:         "\n";
1.1065    raeburn  12423:     if ($duplicates ne '') {
                   12424:         $output .= '<p><span class="LC_warning">'.
                   12425:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   12426:                    &start_data_table().
                   12427:                    &start_data_table_header_row().
                   12428:                    '<th>'.&mt('Overwrite?').'</th>'.
                   12429:                    '<th>'.&mt('Name').'</th>'.
                   12430:                    '<th>'.&mt('Type').'</th>'.
                   12431:                    '<th>'.&mt('Size').'</th>'.
                   12432:                    '<th>'.&mt('Last modified').'</th>'.
                   12433:                    &end_data_table_header_row().
                   12434:                    $duplicates.
                   12435:                    &end_data_table().
                   12436:                    '</p>';
                   12437:     }
1.1067    raeburn  12438:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  12439:     if (ref($hiddenelements) eq 'HASH') {
                   12440:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   12441:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   12442:         }
                   12443:     }
                   12444:     $output .= <<"END";
1.1067    raeburn  12445: <br />
1.1053    raeburn  12446: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   12447: </form>
                   12448: $noextract
                   12449: END
                   12450:     return $output;
                   12451: }
                   12452: 
1.1065    raeburn  12453: sub decompression_utility {
                   12454:     my ($program) = @_;
                   12455:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   12456:     my $location;
                   12457:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   12458:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   12459:                          '/usr/sbin/') {
                   12460:             if (-x $dir.$program) {
                   12461:                 $location = $dir.$program;
                   12462:                 last;
                   12463:             }
                   12464:         }
                   12465:     }
                   12466:     return $location;
                   12467: }
                   12468: 
                   12469: sub list_archive_contents {
                   12470:     my ($file,$pathsref) = @_;
                   12471:     my (@cmd,$output);
                   12472:     my $needsregexp;
                   12473:     if ($file =~ /\.zip$/) {
                   12474:         @cmd = (&decompression_utility('unzip'),"-l");
                   12475:         $needsregexp = 1;
                   12476:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   12477:              ($file =~ /\.tgz$/)) {
                   12478:         @cmd = (&decompression_utility('tar'),"-ztf");
                   12479:     } elsif ($file =~ /\.tar\.bz2$/) {
                   12480:         @cmd = (&decompression_utility('tar'),"-jtf");
                   12481:     } elsif ($file =~ m|\.tar$|) {
                   12482:         @cmd = (&decompression_utility('tar'),"-tf");
                   12483:     }
                   12484:     if (@cmd) {
                   12485:         undef($!);
                   12486:         undef($@);
                   12487:         if (open(my $fh,"-|", @cmd, $file)) {
                   12488:             while (my $line = <$fh>) {
                   12489:                 $output .= $line;
                   12490:                 chomp($line);
                   12491:                 my $item;
                   12492:                 if ($needsregexp) {
                   12493:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   12494:                 } else {
                   12495:                     $item = $line;
                   12496:                 }
                   12497:                 if ($item ne '') {
                   12498:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   12499:                         push(@{$pathsref},$item);
                   12500:                     } 
                   12501:                 }
                   12502:             }
                   12503:             close($fh);
                   12504:         }
                   12505:     }
                   12506:     return $output;
                   12507: }
                   12508: 
1.1053    raeburn  12509: sub decompress_uploaded_file {
                   12510:     my ($file,$dir) = @_;
                   12511:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   12512:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   12513:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   12514:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12515:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12516:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12517:     my $decompressed = $env{'cgi.decompressed'};
                   12518:     &Apache::lonnet::delenv('cgi.file');
                   12519:     &Apache::lonnet::delenv('cgi.dir');
                   12520:     &Apache::lonnet::delenv('cgi.decompressed');
                   12521:     return ($decompressed,$result);
                   12522: }
                   12523: 
1.1055    raeburn  12524: sub process_decompression {
                   12525:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12526:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12527:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12528:                &mt('Unexpected file path.').'</p>'."\n";
                   12529:     }
                   12530:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12531:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12532:                &mt('Unexpected course context.').'</p>'."\n";
                   12533:     }
                   12534:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12535:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12536:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12537:     }
1.1055    raeburn  12538:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12539:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12540:         $error = &mt('Filename not a supported archive file type.').
                   12541:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12542:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   12543:     } else {
                   12544:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12545:         if ($docuhome eq 'no_host') {
                   12546:             $error = &mt('Could not determine home server for course.');
                   12547:         } else {
                   12548:             my @ids=&Apache::lonnet::current_machine_ids();
                   12549:             my $currdir = "$dir_root/$destination";
                   12550:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12551:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   12552:                        "$dir_root/$destination";
                   12553:             } else {
                   12554:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   12555:                        "$dir_root/$docudom/$docuname/$destination";
                   12556:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   12557:                     $error = &mt('Archive file not found.');
                   12558:                 }
                   12559:             }
1.1065    raeburn  12560:             my (@to_overwrite,@to_skip);
                   12561:             if ($env{'form.archive_overwrite_total'} > 0) {
                   12562:                 my $total = $env{'form.archive_overwrite_total'};
                   12563:                 for (my $i=0; $i<$total; $i++) {
                   12564:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   12565:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   12566:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   12567:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   12568:                     }
                   12569:                 }
                   12570:             }
                   12571:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  12572:             my $numoverwrite = scalar(@to_overwrite);
                   12573:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  12574:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   12575:             } elsif ($dir eq '') {
1.1055    raeburn  12576:                 $error = &mt('Directory containing archive file unavailable.');
                   12577:             } elsif (!$error) {
1.1065    raeburn  12578:                 my ($decompressed,$display);
1.1075.2.128  raeburn  12579:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  12580:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   12581:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  12582:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   12583:                         ($decompressed,$display) =
                   12584:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   12585:                         foreach my $item (@to_skip) {
                   12586:                             if (($item ne '') && ($item !~ /\.\./)) {
                   12587:                                 if (-f "$dir/$tempdir/$item") {
                   12588:                                     unlink("$dir/$tempdir/$item");
                   12589:                                 } elsif (-d "$dir/$tempdir/$item") {
                   12590:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   12591:                                 }
                   12592:                             }
                   12593:                         }
                   12594:                         foreach my $item (@to_overwrite) {
                   12595:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   12596:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   12597:                                     if (-f "$dir/$item") {
                   12598:                                         unlink("$dir/$item");
                   12599:                                     } elsif (-d "$dir/$item") {
                   12600:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   12601:                                     }
                   12602:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   12603:                                 }
1.1065    raeburn  12604:                             }
                   12605:                         }
1.1075.2.128  raeburn  12606:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   12607:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   12608:                         }
1.1065    raeburn  12609:                     }
                   12610:                 } else {
                   12611:                     ($decompressed,$display) = 
                   12612:                         &decompress_uploaded_file($file,$dir);
                   12613:                 }
1.1055    raeburn  12614:                 if ($decompressed eq 'ok') {
1.1065    raeburn  12615:                     $output = '<p class="LC_info">'.
                   12616:                               &mt('Files extracted successfully from archive.').
                   12617:                               '</p>'."\n";
1.1055    raeburn  12618:                     my ($warning,$result,@contents);
                   12619:                     my ($newdirlistref,$newlisterror) =
                   12620:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   12621:                                                  $docuname,1);
                   12622:                     my (%is_dir,%changes,@newitems);
                   12623:                     my $dirptr = 16384;
1.1065    raeburn  12624:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  12625:                         foreach my $dir_line (@{$newdirlistref}) {
                   12626:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  12627:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  12628:                                 push(@newitems,$item);
                   12629:                                 if ($dirptr&$testdir) {
                   12630:                                     $is_dir{$item} = 1;
                   12631:                                 }
                   12632:                                 $changes{$item} = 1;
                   12633:                             }
                   12634:                         }
                   12635:                     }
                   12636:                     if (keys(%changes) > 0) {
                   12637:                         foreach my $item (sort(@newitems)) {
                   12638:                             if ($changes{$item}) {
                   12639:                                 push(@contents,$item);
                   12640:                             }
                   12641:                         }
                   12642:                     }
                   12643:                     if (@contents > 0) {
1.1067    raeburn  12644:                         my $wantform;
                   12645:                         unless ($env{'form.autoextract_camtasia'}) {
                   12646:                             $wantform = 1;
                   12647:                         }
1.1056    raeburn  12648:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  12649:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   12650:                                                                 $currdir,\%is_dir,
                   12651:                                                                 \%children,\%parent,
1.1056    raeburn  12652:                                                                 \@contents,\%dirorder,
                   12653:                                                                 \%titles,$wantform);
1.1055    raeburn  12654:                         if ($datatable ne '') {
                   12655:                             $output .= &archive_options_form('decompressed',$datatable,
                   12656:                                                              $count,$hiddenelem);
1.1065    raeburn  12657:                             my $startcount = 6;
1.1055    raeburn  12658:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  12659:                                                            \%titles,\%children);
1.1055    raeburn  12660:                         }
1.1067    raeburn  12661:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  12662:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  12663:                             my %displayed;
                   12664:                             my $total = 1;
                   12665:                             $env{'form.archive_directory'} = [];
                   12666:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   12667:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   12668:                                 $path =~ s{/$}{};
                   12669:                                 my $item;
                   12670:                                 if ($path ne '') {
                   12671:                                     $item = "$path/$titles{$i}";
                   12672:                                 } else {
                   12673:                                     $item = $titles{$i};
                   12674:                                 }
                   12675:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   12676:                                 if ($item eq $contents[0]) {
                   12677:                                     push(@{$env{'form.archive_directory'}},$i);
                   12678:                                     $env{'form.archive_'.$i} = 'display';
                   12679:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   12680:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  12681:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   12682:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  12683:                                     $env{'form.archive_'.$i} = 'display';
                   12684:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   12685:                                     $displayed{'web'} = $i;
                   12686:                                 } else {
1.1075.2.59  raeburn  12687:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   12688:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   12689:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  12690:                                         push(@{$env{'form.archive_directory'}},$i);
                   12691:                                     }
                   12692:                                     $env{'form.archive_'.$i} = 'dependency';
                   12693:                                 }
                   12694:                                 $total ++;
                   12695:                             }
                   12696:                             for (my $i=1; $i<$total; $i++) {
                   12697:                                 next if ($i == $displayed{'web'});
                   12698:                                 next if ($i == $displayed{'folder'});
                   12699:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   12700:                             }
                   12701:                             $env{'form.phase'} = 'decompress_cleanup';
                   12702:                             $env{'form.archivedelete'} = 1;
                   12703:                             $env{'form.archive_count'} = $total-1;
                   12704:                             $output .=
                   12705:                                 &process_extracted_files('coursedocs',$docudom,
                   12706:                                                          $docuname,$destination,
                   12707:                                                          $dir_root,$hiddenelem);
                   12708:                         }
1.1055    raeburn  12709:                     } else {
                   12710:                         $warning = &mt('No new items extracted from archive file.');
                   12711:                     }
                   12712:                 } else {
                   12713:                     $output = $display;
                   12714:                     $error = &mt('An error occurred during extraction from the archive file.');
                   12715:                 }
                   12716:             }
                   12717:         }
                   12718:     }
                   12719:     if ($error) {
                   12720:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12721:                    $error.'</p>'."\n";
                   12722:     }
                   12723:     if ($warning) {
                   12724:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12725:     }
                   12726:     return $output;
                   12727: }
                   12728: 
                   12729: sub get_extracted {
1.1056    raeburn  12730:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   12731:         $titles,$wantform) = @_;
1.1055    raeburn  12732:     my $count = 0;
                   12733:     my $depth = 0;
                   12734:     my $datatable;
1.1056    raeburn  12735:     my @hierarchy;
1.1055    raeburn  12736:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  12737:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   12738:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  12739:     foreach my $item (@{$contents}) {
                   12740:         $count ++;
1.1056    raeburn  12741:         @{$dirorder->{$count}} = @hierarchy;
                   12742:         $titles->{$count} = $item;
1.1055    raeburn  12743:         &archive_hierarchy($depth,$count,$parent,$children);
                   12744:         if ($wantform) {
                   12745:             $datatable .= &archive_row($is_dir->{$item},$item,
                   12746:                                        $currdir,$depth,$count);
                   12747:         }
                   12748:         if ($is_dir->{$item}) {
                   12749:             $depth ++;
1.1056    raeburn  12750:             push(@hierarchy,$count);
                   12751:             $parent->{$depth} = $count;
1.1055    raeburn  12752:             $datatable .=
                   12753:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  12754:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   12755:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  12756:             $depth --;
1.1056    raeburn  12757:             pop(@hierarchy);
1.1055    raeburn  12758:         }
                   12759:     }
                   12760:     return ($count,$datatable);
                   12761: }
                   12762: 
                   12763: sub recurse_extracted_archive {
1.1056    raeburn  12764:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   12765:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  12766:     my $result='';
1.1056    raeburn  12767:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   12768:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   12769:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  12770:         return $result;
                   12771:     }
                   12772:     my $dirptr = 16384;
                   12773:     my ($newdirlistref,$newlisterror) =
                   12774:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   12775:     if (ref($newdirlistref) eq 'ARRAY') {
                   12776:         foreach my $dir_line (@{$newdirlistref}) {
                   12777:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   12778:             unless ($item =~ /^\.+$/) {
                   12779:                 $$count ++;
1.1056    raeburn  12780:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   12781:                 $titles->{$$count} = $item;
1.1055    raeburn  12782:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  12783: 
1.1055    raeburn  12784:                 my $is_dir;
                   12785:                 if ($dirptr&$testdir) {
                   12786:                     $is_dir = 1;
                   12787:                 }
                   12788:                 if ($wantform) {
                   12789:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   12790:                 }
                   12791:                 if ($is_dir) {
                   12792:                     $$depth ++;
1.1056    raeburn  12793:                     push(@{$hierarchy},$$count);
                   12794:                     $parent->{$$depth} = $$count;
1.1055    raeburn  12795:                     $result .=
                   12796:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   12797:                                                    $docuname,$depth,$count,
1.1056    raeburn  12798:                                                    $hierarchy,$dirorder,$children,
                   12799:                                                    $parent,$titles,$wantform);
1.1055    raeburn  12800:                     $$depth --;
1.1056    raeburn  12801:                     pop(@{$hierarchy});
1.1055    raeburn  12802:                 }
                   12803:             }
                   12804:         }
                   12805:     }
                   12806:     return $result;
                   12807: }
                   12808: 
                   12809: sub archive_hierarchy {
                   12810:     my ($depth,$count,$parent,$children) =@_;
                   12811:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12812:         if (exists($parent->{$depth})) {
                   12813:              $children->{$parent->{$depth}} .= $count.':';
                   12814:         }
                   12815:     }
                   12816:     return;
                   12817: }
                   12818: 
                   12819: sub archive_row {
                   12820:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12821:     my ($name) = ($item =~ m{([^/]+)$});
                   12822:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12823:                                        'display'    => 'Add as file',
1.1055    raeburn  12824:                                        'dependency' => 'Include as dependency',
                   12825:                                        'discard'    => 'Discard',
                   12826:                                       );
                   12827:     if ($is_dir) {
1.1059    raeburn  12828:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12829:     }
1.1056    raeburn  12830:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   12831:     my $offset = 0;
1.1055    raeburn  12832:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  12833:         $offset ++;
1.1065    raeburn  12834:         if ($action ne 'display') {
                   12835:             $offset ++;
                   12836:         }  
1.1055    raeburn  12837:         $output .= '<td><span class="LC_nobreak">'.
                   12838:                    '<label><input type="radio" name="archive_'.$count.
                   12839:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   12840:         my $text = $choices{$action};
                   12841:         if ($is_dir) {
                   12842:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   12843:             if ($action eq 'display') {
1.1059    raeburn  12844:                 $text = &mt('Add as folder');
1.1055    raeburn  12845:             }
1.1056    raeburn  12846:         } else {
                   12847:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   12848: 
                   12849:         }
                   12850:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   12851:         if ($action eq 'dependency') {
                   12852:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   12853:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   12854:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   12855:                        '<option value=""></option>'."\n".
                   12856:                        '</select>'."\n".
                   12857:                        '</div>';
1.1059    raeburn  12858:         } elsif ($action eq 'display') {
                   12859:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   12860:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   12861:                        '</div>';
1.1055    raeburn  12862:         }
1.1056    raeburn  12863:         $output .= '</td>';
1.1055    raeburn  12864:     }
                   12865:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   12866:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   12867:     for (my $i=0; $i<$depth; $i++) {
                   12868:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   12869:     }
                   12870:     if ($is_dir) {
                   12871:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   12872:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   12873:     } else {
                   12874:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   12875:     }
                   12876:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   12877:                &end_data_table_row();
                   12878:     return $output;
                   12879: }
                   12880: 
                   12881: sub archive_options_form {
1.1065    raeburn  12882:     my ($form,$display,$count,$hiddenelem) = @_;
                   12883:     my %lt = &Apache::lonlocal::texthash(
                   12884:                perm => 'Permanently remove archive file?',
                   12885:                hows => 'How should each extracted item be incorporated in the course?',
                   12886:                cont => 'Content actions for all',
                   12887:                addf => 'Add as folder/file',
                   12888:                incd => 'Include as dependency for a displayed file',
                   12889:                disc => 'Discard',
                   12890:                no   => 'No',
                   12891:                yes  => 'Yes',
                   12892:                save => 'Save',
                   12893:     );
                   12894:     my $output = <<"END";
                   12895: <form name="$form" method="post" action="">
                   12896: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   12897: <label>
                   12898:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   12899: </label>
                   12900: &nbsp;
                   12901: <label>
                   12902:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   12903: </span>
                   12904: </p>
                   12905: <input type="hidden" name="phase" value="decompress_cleanup" />
                   12906: <br />$lt{'hows'}
                   12907: <div class="LC_columnSection">
                   12908:   <fieldset>
                   12909:     <legend>$lt{'cont'}</legend>
                   12910:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   12911:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   12912:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   12913:   </fieldset>
                   12914: </div>
                   12915: END
                   12916:     return $output.
1.1055    raeburn  12917:            &start_data_table()."\n".
1.1065    raeburn  12918:            $display."\n".
1.1055    raeburn  12919:            &end_data_table()."\n".
                   12920:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   12921:            $hiddenelem.
1.1065    raeburn  12922:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  12923:            '</form>';
                   12924: }
                   12925: 
                   12926: sub archive_javascript {
1.1056    raeburn  12927:     my ($startcount,$numitems,$titles,$children) = @_;
                   12928:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  12929:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  12930:     my $scripttag = <<START;
                   12931: <script type="text/javascript">
                   12932: // <![CDATA[
                   12933: 
                   12934: function checkAll(form,prefix) {
                   12935:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   12936:     for (var i=0; i < form.elements.length; i++) {
                   12937:         var id = form.elements[i].id;
                   12938:         if ((id != '') && (id != undefined)) {
                   12939:             if (idstr.test(id)) {
                   12940:                 if (form.elements[i].type == 'radio') {
                   12941:                     form.elements[i].checked = true;
1.1056    raeburn  12942:                     var nostart = i-$startcount;
1.1059    raeburn  12943:                     var offset = nostart%7;
                   12944:                     var count = (nostart-offset)/7;    
1.1056    raeburn  12945:                     dependencyCheck(form,count,offset);
1.1055    raeburn  12946:                 }
                   12947:             }
                   12948:         }
                   12949:     }
                   12950: }
                   12951: 
                   12952: function propagateCheck(form,count) {
                   12953:     if (count > 0) {
1.1059    raeburn  12954:         var startelement = $startcount + ((count-1) * 7);
                   12955:         for (var j=1; j<6; j++) {
                   12956:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  12957:                 var item = startelement + j; 
                   12958:                 if (form.elements[item].type == 'radio') {
                   12959:                     if (form.elements[item].checked) {
                   12960:                         containerCheck(form,count,j);
                   12961:                         break;
                   12962:                     }
1.1055    raeburn  12963:                 }
                   12964:             }
                   12965:         }
                   12966:     }
                   12967: }
                   12968: 
                   12969: numitems = $numitems
1.1056    raeburn  12970: var titles = new Array(numitems);
                   12971: var parents = new Array(numitems);
1.1055    raeburn  12972: for (var i=0; i<numitems; i++) {
1.1056    raeburn  12973:     parents[i] = new Array;
1.1055    raeburn  12974: }
1.1059    raeburn  12975: var maintitle = '$maintitle';
1.1055    raeburn  12976: 
                   12977: START
                   12978: 
1.1056    raeburn  12979:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   12980:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  12981:         for (my $i=0; $i<@contents; $i ++) {
                   12982:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   12983:         }
                   12984:     }
                   12985: 
1.1056    raeburn  12986:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   12987:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   12988:     }
                   12989: 
1.1055    raeburn  12990:     $scripttag .= <<END;
                   12991: 
                   12992: function containerCheck(form,count,offset) {
                   12993:     if (count > 0) {
1.1056    raeburn  12994:         dependencyCheck(form,count,offset);
1.1059    raeburn  12995:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  12996:         form.elements[item].checked = true;
                   12997:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12998:             if (parents[count].length > 0) {
                   12999:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  13000:                     containerCheck(form,parents[count][j],offset);
                   13001:                 }
                   13002:             }
                   13003:         }
                   13004:     }
                   13005: }
                   13006: 
                   13007: function dependencyCheck(form,count,offset) {
                   13008:     if (count > 0) {
1.1059    raeburn  13009:         var chosen = (offset+$startcount)+7*(count-1);
                   13010:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  13011:         var currtype = form.elements[depitem].type;
                   13012:         if (form.elements[chosen].value == 'dependency') {
                   13013:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   13014:             form.elements[depitem].options.length = 0;
                   13015:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  13016:             for (var i=1; i<=numitems; i++) {
                   13017:                 if (i == count) {
                   13018:                     continue;
                   13019:                 }
1.1059    raeburn  13020:                 var startelement = $startcount + (i-1) * 7;
                   13021:                 for (var j=1; j<6; j++) {
                   13022:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  13023:                         var item = startelement + j;
                   13024:                         if (form.elements[item].type == 'radio') {
                   13025:                             if (form.elements[item].checked) {
                   13026:                                 if (form.elements[item].value == 'display') {
                   13027:                                     var n = form.elements[depitem].options.length;
                   13028:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   13029:                                 }
                   13030:                             }
                   13031:                         }
                   13032:                     }
                   13033:                 }
                   13034:             }
                   13035:         } else {
                   13036:             document.getElementById('arc_depon_'+count).style.display='none';
                   13037:             form.elements[depitem].options.length = 0;
                   13038:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   13039:         }
1.1059    raeburn  13040:         titleCheck(form,count,offset);
1.1056    raeburn  13041:     }
                   13042: }
                   13043: 
                   13044: function propagateSelect(form,count,offset) {
                   13045:     if (count > 0) {
1.1065    raeburn  13046:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  13047:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   13048:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13049:             if (parents[count].length > 0) {
                   13050:                 for (var j=0; j<parents[count].length; j++) {
                   13051:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  13052:                 }
                   13053:             }
                   13054:         }
                   13055:     }
                   13056: }
1.1056    raeburn  13057: 
                   13058: function containerSelect(form,count,offset,picked) {
                   13059:     if (count > 0) {
1.1065    raeburn  13060:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  13061:         if (form.elements[item].type == 'radio') {
                   13062:             if (form.elements[item].value == 'dependency') {
                   13063:                 if (form.elements[item+1].type == 'select-one') {
                   13064:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   13065:                         if (form.elements[item+1].options[i].value == picked) {
                   13066:                             form.elements[item+1].selectedIndex = i;
                   13067:                             break;
                   13068:                         }
                   13069:                     }
                   13070:                 }
                   13071:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13072:                     if (parents[count].length > 0) {
                   13073:                         for (var j=0; j<parents[count].length; j++) {
                   13074:                             containerSelect(form,parents[count][j],offset,picked);
                   13075:                         }
                   13076:                     }
                   13077:                 }
                   13078:             }
                   13079:         }
                   13080:     }
                   13081: }
                   13082: 
1.1059    raeburn  13083: function titleCheck(form,count,offset) {
                   13084:     if (count > 0) {
                   13085:         var chosen = (offset+$startcount)+7*(count-1);
                   13086:         var depitem = $startcount + ((count-1) * 7) + 2;
                   13087:         var currtype = form.elements[depitem].type;
                   13088:         if (form.elements[chosen].value == 'display') {
                   13089:             document.getElementById('arc_title_'+count).style.display='block';
                   13090:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   13091:                 document.getElementById('archive_title_'+count).value=maintitle;
                   13092:             }
                   13093:         } else {
                   13094:             document.getElementById('arc_title_'+count).style.display='none';
                   13095:             if (currtype == 'text') { 
                   13096:                 document.getElementById('archive_title_'+count).value='';
                   13097:             }
                   13098:         }
                   13099:     }
                   13100:     return;
                   13101: }
                   13102: 
1.1055    raeburn  13103: // ]]>
                   13104: </script>
                   13105: END
                   13106:     return $scripttag;
                   13107: }
                   13108: 
                   13109: sub process_extracted_files {
1.1067    raeburn  13110:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  13111:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  13112:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  13113:     my @ids=&Apache::lonnet::current_machine_ids();
                   13114:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  13115:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  13116:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   13117:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   13118:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   13119:         $pathtocheck = "$dir_root/$destination";
                   13120:         $dir = $dir_root;
                   13121:         $ishome = 1;
                   13122:     } else {
                   13123:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   13124:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  13125:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  13126:     }
                   13127:     my $currdir = "$dir_root/$destination";
                   13128:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   13129:     if ($env{'form.folderpath'}) {
                   13130:         my @items = split('&',$env{'form.folderpath'});
                   13131:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  13132:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   13133:             $containers{'0'}='page';
                   13134:         } else {
                   13135:             $containers{'0'}='sequence';
                   13136:         }
1.1055    raeburn  13137:     }
                   13138:     my @archdirs = &get_env_multiple('form.archive_directory');
                   13139:     if ($numitems) {
                   13140:         for (my $i=1; $i<=$numitems; $i++) {
                   13141:             my $path = $env{'form.archive_content_'.$i};
                   13142:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   13143:                 my $item = $1;
                   13144:                 $toplevelitems{$item} = $i;
                   13145:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   13146:                     $is_dir{$item} = 1;
                   13147:                 }
                   13148:             }
                   13149:         }
                   13150:     }
1.1067    raeburn  13151:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  13152:     if (keys(%toplevelitems) > 0) {
                   13153:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  13154:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   13155:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  13156:     }
1.1066    raeburn  13157:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  13158:     if ($numitems) {
                   13159:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  13160:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  13161:             my $path = $env{'form.archive_content_'.$i};
                   13162:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13163:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   13164:                     if ($prefix ne '' && $path ne '') {
                   13165:                         if (-e $prefix.$path) {
1.1066    raeburn  13166:                             if ((@archdirs > 0) && 
                   13167:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   13168:                                 $todeletedir{$prefix.$path} = 1;
                   13169:                             } else {
                   13170:                                 $todelete{$prefix.$path} = 1;
                   13171:                             }
1.1055    raeburn  13172:                         }
                   13173:                     }
                   13174:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  13175:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  13176:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  13177:                     $docstitle = $env{'form.archive_title_'.$i};
                   13178:                     if ($docstitle eq '') {
                   13179:                         $docstitle = $title;
                   13180:                     }
1.1055    raeburn  13181:                     $outer = 0;
1.1056    raeburn  13182:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13183:                         if (@{$dirorder{$i}} > 0) {
                   13184:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  13185:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   13186:                                     $outer = $item;
                   13187:                                     last;
                   13188:                                 }
                   13189:                             }
                   13190:                         }
                   13191:                     }
                   13192:                     my ($errtext,$fatal) = 
                   13193:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   13194:                                                '/'.$folders{$outer}.'.'.
                   13195:                                                $containers{$outer});
                   13196:                     next if ($fatal);
                   13197:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   13198:                         if ($context eq 'coursedocs') {
1.1056    raeburn  13199:                             $mapinner{$i} = time;
1.1055    raeburn  13200:                             $folders{$i} = 'default_'.$mapinner{$i};
                   13201:                             $containers{$i} = 'sequence';
                   13202:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13203:                                       $folders{$i}.'.'.$containers{$i};
                   13204:                             my $newidx = &LONCAPA::map::getresidx();
                   13205:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  13206:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  13207:                             push(@LONCAPA::map::order,$newidx);
                   13208:                             my ($outtext,$errtext) =
                   13209:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13210:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  13211:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  13212:                             $newseqid{$i} = $newidx;
1.1067    raeburn  13213:                             unless ($errtext) {
1.1075.2.128  raeburn  13214:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   13215:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   13216:                                             '</li>'."\n";
1.1067    raeburn  13217:                             }
1.1055    raeburn  13218:                         }
                   13219:                     } else {
                   13220:                         if ($context eq 'coursedocs') {
                   13221:                             my $newidx=&LONCAPA::map::getresidx();
                   13222:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13223:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   13224:                                       $title;
1.1075.2.167  raeburn  13225:                             if (($outer !~ /\D/) &&
                   13226:                                 (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
                   13227:                                 ($newidx !~ /\D/)) {
1.1075.2.128  raeburn  13228:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   13229:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  13230:                                 }
1.1075.2.128  raeburn  13231:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13232:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   13233:                                 }
                   13234:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13235:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   13236:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   13237:                                         unless ($ishome) {
                   13238:                                             my $fetch = "$newdest{$i}/$title";
                   13239:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   13240:                                             $prompttofetch{$fetch} = 1;
                   13241:                                         }
                   13242:                                    }
                   13243:                                 }
                   13244:                                 $LONCAPA::map::resources[$newidx]=
                   13245:                                     $docstitle.':'.$url.':false:normal:res';
                   13246:                                 push(@LONCAPA::map::order, $newidx);
                   13247:                                 my ($outtext,$errtext)=
                   13248:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13249:                                                             $docuname.'/'.$folders{$outer}.
                   13250:                                                             '.'.$containers{$outer},1,1);
                   13251:                                 unless ($errtext) {
                   13252:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   13253:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   13254:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   13255:                                                    '</li>'."\n";
                   13256:                                     }
1.1067    raeburn  13257:                                 }
1.1075.2.128  raeburn  13258:                             } else {
                   13259:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13260:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  13261:                             }
1.1055    raeburn  13262:                         }
                   13263:                     }
1.1075.2.11  raeburn  13264:                 }
                   13265:             } else {
1.1075.2.128  raeburn  13266:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13267:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  13268:             }
                   13269:         }
                   13270:         for (my $i=1; $i<=$numitems; $i++) {
                   13271:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   13272:             my $path = $env{'form.archive_content_'.$i};
                   13273:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13274:                 my ($title) = ($path =~ m{/([^/]+)$});
                   13275:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   13276:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   13277:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13278:                         my ($itemidx,$fullpath,$relpath);
                   13279:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   13280:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  13281:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  13282:                                 if ($dirorder{$i}->[$j] eq $container) {
                   13283:                                     $itemidx = $j;
1.1056    raeburn  13284:                                 }
                   13285:                             }
1.1075.2.11  raeburn  13286:                         }
                   13287:                         if ($itemidx eq '') {
                   13288:                             $itemidx =  0;
                   13289:                         }
                   13290:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   13291:                             if ($mapinner{$referrer{$i}}) {
                   13292:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   13293:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13294:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13295:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13296:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13297:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13298:                                             if (!-e $fullpath) {
                   13299:                                                 mkdir($fullpath,0755);
1.1056    raeburn  13300:                                             }
                   13301:                                         }
1.1075.2.11  raeburn  13302:                                     } else {
                   13303:                                         last;
1.1056    raeburn  13304:                                     }
1.1075.2.11  raeburn  13305:                                 }
                   13306:                             }
                   13307:                         } elsif ($newdest{$referrer{$i}}) {
                   13308:                             $fullpath = $newdest{$referrer{$i}};
                   13309:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13310:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   13311:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   13312:                                     last;
                   13313:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13314:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13315:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13316:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13317:                                         if (!-e $fullpath) {
                   13318:                                             mkdir($fullpath,0755);
1.1056    raeburn  13319:                                         }
                   13320:                                     }
1.1075.2.11  raeburn  13321:                                 } else {
                   13322:                                     last;
1.1056    raeburn  13323:                                 }
1.1075.2.11  raeburn  13324:                             }
                   13325:                         }
                   13326:                         if ($fullpath ne '') {
                   13327:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  13328:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   13329:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   13330:                                 }
1.1075.2.11  raeburn  13331:                             }
                   13332:                             if (-e "$fullpath/$title") {
                   13333:                                 my $showpath;
                   13334:                                 if ($relpath ne '') {
                   13335:                                     $showpath = "$relpath/$title";
                   13336:                                 } else {
                   13337:                                     $showpath = "/$title";
1.1056    raeburn  13338:                                 }
1.1075.2.128  raeburn  13339:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   13340:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   13341:                                            '</li>'."\n";
                   13342:                                 unless ($ishome) {
                   13343:                                     my $fetch = "$fullpath/$title";
                   13344:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   13345:                                     $prompttofetch{$fetch} = 1;
                   13346:                                 }
1.1055    raeburn  13347:                             }
                   13348:                         }
                   13349:                     }
1.1075.2.11  raeburn  13350:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   13351:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  13352:                                     &HTML::Entities::encode($path,'<>&"'),
                   13353:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   13354:                                 '<br />';
1.1055    raeburn  13355:                 }
                   13356:             } else {
1.1075.2.128  raeburn  13357:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13358:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  13359:             }
                   13360:         }
                   13361:         if (keys(%todelete)) {
                   13362:             foreach my $key (keys(%todelete)) {
                   13363:                 unlink($key);
1.1066    raeburn  13364:             }
                   13365:         }
                   13366:         if (keys(%todeletedir)) {
                   13367:             foreach my $key (keys(%todeletedir)) {
                   13368:                 rmdir($key);
                   13369:             }
                   13370:         }
                   13371:         foreach my $dir (sort(keys(%is_dir))) {
                   13372:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   13373:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  13374:             }
                   13375:         }
1.1067    raeburn  13376:         if ($result ne '') {
                   13377:             $output .= '<ul>'."\n".
                   13378:                        $result."\n".
                   13379:                        '</ul>';
                   13380:         }
                   13381:         unless ($ishome) {
                   13382:             my $replicationfail;
                   13383:             foreach my $item (keys(%prompttofetch)) {
                   13384:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   13385:                 unless ($fetchresult eq 'ok') {
                   13386:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   13387:                 }
                   13388:             }
                   13389:             if ($replicationfail) {
                   13390:                 $output .= '<p class="LC_error">'.
                   13391:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   13392:                            $replicationfail.
                   13393:                            '</ul></p>';
                   13394:             }
                   13395:         }
1.1055    raeburn  13396:     } else {
                   13397:         $warning = &mt('No items found in archive.');
                   13398:     }
                   13399:     if ($error) {
                   13400:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13401:                    $error.'</p>'."\n";
                   13402:     }
                   13403:     if ($warning) {
                   13404:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13405:     }
                   13406:     return $output;
                   13407: }
                   13408: 
1.1066    raeburn  13409: sub cleanup_empty_dirs {
                   13410:     my ($path) = @_;
                   13411:     if (($path ne '') && (-d $path)) {
                   13412:         if (opendir(my $dirh,$path)) {
                   13413:             my @dircontents = grep(!/^\./,readdir($dirh));
                   13414:             my $numitems = 0;
                   13415:             foreach my $item (@dircontents) {
                   13416:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  13417:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  13418:                     if (-e "$path/$item") {
                   13419:                         $numitems ++;
                   13420:                     }
                   13421:                 } else {
                   13422:                     $numitems ++;
                   13423:                 }
                   13424:             }
                   13425:             if ($numitems == 0) {
                   13426:                 rmdir($path);
                   13427:             }
                   13428:             closedir($dirh);
                   13429:         }
                   13430:     }
                   13431:     return;
                   13432: }
                   13433: 
1.41      ng       13434: =pod
1.45      matthew  13435: 
1.1075.2.56  raeburn  13436: =item * &get_folder_hierarchy()
1.1068    raeburn  13437: 
                   13438: Provides hierarchy of names of folders/sub-folders containing the current
                   13439: item,
                   13440: 
                   13441: Inputs: 3
                   13442:      - $navmap - navmaps object
                   13443: 
                   13444:      - $map - url for map (either the trigger itself, or map containing
                   13445:                            the resource, which is the trigger).
                   13446: 
                   13447:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   13448: 
                   13449: Outputs: 1 @pathitems - array of folder/subfolder names.
                   13450: 
                   13451: =cut
                   13452: 
                   13453: sub get_folder_hierarchy {
                   13454:     my ($navmap,$map,$showitem) = @_;
                   13455:     my @pathitems;
                   13456:     if (ref($navmap)) {
                   13457:         my $mapres = $navmap->getResourceByUrl($map);
                   13458:         if (ref($mapres)) {
                   13459:             my $pcslist = $mapres->map_hierarchy();
                   13460:             if ($pcslist ne '') {
                   13461:                 my @pcs = split(/,/,$pcslist);
                   13462:                 foreach my $pc (@pcs) {
                   13463:                     if ($pc == 1) {
1.1075.2.38  raeburn  13464:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  13465:                     } else {
                   13466:                         my $res = $navmap->getByMapPc($pc);
                   13467:                         if (ref($res)) {
                   13468:                             my $title = $res->compTitle();
                   13469:                             $title =~ s/\W+/_/g;
                   13470:                             if ($title ne '') {
                   13471:                                 push(@pathitems,$title);
                   13472:                             }
                   13473:                         }
                   13474:                     }
                   13475:                 }
                   13476:             }
1.1071    raeburn  13477:             if ($showitem) {
                   13478:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  13479:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  13480:                 } else {
                   13481:                     my $maptitle = $mapres->compTitle();
                   13482:                     $maptitle =~ s/\W+/_/g;
                   13483:                     if ($maptitle ne '') {
                   13484:                         push(@pathitems,$maptitle);
                   13485:                     }
1.1068    raeburn  13486:                 }
                   13487:             }
                   13488:         }
                   13489:     }
                   13490:     return @pathitems;
                   13491: }
                   13492: 
                   13493: =pod
                   13494: 
1.1015    raeburn  13495: =item * &get_turnedin_filepath()
                   13496: 
                   13497: Determines path in a user's portfolio file for storage of files uploaded
                   13498: to a specific essayresponse or dropbox item.
                   13499: 
                   13500: Inputs: 3 required + 1 optional.
                   13501: $symb is symb for resource, $uname and $udom are for current user (required).
                   13502: $caller is optional (can be "submission", if routine is called when storing
                   13503: an upoaded file when "Submit Answer" button was pressed).
                   13504: 
                   13505: Returns array containing $path and $multiresp. 
                   13506: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   13507: than one file upload item.  Callers of routine should append partid as a 
                   13508: subdirectory to $path in cases where $multiresp is 1.
                   13509: 
                   13510: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   13511: 
                   13512: =cut
                   13513: 
                   13514: sub get_turnedin_filepath {
                   13515:     my ($symb,$uname,$udom,$caller) = @_;
                   13516:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13517:     my $turnindir;
                   13518:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13519:     $turnindir = $userhash{'turnindir'};
                   13520:     my ($path,$multiresp);
                   13521:     if ($turnindir eq '') {
                   13522:         if ($caller eq 'submission') {
                   13523:             $turnindir = &mt('turned in');
                   13524:             $turnindir =~ s/\W+/_/g;
                   13525:             my %newhash = (
                   13526:                             'turnindir' => $turnindir,
                   13527:                           );
                   13528:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13529:         }
                   13530:     }
                   13531:     if ($turnindir ne '') {
                   13532:         $path = '/'.$turnindir.'/';
                   13533:         my ($multipart,$turnin,@pathitems);
                   13534:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13535:         if (defined($navmap)) {
                   13536:             my $mapres = $navmap->getResourceByUrl($map);
                   13537:             if (ref($mapres)) {
                   13538:                 my $pcslist = $mapres->map_hierarchy();
                   13539:                 if ($pcslist ne '') {
                   13540:                     foreach my $pc (split(/,/,$pcslist)) {
                   13541:                         my $res = $navmap->getByMapPc($pc);
                   13542:                         if (ref($res)) {
                   13543:                             my $title = $res->compTitle();
                   13544:                             $title =~ s/\W+/_/g;
                   13545:                             if ($title ne '') {
1.1075.2.48  raeburn  13546:                                 if (($pc > 1) && (length($title) > 12)) {
                   13547:                                     $title = substr($title,0,12);
                   13548:                                 }
1.1015    raeburn  13549:                                 push(@pathitems,$title);
                   13550:                             }
                   13551:                         }
                   13552:                     }
                   13553:                 }
                   13554:                 my $maptitle = $mapres->compTitle();
                   13555:                 $maptitle =~ s/\W+/_/g;
                   13556:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  13557:                     if (length($maptitle) > 12) {
                   13558:                         $maptitle = substr($maptitle,0,12);
                   13559:                     }
1.1015    raeburn  13560:                     push(@pathitems,$maptitle);
                   13561:                 }
                   13562:                 unless ($env{'request.state'} eq 'construct') {
                   13563:                     my $res = $navmap->getBySymb($symb);
                   13564:                     if (ref($res)) {
                   13565:                         my $partlist = $res->parts();
                   13566:                         my $totaluploads = 0;
                   13567:                         if (ref($partlist) eq 'ARRAY') {
                   13568:                             foreach my $part (@{$partlist}) {
                   13569:                                 my @types = $res->responseType($part);
                   13570:                                 my @ids = $res->responseIds($part);
                   13571:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   13572:                                     if ($types[$i] eq 'essay') {
                   13573:                                         my $partid = $part.'_'.$ids[$i];
                   13574:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   13575:                                             $totaluploads ++;
                   13576:                                         }
                   13577:                                     }
                   13578:                                 }
                   13579:                             }
                   13580:                             if ($totaluploads > 1) {
                   13581:                                 $multiresp = 1;
                   13582:                             }
                   13583:                         }
                   13584:                     }
                   13585:                 }
                   13586:             } else {
                   13587:                 return;
                   13588:             }
                   13589:         } else {
                   13590:             return;
                   13591:         }
                   13592:         my $restitle=&Apache::lonnet::gettitle($symb);
                   13593:         $restitle =~ s/\W+/_/g;
                   13594:         if ($restitle eq '') {
                   13595:             $restitle = ($resurl =~ m{/[^/]+$});
                   13596:             if ($restitle eq '') {
                   13597:                 $restitle = time;
                   13598:             }
                   13599:         }
1.1075.2.48  raeburn  13600:         if (length($restitle) > 12) {
                   13601:             $restitle = substr($restitle,0,12);
                   13602:         }
1.1015    raeburn  13603:         push(@pathitems,$restitle);
                   13604:         $path .= join('/',@pathitems);
                   13605:     }
                   13606:     return ($path,$multiresp);
                   13607: }
                   13608: 
                   13609: =pod
                   13610: 
1.464     albertel 13611: =back
1.41      ng       13612: 
1.112     bowersj2 13613: =head1 CSV Upload/Handling functions
1.38      albertel 13614: 
1.41      ng       13615: =over 4
                   13616: 
1.648     raeburn  13617: =item * &upfile_store($r)
1.41      ng       13618: 
                   13619: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 13620: needs $env{'form.upfile'}
1.41      ng       13621: returns $datatoken to be put into hidden field
                   13622: 
                   13623: =cut
1.31      albertel 13624: 
                   13625: sub upfile_store {
                   13626:     my $r=shift;
1.258     albertel 13627:     $env{'form.upfile'}=~s/\r/\n/gs;
                   13628:     $env{'form.upfile'}=~s/\f/\n/gs;
                   13629:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   13630:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 13631: 
1.1075.2.128  raeburn  13632:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   13633:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   13634:                                      time.'_'.$$);
                   13635:     return if ($datatoken eq '');
                   13636: 
1.31      albertel 13637:     {
1.158     raeburn  13638:         my $datafile = $r->dir_config('lonDaemons').
                   13639:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  13640:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 13641:             print $fh $env{'form.upfile'};
1.158     raeburn  13642:             close($fh);
                   13643:         }
1.31      albertel 13644:     }
                   13645:     return $datatoken;
                   13646: }
                   13647: 
1.56      matthew  13648: =pod
                   13649: 
1.1075.2.128  raeburn  13650: =item * &load_tmp_file($r,$datatoken)
1.41      ng       13651: 
                   13652: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  13653: $datatoken is the name to assign to the temporary file.
1.258     albertel 13654: sets $env{'form.upfile'} to the contents of the file
1.41      ng       13655: 
                   13656: =cut
1.31      albertel 13657: 
                   13658: sub load_tmp_file {
1.1075.2.128  raeburn  13659:     my ($r,$datatoken) = @_;
                   13660:     return if ($datatoken eq '');
1.31      albertel 13661:     my @studentdata=();
                   13662:     {
1.158     raeburn  13663:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  13664:                               '/tmp/'.$datatoken.'.tmp';
                   13665:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  13666:             @studentdata=<$fh>;
                   13667:             close($fh);
                   13668:         }
1.31      albertel 13669:     }
1.258     albertel 13670:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 13671: }
                   13672: 
1.1075.2.128  raeburn  13673: sub valid_datatoken {
                   13674:     my ($datatoken) = @_;
1.1075.2.131  raeburn  13675:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128  raeburn  13676:         return $datatoken;
                   13677:     }
                   13678:     return;
                   13679: }
                   13680: 
1.56      matthew  13681: =pod
                   13682: 
1.648     raeburn  13683: =item * &upfile_record_sep()
1.41      ng       13684: 
                   13685: Separate uploaded file into records
                   13686: returns array of records,
1.258     albertel 13687: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       13688: 
                   13689: =cut
1.31      albertel 13690: 
                   13691: sub upfile_record_sep {
1.258     albertel 13692:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 13693:     } else {
1.248     albertel 13694: 	my @records;
1.258     albertel 13695: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 13696: 	    if ($line=~/^\s*$/) { next; }
                   13697: 	    push(@records,$line);
                   13698: 	}
                   13699: 	return @records;
1.31      albertel 13700:     }
                   13701: }
                   13702: 
1.56      matthew  13703: =pod
                   13704: 
1.648     raeburn  13705: =item * &record_sep($record)
1.41      ng       13706: 
1.258     albertel 13707: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       13708: 
                   13709: =cut
                   13710: 
1.263     www      13711: sub takeleft {
                   13712:     my $index=shift;
                   13713:     return substr('0000'.$index,-4,4);
                   13714: }
                   13715: 
1.31      albertel 13716: sub record_sep {
                   13717:     my $record=shift;
                   13718:     my %components=();
1.258     albertel 13719:     if ($env{'form.upfiletype'} eq 'xml') {
                   13720:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 13721:         my $i=0;
1.356     albertel 13722:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 13723:             $field=~s/^(\"|\')//;
                   13724:             $field=~s/(\"|\')$//;
1.263     www      13725:             $components{&takeleft($i)}=$field;
1.31      albertel 13726:             $i++;
                   13727:         }
1.258     albertel 13728:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 13729:         my $i=0;
1.356     albertel 13730:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 13731:             $field=~s/^(\"|\')//;
                   13732:             $field=~s/(\"|\')$//;
1.263     www      13733:             $components{&takeleft($i)}=$field;
1.31      albertel 13734:             $i++;
                   13735:         }
                   13736:     } else {
1.561     www      13737:         my $separator=',';
1.480     banghart 13738:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      13739:             $separator=';';
1.480     banghart 13740:         }
1.31      albertel 13741:         my $i=0;
1.561     www      13742: # the character we are looking for to indicate the end of a quote or a record 
                   13743:         my $looking_for=$separator;
                   13744: # do not add the characters to the fields
                   13745:         my $ignore=0;
                   13746: # we just encountered a separator (or the beginning of the record)
                   13747:         my $just_found_separator=1;
                   13748: # store the field we are working on here
                   13749:         my $field='';
                   13750: # work our way through all characters in record
                   13751:         foreach my $character ($record=~/(.)/g) {
                   13752:             if ($character eq $looking_for) {
                   13753:                if ($character ne $separator) {
                   13754: # Found the end of a quote, again looking for separator
                   13755:                   $looking_for=$separator;
                   13756:                   $ignore=1;
                   13757:                } else {
                   13758: # Found a separator, store away what we got
                   13759:                   $components{&takeleft($i)}=$field;
                   13760: 	          $i++;
                   13761:                   $just_found_separator=1;
                   13762:                   $ignore=0;
                   13763:                   $field='';
                   13764:                }
                   13765:                next;
                   13766:             }
                   13767: # single or double quotation marks after a separator indicate beginning of a quote
                   13768: # we are now looking for the end of the quote and need to ignore separators
                   13769:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   13770:                $looking_for=$character;
                   13771:                next;
                   13772:             }
                   13773: # ignore would be true after we reached the end of a quote
                   13774:             if ($ignore) { next; }
                   13775:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   13776:             $field.=$character;
                   13777:             $just_found_separator=0; 
1.31      albertel 13778:         }
1.561     www      13779: # catch the very last entry, since we never encountered the separator
                   13780:         $components{&takeleft($i)}=$field;
1.31      albertel 13781:     }
                   13782:     return %components;
                   13783: }
                   13784: 
1.144     matthew  13785: ######################################################
                   13786: ######################################################
                   13787: 
1.56      matthew  13788: =pod
                   13789: 
1.648     raeburn  13790: =item * &upfile_select_html()
1.41      ng       13791: 
1.144     matthew  13792: Return HTML code to select a file from the users machine and specify 
                   13793: the file type.
1.41      ng       13794: 
                   13795: =cut
                   13796: 
1.144     matthew  13797: ######################################################
                   13798: ######################################################
1.31      albertel 13799: sub upfile_select_html {
1.144     matthew  13800:     my %Types = (
                   13801:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 13802:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  13803:                  space => &mt('Space separated'),
                   13804:                  tab   => &mt('Tabulator separated'),
                   13805: #                 xml   => &mt('HTML/XML'),
                   13806:                  );
                   13807:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  13808:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  13809:     foreach my $type (sort(keys(%Types))) {
                   13810:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   13811:     }
                   13812:     $Str .= "</select>\n";
                   13813:     return $Str;
1.31      albertel 13814: }
                   13815: 
1.301     albertel 13816: sub get_samples {
                   13817:     my ($records,$toget) = @_;
                   13818:     my @samples=({});
                   13819:     my $got=0;
                   13820:     foreach my $rec (@$records) {
                   13821: 	my %temp = &record_sep($rec);
                   13822: 	if (! grep(/\S/, values(%temp))) { next; }
                   13823: 	if (%temp) {
                   13824: 	    $samples[$got]=\%temp;
                   13825: 	    $got++;
                   13826: 	    if ($got == $toget) { last; }
                   13827: 	}
                   13828:     }
                   13829:     return \@samples;
                   13830: }
                   13831: 
1.144     matthew  13832: ######################################################
                   13833: ######################################################
                   13834: 
1.56      matthew  13835: =pod
                   13836: 
1.648     raeburn  13837: =item * &csv_print_samples($r,$records)
1.41      ng       13838: 
                   13839: Prints a table of sample values from each column uploaded $r is an
                   13840: Apache Request ref, $records is an arrayref from
                   13841: &Apache::loncommon::upfile_record_sep
                   13842: 
                   13843: =cut
                   13844: 
1.144     matthew  13845: ######################################################
                   13846: ######################################################
1.31      albertel 13847: sub csv_print_samples {
                   13848:     my ($r,$records) = @_;
1.662     bisitz   13849:     my $samples = &get_samples($records,5);
1.301     albertel 13850: 
1.594     raeburn  13851:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   13852:               &start_data_table_header_row());
1.356     albertel 13853:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   13854:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  13855:     $r->print(&end_data_table_header_row());
1.301     albertel 13856:     foreach my $hash (@$samples) {
1.594     raeburn  13857: 	$r->print(&start_data_table_row());
1.356     albertel 13858: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 13859: 	    $r->print('<td>');
1.356     albertel 13860: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 13861: 	    $r->print('</td>');
                   13862: 	}
1.594     raeburn  13863: 	$r->print(&end_data_table_row());
1.31      albertel 13864:     }
1.594     raeburn  13865:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 13866: }
                   13867: 
1.144     matthew  13868: ######################################################
                   13869: ######################################################
                   13870: 
1.56      matthew  13871: =pod
                   13872: 
1.648     raeburn  13873: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       13874: 
                   13875: Prints a table to create associations between values and table columns.
1.144     matthew  13876: 
1.41      ng       13877: $r is an Apache Request ref,
                   13878: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  13879: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       13880: 
                   13881: =cut
                   13882: 
1.144     matthew  13883: ######################################################
                   13884: ######################################################
1.31      albertel 13885: sub csv_print_select_table {
                   13886:     my ($r,$records,$d) = @_;
1.301     albertel 13887:     my $i=0;
                   13888:     my $samples = &get_samples($records,1);
1.144     matthew  13889:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  13890: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  13891:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  13892:               '<th>'.&mt('Column').'</th>'.
                   13893:               &end_data_table_header_row()."\n");
1.356     albertel 13894:     foreach my $array_ref (@$d) {
                   13895: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  13896: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 13897: 
1.875     bisitz   13898: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  13899: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 13900: 	$r->print('<option value="none"></option>');
1.356     albertel 13901: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   13902: 	    $r->print('<option value="'.$sample.'"'.
                   13903:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   13904:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 13905: 	}
1.594     raeburn  13906: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 13907: 	$i++;
                   13908:     }
1.594     raeburn  13909:     $r->print(&end_data_table());
1.31      albertel 13910:     $i--;
                   13911:     return $i;
                   13912: }
1.56      matthew  13913: 
1.144     matthew  13914: ######################################################
                   13915: ######################################################
                   13916: 
1.56      matthew  13917: =pod
1.31      albertel 13918: 
1.648     raeburn  13919: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       13920: 
                   13921: Prints a table of sample values from the upload and can make associate samples to internal names.
                   13922: 
                   13923: $r is an Apache Request ref,
                   13924: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   13925: $d is an array of 2 element arrays (internal name, displayed name)
                   13926: 
                   13927: =cut
                   13928: 
1.144     matthew  13929: ######################################################
                   13930: ######################################################
1.31      albertel 13931: sub csv_samples_select_table {
                   13932:     my ($r,$records,$d) = @_;
                   13933:     my $i=0;
1.144     matthew  13934:     #
1.662     bisitz   13935:     my $max_samples = 5;
                   13936:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  13937:     $r->print(&start_data_table().
                   13938:               &start_data_table_header_row().'<th>'.
                   13939:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   13940:               &end_data_table_header_row());
1.301     albertel 13941: 
                   13942:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  13943: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  13944: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 13945: 	foreach my $option (@$d) {
                   13946: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  13947: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 13948:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  13949:                       $display.'</option>');
1.31      albertel 13950: 	}
                   13951: 	$r->print('</select></td><td>');
1.662     bisitz   13952: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 13953: 	    if (defined($samples->[$line]{$key})) { 
                   13954: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   13955: 	    }
                   13956: 	}
1.594     raeburn  13957: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 13958: 	$i++;
                   13959:     }
1.594     raeburn  13960:     $r->print(&end_data_table());
1.31      albertel 13961:     $i--;
                   13962:     return($i);
1.115     matthew  13963: }
                   13964: 
1.144     matthew  13965: ######################################################
                   13966: ######################################################
                   13967: 
1.115     matthew  13968: =pod
                   13969: 
1.648     raeburn  13970: =item * &clean_excel_name($name)
1.115     matthew  13971: 
                   13972: Returns a replacement for $name which does not contain any illegal characters.
                   13973: 
                   13974: =cut
                   13975: 
1.144     matthew  13976: ######################################################
                   13977: ######################################################
1.115     matthew  13978: sub clean_excel_name {
                   13979:     my ($name) = @_;
                   13980:     $name =~ s/[:\*\?\/\\]//g;
                   13981:     if (length($name) > 31) {
                   13982:         $name = substr($name,0,31);
                   13983:     }
                   13984:     return $name;
1.25      albertel 13985: }
1.84      albertel 13986: 
1.85      albertel 13987: =pod
                   13988: 
1.648     raeburn  13989: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 13990: 
                   13991: Returns either 1 or undef
                   13992: 
                   13993: 1 if the part is to be hidden, undef if it is to be shown
                   13994: 
                   13995: Arguments are:
                   13996: 
                   13997: $id the id of the part to be checked
                   13998: $symb, optional the symb of the resource to check
                   13999: $udom, optional the domain of the user to check for
                   14000: $uname, optional the username of the user to check for
                   14001: 
                   14002: =cut
1.84      albertel 14003: 
                   14004: sub check_if_partid_hidden {
                   14005:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 14006:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 14007: 					 $symb,$udom,$uname);
1.141     albertel 14008:     my $truth=1;
                   14009:     #if the string starts with !, then the list is the list to show not hide
                   14010:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 14011:     my @hiddenlist=split(/,/,$hiddenparts);
                   14012:     foreach my $checkid (@hiddenlist) {
1.141     albertel 14013: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 14014:     }
1.141     albertel 14015:     return !$truth;
1.84      albertel 14016: }
1.127     matthew  14017: 
1.138     matthew  14018: 
                   14019: ############################################################
                   14020: ############################################################
                   14021: 
                   14022: =pod
                   14023: 
1.157     matthew  14024: =back 
                   14025: 
1.138     matthew  14026: =head1 cgi-bin script and graphing routines
                   14027: 
1.157     matthew  14028: =over 4
                   14029: 
1.648     raeburn  14030: =item * &get_cgi_id()
1.138     matthew  14031: 
                   14032: Inputs: none
                   14033: 
                   14034: Returns an id which can be used to pass environment variables
                   14035: to various cgi-bin scripts.  These environment variables will
                   14036: be removed from the users environment after a given time by
                   14037: the routine &Apache::lonnet::transfer_profile_to_env.
                   14038: 
                   14039: =cut
                   14040: 
                   14041: ############################################################
                   14042: ############################################################
1.152     albertel 14043: my $uniq=0;
1.136     matthew  14044: sub get_cgi_id {
1.154     albertel 14045:     $uniq=($uniq+1)%100000;
1.280     albertel 14046:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  14047: }
                   14048: 
1.127     matthew  14049: ############################################################
                   14050: ############################################################
                   14051: 
                   14052: =pod
                   14053: 
1.648     raeburn  14054: =item * &DrawBarGraph()
1.127     matthew  14055: 
1.138     matthew  14056: Facilitates the plotting of data in a (stacked) bar graph.
                   14057: Puts plot definition data into the users environment in order for 
                   14058: graph.png to plot it.  Returns an <img> tag for the plot.
                   14059: The bars on the plot are labeled '1','2',...,'n'.
                   14060: 
                   14061: Inputs:
                   14062: 
                   14063: =over 4
                   14064: 
                   14065: =item $Title: string, the title of the plot
                   14066: 
                   14067: =item $xlabel: string, text describing the X-axis of the plot
                   14068: 
                   14069: =item $ylabel: string, text describing the Y-axis of the plot
                   14070: 
                   14071: =item $Max: scalar, the maximum Y value to use in the plot
                   14072: If $Max is < any data point, the graph will not be rendered.
                   14073: 
1.140     matthew  14074: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  14075: they are plotted.  If undefined, default values will be used.
                   14076: 
1.178     matthew  14077: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   14078: 
1.138     matthew  14079: =item @Values: An array of array references.  Each array reference holds data
                   14080: to be plotted in a stacked bar chart.
                   14081: 
1.239     matthew  14082: =item If the final element of @Values is a hash reference the key/value
                   14083: pairs will be added to the graph definition.
                   14084: 
1.138     matthew  14085: =back
                   14086: 
                   14087: Returns:
                   14088: 
                   14089: An <img> tag which references graph.png and the appropriate identifying
                   14090: information for the plot.
                   14091: 
1.127     matthew  14092: =cut
                   14093: 
                   14094: ############################################################
                   14095: ############################################################
1.134     matthew  14096: sub DrawBarGraph {
1.178     matthew  14097:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  14098:     #
                   14099:     if (! defined($colors)) {
                   14100:         $colors = ['#33ff00', 
                   14101:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   14102:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   14103:                   ]; 
                   14104:     }
1.228     matthew  14105:     my $extra_settings = {};
                   14106:     if (ref($Values[-1]) eq 'HASH') {
                   14107:         $extra_settings = pop(@Values);
                   14108:     }
1.127     matthew  14109:     #
1.136     matthew  14110:     my $identifier = &get_cgi_id();
                   14111:     my $id = 'cgi.'.$identifier;        
1.129     matthew  14112:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  14113:         return '';
                   14114:     }
1.225     matthew  14115:     #
                   14116:     my @Labels;
                   14117:     if (defined($labels)) {
                   14118:         @Labels = @$labels;
                   14119:     } else {
                   14120:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  14121:             push(@Labels,$i+1);
1.225     matthew  14122:         }
                   14123:     }
                   14124:     #
1.129     matthew  14125:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  14126:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  14127:     my %ValuesHash;
                   14128:     my $NumSets=1;
                   14129:     foreach my $array (@Values) {
                   14130:         next if (! ref($array));
1.136     matthew  14131:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  14132:             join(',',@$array);
1.129     matthew  14133:     }
1.127     matthew  14134:     #
1.136     matthew  14135:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  14136:     if ($NumBars < 3) {
                   14137:         $width = 120+$NumBars*32;
1.220     matthew  14138:         $xskip = 1;
1.225     matthew  14139:         $bar_width = 30;
                   14140:     } elsif ($NumBars < 5) {
                   14141:         $width = 120+$NumBars*20;
                   14142:         $xskip = 1;
                   14143:         $bar_width = 20;
1.220     matthew  14144:     } elsif ($NumBars < 10) {
1.136     matthew  14145:         $width = 120+$NumBars*15;
                   14146:         $xskip = 1;
                   14147:         $bar_width = 15;
                   14148:     } elsif ($NumBars <= 25) {
                   14149:         $width = 120+$NumBars*11;
                   14150:         $xskip = 5;
                   14151:         $bar_width = 8;
                   14152:     } elsif ($NumBars <= 50) {
                   14153:         $width = 120+$NumBars*8;
                   14154:         $xskip = 5;
                   14155:         $bar_width = 4;
                   14156:     } else {
                   14157:         $width = 120+$NumBars*8;
                   14158:         $xskip = 5;
                   14159:         $bar_width = 4;
                   14160:     }
                   14161:     #
1.137     matthew  14162:     $Max = 1 if ($Max < 1);
                   14163:     if ( int($Max) < $Max ) {
                   14164:         $Max++;
                   14165:         $Max = int($Max);
                   14166:     }
1.127     matthew  14167:     $Title  = '' if (! defined($Title));
                   14168:     $xlabel = '' if (! defined($xlabel));
                   14169:     $ylabel = '' if (! defined($ylabel));
1.369     www      14170:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   14171:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   14172:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  14173:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  14174:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   14175:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   14176:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   14177:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14178:     $ValuesHash{$id.'.height'}   = $height;
                   14179:     $ValuesHash{$id.'.width'}    = $width;
                   14180:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   14181:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   14182:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  14183:     #
1.228     matthew  14184:     # Deal with other parameters
                   14185:     while (my ($key,$value) = each(%$extra_settings)) {
                   14186:         $ValuesHash{$id.'.'.$key} = $value;
                   14187:     }
                   14188:     #
1.646     raeburn  14189:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  14190:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14191: }
                   14192: 
                   14193: ############################################################
                   14194: ############################################################
                   14195: 
                   14196: =pod
                   14197: 
1.648     raeburn  14198: =item * &DrawXYGraph()
1.137     matthew  14199: 
1.138     matthew  14200: Facilitates the plotting of data in an XY graph.
                   14201: Puts plot definition data into the users environment in order for 
                   14202: graph.png to plot it.  Returns an <img> tag for the plot.
                   14203: 
                   14204: Inputs:
                   14205: 
                   14206: =over 4
                   14207: 
                   14208: =item $Title: string, the title of the plot
                   14209: 
                   14210: =item $xlabel: string, text describing the X-axis of the plot
                   14211: 
                   14212: =item $ylabel: string, text describing the Y-axis of the plot
                   14213: 
                   14214: =item $Max: scalar, the maximum Y value to use in the plot
                   14215: If $Max is < any data point, the graph will not be rendered.
                   14216: 
                   14217: =item $colors: Array ref containing the hex color codes for the data to be 
                   14218: plotted in.  If undefined, default values will be used.
                   14219: 
                   14220: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14221: 
                   14222: =item $Ydata: Array ref containing Array refs.  
1.185     www      14223: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  14224: 
                   14225: =item %Values: hash indicating or overriding any default values which are 
                   14226: passed to graph.png.  
                   14227: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14228: 
                   14229: =back
                   14230: 
                   14231: Returns:
                   14232: 
                   14233: An <img> tag which references graph.png and the appropriate identifying
                   14234: information for the plot.
                   14235: 
1.137     matthew  14236: =cut
                   14237: 
                   14238: ############################################################
                   14239: ############################################################
                   14240: sub DrawXYGraph {
                   14241:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   14242:     #
                   14243:     # Create the identifier for the graph
                   14244:     my $identifier = &get_cgi_id();
                   14245:     my $id = 'cgi.'.$identifier;
                   14246:     #
                   14247:     $Title  = '' if (! defined($Title));
                   14248:     $xlabel = '' if (! defined($xlabel));
                   14249:     $ylabel = '' if (! defined($ylabel));
                   14250:     my %ValuesHash = 
                   14251:         (
1.369     www      14252:          $id.'.title'  => &escape($Title),
                   14253:          $id.'.xlabel' => &escape($xlabel),
                   14254:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  14255:          $id.'.y_max_value'=> $Max,
                   14256:          $id.'.labels'     => join(',',@$Xlabels),
                   14257:          $id.'.PlotType'   => 'XY',
                   14258:          );
                   14259:     #
                   14260:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14261:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14262:     }
                   14263:     #
                   14264:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   14265:         return '';
                   14266:     }
                   14267:     my $NumSets=1;
1.138     matthew  14268:     foreach my $array (@{$Ydata}){
1.137     matthew  14269:         next if (! ref($array));
                   14270:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   14271:     }
1.138     matthew  14272:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  14273:     #
                   14274:     # Deal with other parameters
                   14275:     while (my ($key,$value) = each(%Values)) {
                   14276:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  14277:     }
                   14278:     #
1.646     raeburn  14279:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  14280:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14281: }
                   14282: 
                   14283: ############################################################
                   14284: ############################################################
                   14285: 
                   14286: =pod
                   14287: 
1.648     raeburn  14288: =item * &DrawXYYGraph()
1.138     matthew  14289: 
                   14290: Facilitates the plotting of data in an XY graph with two Y axes.
                   14291: Puts plot definition data into the users environment in order for 
                   14292: graph.png to plot it.  Returns an <img> tag for the plot.
                   14293: 
                   14294: Inputs:
                   14295: 
                   14296: =over 4
                   14297: 
                   14298: =item $Title: string, the title of the plot
                   14299: 
                   14300: =item $xlabel: string, text describing the X-axis of the plot
                   14301: 
                   14302: =item $ylabel: string, text describing the Y-axis of the plot
                   14303: 
                   14304: =item $colors: Array ref containing the hex color codes for the data to be 
                   14305: plotted in.  If undefined, default values will be used.
                   14306: 
                   14307: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14308: 
                   14309: =item $Ydata1: The first data set
                   14310: 
                   14311: =item $Min1: The minimum value of the left Y-axis
                   14312: 
                   14313: =item $Max1: The maximum value of the left Y-axis
                   14314: 
                   14315: =item $Ydata2: The second data set
                   14316: 
                   14317: =item $Min2: The minimum value of the right Y-axis
                   14318: 
                   14319: =item $Max2: The maximum value of the left Y-axis
                   14320: 
                   14321: =item %Values: hash indicating or overriding any default values which are 
                   14322: passed to graph.png.  
                   14323: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14324: 
                   14325: =back
                   14326: 
                   14327: Returns:
                   14328: 
                   14329: An <img> tag which references graph.png and the appropriate identifying
                   14330: information for the plot.
1.136     matthew  14331: 
                   14332: =cut
                   14333: 
                   14334: ############################################################
                   14335: ############################################################
1.137     matthew  14336: sub DrawXYYGraph {
                   14337:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   14338:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  14339:     #
                   14340:     # Create the identifier for the graph
                   14341:     my $identifier = &get_cgi_id();
                   14342:     my $id = 'cgi.'.$identifier;
                   14343:     #
                   14344:     $Title  = '' if (! defined($Title));
                   14345:     $xlabel = '' if (! defined($xlabel));
                   14346:     $ylabel = '' if (! defined($ylabel));
                   14347:     my %ValuesHash = 
                   14348:         (
1.369     www      14349:          $id.'.title'  => &escape($Title),
                   14350:          $id.'.xlabel' => &escape($xlabel),
                   14351:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  14352:          $id.'.labels' => join(',',@$Xlabels),
                   14353:          $id.'.PlotType' => 'XY',
                   14354:          $id.'.NumSets' => 2,
1.137     matthew  14355:          $id.'.two_axes' => 1,
                   14356:          $id.'.y1_max_value' => $Max1,
                   14357:          $id.'.y1_min_value' => $Min1,
                   14358:          $id.'.y2_max_value' => $Max2,
                   14359:          $id.'.y2_min_value' => $Min2,
1.136     matthew  14360:          );
                   14361:     #
1.137     matthew  14362:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14363:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14364:     }
                   14365:     #
                   14366:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   14367:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  14368:         return '';
                   14369:     }
                   14370:     my $NumSets=1;
1.137     matthew  14371:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  14372:         next if (! ref($array));
                   14373:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  14374:     }
                   14375:     #
                   14376:     # Deal with other parameters
                   14377:     while (my ($key,$value) = each(%Values)) {
                   14378:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  14379:     }
                   14380:     #
1.646     raeburn  14381:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 14382:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  14383: }
                   14384: 
                   14385: ############################################################
                   14386: ############################################################
                   14387: 
                   14388: =pod
                   14389: 
1.157     matthew  14390: =back 
                   14391: 
1.139     matthew  14392: =head1 Statistics helper routines?  
                   14393: 
                   14394: Bad place for them but what the hell.
                   14395: 
1.157     matthew  14396: =over 4
                   14397: 
1.648     raeburn  14398: =item * &chartlink()
1.139     matthew  14399: 
                   14400: Returns a link to the chart for a specific student.  
                   14401: 
                   14402: Inputs:
                   14403: 
                   14404: =over 4
                   14405: 
                   14406: =item $linktext: The text of the link
                   14407: 
                   14408: =item $sname: The students username
                   14409: 
                   14410: =item $sdomain: The students domain
                   14411: 
                   14412: =back
                   14413: 
1.157     matthew  14414: =back
                   14415: 
1.139     matthew  14416: =cut
                   14417: 
                   14418: ############################################################
                   14419: ############################################################
                   14420: sub chartlink {
                   14421:     my ($linktext, $sname, $sdomain) = @_;
                   14422:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      14423:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 14424:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  14425:        '">'.$linktext.'</a>';
1.153     matthew  14426: }
                   14427: 
                   14428: #######################################################
                   14429: #######################################################
                   14430: 
                   14431: =pod
                   14432: 
                   14433: =head1 Course Environment Routines
1.157     matthew  14434: 
                   14435: =over 4
1.153     matthew  14436: 
1.648     raeburn  14437: =item * &restore_course_settings()
1.153     matthew  14438: 
1.648     raeburn  14439: =item * &store_course_settings()
1.153     matthew  14440: 
                   14441: Restores/Store indicated form parameters from the course environment.
                   14442: Will not overwrite existing values of the form parameters.
                   14443: 
                   14444: Inputs: 
                   14445: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   14446: 
                   14447: a hash ref describing the data to be stored.  For example:
                   14448:    
                   14449: %Save_Parameters = ('Status' => 'scalar',
                   14450:     'chartoutputmode' => 'scalar',
                   14451:     'chartoutputdata' => 'scalar',
                   14452:     'Section' => 'array',
1.373     raeburn  14453:     'Group' => 'array',
1.153     matthew  14454:     'StudentData' => 'array',
                   14455:     'Maps' => 'array');
                   14456: 
                   14457: Returns: both routines return nothing
                   14458: 
1.631     raeburn  14459: =back
                   14460: 
1.153     matthew  14461: =cut
                   14462: 
                   14463: #######################################################
                   14464: #######################################################
                   14465: sub store_course_settings {
1.496     albertel 14466:     return &store_settings($env{'request.course.id'},@_);
                   14467: }
                   14468: 
                   14469: sub store_settings {
1.153     matthew  14470:     # save to the environment
                   14471:     # appenv the same items, just to be safe
1.300     albertel 14472:     my $udom  = $env{'user.domain'};
                   14473:     my $uname = $env{'user.name'};
1.496     albertel 14474:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14475:     my %SaveHash;
                   14476:     my %AppHash;
                   14477:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 14478:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 14479:         my $envname = 'environment.'.$basename;
1.258     albertel 14480:         if (exists($env{'form.'.$setting})) {
1.153     matthew  14481:             # Save this value away
                   14482:             if ($type eq 'scalar' &&
1.258     albertel 14483:                 (! exists($env{$envname}) || 
                   14484:                  $env{$envname} ne $env{'form.'.$setting})) {
                   14485:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   14486:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  14487:             } elsif ($type eq 'array') {
                   14488:                 my $stored_form;
1.258     albertel 14489:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  14490:                     $stored_form = join(',',
                   14491:                                         map {
1.369     www      14492:                                             &escape($_);
1.258     albertel 14493:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  14494:                 } else {
                   14495:                     $stored_form = 
1.369     www      14496:                         &escape($env{'form.'.$setting});
1.153     matthew  14497:                 }
                   14498:                 # Determine if the array contents are the same.
1.258     albertel 14499:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  14500:                     $SaveHash{$basename} = $stored_form;
                   14501:                     $AppHash{$envname}   = $stored_form;
                   14502:                 }
                   14503:             }
                   14504:         }
                   14505:     }
                   14506:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 14507:                                           $udom,$uname);
1.153     matthew  14508:     if ($put_result !~ /^(ok|delayed)/) {
                   14509:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   14510:                                  'got error:'.$put_result);
                   14511:     }
                   14512:     # Make sure these settings stick around in this session, too
1.646     raeburn  14513:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  14514:     return;
                   14515: }
                   14516: 
                   14517: sub restore_course_settings {
1.499     albertel 14518:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14519: }
                   14520: 
                   14521: sub restore_settings {
                   14522:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14523:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14524:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14525:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14526:             '.'.$setting;
1.258     albertel 14527:         if (exists($env{$envname})) {
1.153     matthew  14528:             if ($type eq 'scalar') {
1.258     albertel 14529:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14530:             } elsif ($type eq 'array') {
1.258     albertel 14531:                 $env{'form.'.$setting} = [ 
1.153     matthew  14532:                                            map { 
1.369     www      14533:                                                &unescape($_); 
1.258     albertel 14534:                                            } split(',',$env{$envname})
1.153     matthew  14535:                                            ];
                   14536:             }
                   14537:         }
                   14538:     }
1.127     matthew  14539: }
                   14540: 
1.618     raeburn  14541: #######################################################
                   14542: #######################################################
                   14543: 
                   14544: =pod
                   14545: 
                   14546: =head1 Domain E-mail Routines  
                   14547: 
                   14548: =over 4
                   14549: 
1.648     raeburn  14550: =item * &build_recipient_list()
1.618     raeburn  14551: 
1.1075.2.44  raeburn  14552: Build recipient lists for following types of e-mail:
1.766     raeburn  14553: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  14554: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   14555: module change checking, student/employee ID conflict checks, as
                   14556: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   14557: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  14558: 
                   14559: Inputs:
1.1075.2.44  raeburn  14560: defmail (scalar - email address of default recipient),
                   14561: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   14562: requestsmail, updatesmail, or idconflictsmail).
                   14563: 
1.619     raeburn  14564: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  14565: 
                   14566: origmail (scalar - email address of recipient from loncapa.conf,
                   14567: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  14568: 
1.1075.2.139  raeburn  14569: $requname username of requester (if mailing type is helpdeskmail)
                   14570: 
                   14571: $requdom domain of requester (if mailing type is helpdeskmail)
                   14572: 
                   14573: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   14574: 
1.655     raeburn  14575: Returns: comma separated list of addresses to which to send e-mail.
                   14576: 
                   14577: =back
1.618     raeburn  14578: 
                   14579: =cut
                   14580: 
                   14581: ############################################################
                   14582: ############################################################
                   14583: sub build_recipient_list {
1.1075.2.139  raeburn  14584:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  14585:     my @recipients;
1.1075.2.122  raeburn  14586:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  14587:     my %domconfig =
1.1075.2.122  raeburn  14588:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  14589:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  14590:         if (exists($domconfig{'contacts'}{$mailing})) {
                   14591:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   14592:                 my @contacts = ('adminemail','supportemail');
                   14593:                 foreach my $item (@contacts) {
                   14594:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   14595:                         my $addr = $domconfig{'contacts'}{$item}; 
                   14596:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14597:                             push(@recipients,$addr);
                   14598:                         }
1.619     raeburn  14599:                     }
1.1075.2.122  raeburn  14600:                 }
                   14601:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   14602:                 if ($mailing eq 'helpdeskmail') {
                   14603:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   14604:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   14605:                         my @ok_bccs;
                   14606:                         foreach my $bcc (@bccs) {
                   14607:                             $bcc =~ s/^\s+//g;
                   14608:                             $bcc =~ s/\s+$//g;
                   14609:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14610:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14611:                                     push(@ok_bccs,$bcc);
                   14612:                                 }
                   14613:                             }
                   14614:                         }
                   14615:                         if (@ok_bccs > 0) {
                   14616:                             $allbcc = join(', ',@ok_bccs);
                   14617:                         }
                   14618:                     }
                   14619:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  14620:                 }
                   14621:             }
1.766     raeburn  14622:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14623:             $lastresort = $origmail;
1.618     raeburn  14624:         }
1.1075.2.139  raeburn  14625:         if ($mailing eq 'helpdeskmail') {
                   14626:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   14627:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   14628:                 my ($inststatus,$inststatus_checked);
                   14629:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   14630:                     ($env{'user.domain'} ne 'public')) {
                   14631:                     $inststatus_checked = 1;
                   14632:                     $inststatus = $env{'environment.inststatus'};
                   14633:                 }
                   14634:                 unless ($inststatus_checked) {
                   14635:                     if (($requname ne '') && ($requdom ne '')) {
                   14636:                         if (($requname =~ /^$match_username$/) &&
                   14637:                             ($requdom =~ /^$match_domain$/) &&
                   14638:                             (&Apache::lonnet::domain($requdom))) {
                   14639:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   14640:                                                                       $requdom);
                   14641:                             unless ($requhome eq 'no_host') {
                   14642:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   14643:                                 $inststatus = $userenv{'inststatus'};
                   14644:                                 $inststatus_checked = 1;
                   14645:                             }
                   14646:                         }
                   14647:                     }
                   14648:                 }
                   14649:                 unless ($inststatus_checked) {
                   14650:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   14651:                         my %srch = (srchby     => 'email',
                   14652:                                     srchdomain => $defdom,
                   14653:                                     srchterm   => $reqemail,
                   14654:                                     srchtype   => 'exact');
                   14655:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   14656:                         foreach my $uname (keys(%srch_results)) {
                   14657:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14658:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14659:                                 $inststatus_checked = 1;
                   14660:                                 last;
                   14661:                             }
                   14662:                         }
                   14663:                         unless ($inststatus_checked) {
                   14664:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   14665:                             if ($dirsrchres eq 'ok') {
                   14666:                                 foreach my $uname (keys(%srch_results)) {
                   14667:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14668:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14669:                                         $inststatus_checked = 1;
                   14670:                                         last;
                   14671:                                     }
                   14672:                                 }
                   14673:                             }
                   14674:                         }
                   14675:                     }
                   14676:                 }
                   14677:                 if ($inststatus ne '') {
                   14678:                     foreach my $status (split(/\:/,$inststatus)) {
                   14679:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   14680:                             my @contacts = ('adminemail','supportemail');
                   14681:                             foreach my $item (@contacts) {
                   14682:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   14683:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   14684:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14685:                                         push(@recipients,$addr);
                   14686:                                     }
                   14687:                                 }
                   14688:                             }
                   14689:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   14690:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   14691:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   14692:                                 my @ok_bccs;
                   14693:                                 foreach my $bcc (@bccs) {
                   14694:                                     $bcc =~ s/^\s+//g;
                   14695:                                     $bcc =~ s/\s+$//g;
                   14696:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14697:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14698:                                             push(@ok_bccs,$bcc);
                   14699:                                         }
                   14700:                                     }
                   14701:                                 }
                   14702:                                 if (@ok_bccs > 0) {
                   14703:                                     $allbcc = join(', ',@ok_bccs);
                   14704:                                 }
                   14705:                             }
                   14706:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   14707:                             last;
                   14708:                         }
                   14709:                     }
                   14710:                 }
                   14711:             }
                   14712:         }
1.619     raeburn  14713:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14714:         $lastresort = $origmail;
                   14715:     }
1.1075.2.128  raeburn  14716:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  14717:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   14718:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   14719:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   14720:             my %what = (
                   14721:                           perlvar => 1,
                   14722:                        );
                   14723:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   14724:             if ($primary) {
                   14725:                 my $gotaddr;
                   14726:                 my ($result,$returnhash) =
                   14727:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   14728:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   14729:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   14730:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   14731:                         $gotaddr = 1;
                   14732:                     }
                   14733:                 }
                   14734:                 unless ($gotaddr) {
                   14735:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   14736:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   14737:                     unless ($uintdom eq $intdom) {
                   14738:                         my %domconfig =
                   14739:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   14740:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   14741:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   14742:                                 my @contacts = ('adminemail','supportemail');
                   14743:                                 foreach my $item (@contacts) {
                   14744:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   14745:                                         my $addr = $domconfig{'contacts'}{$item};
                   14746:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14747:                                             push(@recipients,$addr);
                   14748:                                         }
                   14749:                                     }
                   14750:                                 }
                   14751:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   14752:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   14753:                                 }
                   14754:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   14755:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   14756:                                     my @ok_bccs;
                   14757:                                     foreach my $bcc (@bccs) {
                   14758:                                         $bcc =~ s/^\s+//g;
                   14759:                                         $bcc =~ s/\s+$//g;
                   14760:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14761:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14762:                                                 push(@ok_bccs,$bcc);
                   14763:                                             }
                   14764:                                         }
                   14765:                                     }
                   14766:                                     if (@ok_bccs > 0) {
                   14767:                                         $allbcc = join(', ',@ok_bccs);
                   14768:                                     }
                   14769:                                 }
                   14770:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   14771:                             }
                   14772:                         }
                   14773:                     }
                   14774:                 }
                   14775:             }
                   14776:         }
1.618     raeburn  14777:     }
1.688     raeburn  14778:     if (defined($defmail)) {
                   14779:         if ($defmail ne '') {
                   14780:             push(@recipients,$defmail);
                   14781:         }
1.618     raeburn  14782:     }
                   14783:     if ($otheremails) {
1.619     raeburn  14784:         my @others;
                   14785:         if ($otheremails =~ /,/) {
                   14786:             @others = split(/,/,$otheremails);
1.618     raeburn  14787:         } else {
1.619     raeburn  14788:             push(@others,$otheremails);
                   14789:         }
                   14790:         foreach my $addr (@others) {
                   14791:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14792:                 push(@recipients,$addr);
                   14793:             }
1.618     raeburn  14794:         }
                   14795:     }
1.1075.2.128  raeburn  14796:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  14797:         if ((!@recipients) && ($lastresort ne '')) {
                   14798:             push(@recipients,$lastresort);
                   14799:         }
                   14800:     } elsif ($lastresort ne '') {
                   14801:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   14802:             push(@recipients,$lastresort);
                   14803:         }
                   14804:     }
                   14805:     my $recipientlist = join(',',@recipients);
                   14806:     if (wantarray) {
                   14807:         return ($recipientlist,$allbcc,$addtext);
                   14808:     } else {
                   14809:         return $recipientlist;
                   14810:     }
1.618     raeburn  14811: }
                   14812: 
1.127     matthew  14813: ############################################################
                   14814: ############################################################
1.154     albertel 14815: 
1.655     raeburn  14816: =pod
                   14817: 
                   14818: =head1 Course Catalog Routines
                   14819: 
                   14820: =over 4
                   14821: 
                   14822: =item * &gather_categories()
                   14823: 
                   14824: Converts category definitions - keys of categories hash stored in  
                   14825: coursecategories in configuration.db on the primary library server in a 
                   14826: domain - to an array.  Also generates javascript and idx hash used to 
                   14827: generate Domain Coordinator interface for editing Course Categories.
                   14828: 
                   14829: Inputs:
1.663     raeburn  14830: 
1.655     raeburn  14831: categories (reference to hash of category definitions).
1.663     raeburn  14832: 
1.655     raeburn  14833: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14834:       categories and subcategories).
1.663     raeburn  14835: 
1.655     raeburn  14836: idx (reference to hash of counters used in Domain Coordinator interface for 
                   14837:       editing Course Categories).
1.663     raeburn  14838: 
1.655     raeburn  14839: jsarray (reference to array of categories used to create Javascript arrays for
                   14840:          Domain Coordinator interface for editing Course Categories).
                   14841: 
                   14842: Returns: nothing
                   14843: 
                   14844: Side effects: populates cats, idx and jsarray. 
                   14845: 
                   14846: =cut
                   14847: 
                   14848: sub gather_categories {
                   14849:     my ($categories,$cats,$idx,$jsarray) = @_;
                   14850:     my %counters;
                   14851:     my $num = 0;
                   14852:     foreach my $item (keys(%{$categories})) {
                   14853:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   14854:         if ($container eq '' && $depth == 0) {
                   14855:             $cats->[$depth][$categories->{$item}] = $cat;
                   14856:         } else {
                   14857:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   14858:         }
                   14859:         my ($escitem,$tail) = split(/:/,$item,2);
                   14860:         if ($counters{$tail} eq '') {
                   14861:             $counters{$tail} = $num;
                   14862:             $num ++;
                   14863:         }
                   14864:         if (ref($idx) eq 'HASH') {
                   14865:             $idx->{$item} = $counters{$tail};
                   14866:         }
                   14867:         if (ref($jsarray) eq 'ARRAY') {
                   14868:             push(@{$jsarray->[$counters{$tail}]},$item);
                   14869:         }
                   14870:     }
                   14871:     return;
                   14872: }
                   14873: 
                   14874: =pod
                   14875: 
                   14876: =item * &extract_categories()
                   14877: 
                   14878: Used to generate breadcrumb trails for course categories.
                   14879: 
                   14880: Inputs:
1.663     raeburn  14881: 
1.655     raeburn  14882: categories (reference to hash of category definitions).
1.663     raeburn  14883: 
1.655     raeburn  14884: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14885:       categories and subcategories).
1.663     raeburn  14886: 
1.655     raeburn  14887: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  14888: 
1.655     raeburn  14889: allitems (reference to hash - key is category key 
                   14890:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14891: 
1.655     raeburn  14892: idx (reference to hash of counters used in Domain Coordinator interface for
                   14893:       editing Course Categories).
1.663     raeburn  14894: 
1.655     raeburn  14895: jsarray (reference to array of categories used to create Javascript arrays for
                   14896:          Domain Coordinator interface for editing Course Categories).
                   14897: 
1.665     raeburn  14898: subcats (reference to hash of arrays containing all subcategories within each 
                   14899:          category, -recursive)
                   14900: 
1.1075.2.132  raeburn  14901: maxd (reference to hash used to hold max depth for all top-level categories).
                   14902: 
1.655     raeburn  14903: Returns: nothing
                   14904: 
                   14905: Side effects: populates trails and allitems hash references.
                   14906: 
                   14907: =cut
                   14908: 
                   14909: sub extract_categories {
1.1075.2.132  raeburn  14910:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  14911:     if (ref($categories) eq 'HASH') {
                   14912:         &gather_categories($categories,$cats,$idx,$jsarray);
                   14913:         if (ref($cats->[0]) eq 'ARRAY') {
                   14914:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   14915:                 my $name = $cats->[0][$i];
                   14916:                 my $item = &escape($name).'::0';
                   14917:                 my $trailstr;
                   14918:                 if ($name eq 'instcode') {
                   14919:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  14920:                 } elsif ($name eq 'communities') {
                   14921:                     $trailstr = &mt('Communities');
1.655     raeburn  14922:                 } else {
                   14923:                     $trailstr = $name;
                   14924:                 }
                   14925:                 if ($allitems->{$item} eq '') {
                   14926:                     push(@{$trails},$trailstr);
                   14927:                     $allitems->{$item} = scalar(@{$trails})-1;
                   14928:                 }
                   14929:                 my @parents = ($name);
                   14930:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   14931:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   14932:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  14933:                         if (ref($subcats) eq 'HASH') {
                   14934:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   14935:                         }
1.1075.2.132  raeburn  14936:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  14937:                     }
                   14938:                 } else {
                   14939:                     if (ref($subcats) eq 'HASH') {
                   14940:                         $subcats->{$item} = [];
1.655     raeburn  14941:                     }
1.1075.2.132  raeburn  14942:                     if (ref($maxd) eq 'HASH') {
                   14943:                         $maxd->{$name} = 1;
                   14944:                     }
1.655     raeburn  14945:                 }
                   14946:             }
                   14947:         }
                   14948:     }
                   14949:     return;
                   14950: }
                   14951: 
                   14952: =pod
                   14953: 
1.1075.2.56  raeburn  14954: =item * &recurse_categories()
1.655     raeburn  14955: 
                   14956: Recursively used to generate breadcrumb trails for course categories.
                   14957: 
                   14958: Inputs:
1.663     raeburn  14959: 
1.655     raeburn  14960: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14961:       categories and subcategories).
1.663     raeburn  14962: 
1.655     raeburn  14963: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  14964: 
                   14965: category (current course category, for which breadcrumb trail is being generated).
                   14966: 
                   14967: trails (reference to array of breadcrumb trails for each category).
                   14968: 
1.655     raeburn  14969: allitems (reference to hash - key is category key
                   14970:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14971: 
1.655     raeburn  14972: parents (array containing containers directories for current category, 
                   14973:          back to top level). 
                   14974: 
                   14975: Returns: nothing
                   14976: 
                   14977: Side effects: populates trails and allitems hash references
                   14978: 
                   14979: =cut
                   14980: 
                   14981: sub recurse_categories {
1.1075.2.132  raeburn  14982:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  14983:     my $shallower = $depth - 1;
                   14984:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   14985:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   14986:             my $name = $cats->[$depth]{$category}[$k];
                   14987:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.164  raeburn  14988:             my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  14989:             if ($allitems->{$item} eq '') {
                   14990:                 push(@{$trails},$trailstr);
                   14991:                 $allitems->{$item} = scalar(@{$trails})-1;
                   14992:             }
                   14993:             my $deeper = $depth+1;
                   14994:             push(@{$parents},$category);
1.665     raeburn  14995:             if (ref($subcats) eq 'HASH') {
                   14996:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   14997:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   14998:                     my $higher;
                   14999:                     if ($j > 0) {
                   15000:                         $higher = &escape($parents->[$j]).':'.
                   15001:                                   &escape($parents->[$j-1]).':'.$j;
                   15002:                     } else {
                   15003:                         $higher = &escape($parents->[$j]).'::'.$j;
                   15004:                     }
                   15005:                     push(@{$subcats->{$higher}},$subcat);
                   15006:                 }
                   15007:             }
                   15008:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132  raeburn  15009:                                 $subcats,$maxd);
1.655     raeburn  15010:             pop(@{$parents});
                   15011:         }
                   15012:     } else {
                   15013:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132  raeburn  15014:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  15015:         if ($allitems->{$item} eq '') {
                   15016:             push(@{$trails},$trailstr);
                   15017:             $allitems->{$item} = scalar(@{$trails})-1;
                   15018:         }
1.1075.2.132  raeburn  15019:         if (ref($maxd) eq 'HASH') {
                   15020:             if ($depth > $maxd->{$parents->[0]}) {
                   15021:                 $maxd->{$parents->[0]} = $depth;
                   15022:             }
                   15023:         }
1.655     raeburn  15024:     }
                   15025:     return;
                   15026: }
                   15027: 
1.663     raeburn  15028: =pod
                   15029: 
1.1075.2.56  raeburn  15030: =item * &assign_categories_table()
1.663     raeburn  15031: 
                   15032: Create a datatable for display of hierarchical categories in a domain,
                   15033: with checkboxes to allow a course to be categorized. 
                   15034: 
                   15035: Inputs:
                   15036: 
                   15037: cathash - reference to hash of categories defined for the domain (from
                   15038:           configuration.db)
                   15039: 
                   15040: currcat - scalar with an & separated list of categories assigned to a course. 
                   15041: 
1.919     raeburn  15042: type    - scalar contains course type (Course or Community).
                   15043: 
1.1075.2.117  raeburn  15044: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15045:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15046: 
1.663     raeburn  15047: Returns: $output (markup to be displayed) 
                   15048: 
                   15049: =cut
                   15050: 
                   15051: sub assign_categories_table {
1.1075.2.117  raeburn  15052:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  15053:     my $output;
                   15054:     if (ref($cathash) eq 'HASH') {
1.1075.2.132  raeburn  15055:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   15056:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  15057:         $maxdepth = scalar(@cats);
                   15058:         if (@cats > 0) {
                   15059:             my $itemcount = 0;
                   15060:             if (ref($cats[0]) eq 'ARRAY') {
                   15061:                 my @currcategories;
                   15062:                 if ($currcat ne '') {
                   15063:                     @currcategories = split('&',$currcat);
                   15064:                 }
1.919     raeburn  15065:                 my $table;
1.663     raeburn  15066:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   15067:                     my $parent = $cats[0][$i];
1.919     raeburn  15068:                     next if ($parent eq 'instcode');
                   15069:                     if ($type eq 'Community') {
                   15070:                         next unless ($parent eq 'communities');
                   15071:                     } else {
                   15072:                         next if ($parent eq 'communities');
                   15073:                     }
1.663     raeburn  15074:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   15075:                     my $item = &escape($parent).'::0';
                   15076:                     my $checked = '';
                   15077:                     if (@currcategories > 0) {
                   15078:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   15079:                             $checked = ' checked="checked"';
1.663     raeburn  15080:                         }
                   15081:                     }
1.919     raeburn  15082:                     my $parent_title = $parent;
                   15083:                     if ($parent eq 'communities') {
                   15084:                         $parent_title = &mt('Communities');
                   15085:                     }
                   15086:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   15087:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15088:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  15089:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  15090:                     my $depth = 1;
                   15091:                     push(@path,$parent);
1.1075.2.117  raeburn  15092:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  15093:                     pop(@path);
1.919     raeburn  15094:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  15095:                     $itemcount ++;
                   15096:                 }
1.919     raeburn  15097:                 if ($itemcount) {
                   15098:                     $output = &Apache::loncommon::start_data_table().
                   15099:                               $table.
                   15100:                               &Apache::loncommon::end_data_table();
                   15101:                 }
1.663     raeburn  15102:             }
                   15103:         }
                   15104:     }
                   15105:     return $output;
                   15106: }
                   15107: 
                   15108: =pod
                   15109: 
1.1075.2.56  raeburn  15110: =item * &assign_category_rows()
1.663     raeburn  15111: 
                   15112: Create a datatable row for display of nested categories in a domain,
                   15113: with checkboxes to allow a course to be categorized,called recursively.
                   15114: 
                   15115: Inputs:
                   15116: 
                   15117: itemcount - track row number for alternating colors
                   15118: 
                   15119: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   15120:       categories and subcategories.
                   15121: 
                   15122: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   15123: 
                   15124: parent - parent of current category item
                   15125: 
                   15126: path - Array containing all categories back up through the hierarchy from the
                   15127:        current category to the top level.
                   15128: 
                   15129: currcategories - reference to array of current categories assigned to the course
                   15130: 
1.1075.2.117  raeburn  15131: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15132:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15133: 
1.663     raeburn  15134: Returns: $output (markup to be displayed).
                   15135: 
                   15136: =cut
                   15137: 
                   15138: sub assign_category_rows {
1.1075.2.117  raeburn  15139:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  15140:     my ($text,$name,$item,$chgstr);
                   15141:     if (ref($cats) eq 'ARRAY') {
                   15142:         my $maxdepth = scalar(@{$cats});
                   15143:         if (ref($cats->[$depth]) eq 'HASH') {
                   15144:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   15145:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   15146:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  15147:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  15148:                 for (my $j=0; $j<$numchildren; $j++) {
                   15149:                     $name = $cats->[$depth]{$parent}[$j];
                   15150:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   15151:                     my $deeper = $depth+1;
                   15152:                     my $checked = '';
                   15153:                     if (ref($currcategories) eq 'ARRAY') {
                   15154:                         if (@{$currcategories} > 0) {
                   15155:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   15156:                                 $checked = ' checked="checked"';
1.663     raeburn  15157:                             }
                   15158:                         }
                   15159:                     }
1.664     raeburn  15160:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   15161:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15162:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  15163:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   15164:                              '</td><td>';
1.663     raeburn  15165:                     if (ref($path) eq 'ARRAY') {
                   15166:                         push(@{$path},$name);
1.1075.2.117  raeburn  15167:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  15168:                         pop(@{$path});
                   15169:                     }
                   15170:                     $text .= '</td></tr>';
                   15171:                 }
                   15172:                 $text .= '</table></td>';
                   15173:             }
                   15174:         }
                   15175:     }
                   15176:     return $text;
                   15177: }
                   15178: 
1.1075.2.69  raeburn  15179: =pod
                   15180: 
                   15181: =back
                   15182: 
                   15183: =cut
                   15184: 
1.655     raeburn  15185: ############################################################
                   15186: ############################################################
                   15187: 
                   15188: 
1.443     albertel 15189: sub commit_customrole {
1.664     raeburn  15190:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  15191:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 15192:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   15193:                          ($end?', ending '.localtime($end):'').': <b>'.
                   15194:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  15195:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 15196:                  '</b><br />';
                   15197:     return $output;
                   15198: }
                   15199: 
                   15200: sub commit_standardrole {
1.1075.2.31  raeburn  15201:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  15202:     my ($output,$logmsg,$linefeed);
                   15203:     if ($context eq 'auto') {
                   15204:         $linefeed = "\n";
                   15205:     } else {
                   15206:         $linefeed = "<br />\n";
                   15207:     }  
1.443     albertel 15208:     if ($three eq 'st') {
1.541     raeburn  15209:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  15210:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  15211:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  15212:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   15213:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 15214:         } else {
1.541     raeburn  15215:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 15216:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15217:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   15218:             if ($context eq 'auto') {
                   15219:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   15220:             } else {
                   15221:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   15222:                &mt('Add to classlist').': <b>ok</b>';
                   15223:             }
                   15224:             $output .= $linefeed;
1.443     albertel 15225:         }
                   15226:     } else {
                   15227:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   15228:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15229:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  15230:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  15231:         if ($context eq 'auto') {
                   15232:             $output .= $result.$linefeed;
                   15233:         } else {
                   15234:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   15235:         }
1.443     albertel 15236:     }
                   15237:     return $output;
                   15238: }
                   15239: 
                   15240: sub commit_studentrole {
1.1075.2.31  raeburn  15241:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   15242:         $credits) = @_;
1.626     raeburn  15243:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  15244:     if ($context eq 'auto') {
                   15245:         $linefeed = "\n";
                   15246:     } else {
                   15247:         $linefeed = '<br />'."\n";
                   15248:     }
1.443     albertel 15249:     if (defined($one) && defined($two)) {
                   15250:         my $cid=$one.'_'.$two;
                   15251:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   15252:         my $secchange = 0;
                   15253:         my $expire_role_result;
                   15254:         my $modify_section_result;
1.628     raeburn  15255:         if ($oldsec ne '-1') { 
                   15256:             if ($oldsec ne $sec) {
1.443     albertel 15257:                 $secchange = 1;
1.628     raeburn  15258:                 my $now = time;
1.443     albertel 15259:                 my $uurl='/'.$cid;
                   15260:                 $uurl=~s/\_/\//g;
                   15261:                 if ($oldsec) {
                   15262:                     $uurl.='/'.$oldsec;
                   15263:                 }
1.626     raeburn  15264:                 $oldsecurl = $uurl;
1.628     raeburn  15265:                 $expire_role_result = 
1.1075.2.167  raeburn  15266:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
                   15267:                                                 '','','',$context);
1.628     raeburn  15268:                 if ($env{'request.course.sec'} ne '') { 
                   15269:                     if ($expire_role_result eq 'refused') {
                   15270:                         my @roles = ('st');
                   15271:                         my @statuses = ('previous');
                   15272:                         my @roledoms = ($one);
                   15273:                         my $withsec = 1;
                   15274:                         my %roleshash = 
                   15275:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   15276:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   15277:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   15278:                             my ($oldstart,$oldend) = 
                   15279:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   15280:                             if ($oldend > 0 && $oldend <= $now) {
                   15281:                                 $expire_role_result = 'ok';
                   15282:                             }
                   15283:                         }
                   15284:                     }
                   15285:                 }
1.443     albertel 15286:                 $result = $expire_role_result;
                   15287:             }
                   15288:         }
                   15289:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  15290:             $modify_section_result = 
                   15291:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   15292:                                                            undef,undef,undef,$sec,
                   15293:                                                            $end,$start,'','',$cid,
                   15294:                                                            '',$context,$credits);
1.443     albertel 15295:             if ($modify_section_result =~ /^ok/) {
                   15296:                 if ($secchange == 1) {
1.628     raeburn  15297:                     if ($sec eq '') {
                   15298:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   15299:                     } else {
                   15300:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   15301:                     }
1.443     albertel 15302:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  15303:                     if ($sec eq '') {
                   15304:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   15305:                     } else {
                   15306:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15307:                     }
1.443     albertel 15308:                 } else {
1.628     raeburn  15309:                     if ($sec eq '') {
                   15310:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   15311:                     } else {
                   15312:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15313:                     }
1.443     albertel 15314:                 }
                   15315:             } else {
1.628     raeburn  15316:                 if ($secchange) {       
                   15317:                     $$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;
                   15318:                 } else {
                   15319:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   15320:                 }
1.443     albertel 15321:             }
                   15322:             $result = $modify_section_result;
                   15323:         } elsif ($secchange == 1) {
1.628     raeburn  15324:             if ($oldsec eq '') {
1.1075.2.20  raeburn  15325:                 $$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  15326:             } else {
                   15327:                 $$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;
                   15328:             }
1.626     raeburn  15329:             if ($expire_role_result eq 'refused') {
                   15330:                 my $newsecurl = '/'.$cid;
                   15331:                 $newsecurl =~ s/\_/\//g;
                   15332:                 if ($sec ne '') {
                   15333:                     $newsecurl.='/'.$sec;
                   15334:                 }
                   15335:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   15336:                     if ($sec eq '') {
                   15337:                         $$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;
                   15338:                     } else {
                   15339:                         $$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;
                   15340:                     }
                   15341:                 }
                   15342:             }
1.443     albertel 15343:         }
                   15344:     } else {
1.626     raeburn  15345:         $$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 15346:         $result = "error: incomplete course id\n";
                   15347:     }
                   15348:     return $result;
                   15349: }
                   15350: 
1.1075.2.25  raeburn  15351: sub show_role_extent {
                   15352:     my ($scope,$context,$role) = @_;
                   15353:     $scope =~ s{^/}{};
                   15354:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   15355:     push(@courseroles,'co');
                   15356:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   15357:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   15358:         $scope =~ s{/}{_};
                   15359:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   15360:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   15361:         my ($audom,$auname) = split(/\//,$scope);
                   15362:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   15363:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   15364:     } else {
                   15365:         $scope =~ s{/$}{};
                   15366:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   15367:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   15368:     }
                   15369: }
                   15370: 
1.443     albertel 15371: ############################################################
                   15372: ############################################################
                   15373: 
1.566     albertel 15374: sub check_clone {
1.578     raeburn  15375:     my ($args,$linefeed) = @_;
1.566     albertel 15376:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   15377:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   15378:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   15379:     my $clonemsg;
                   15380:     my $can_clone = 0;
1.944     raeburn  15381:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  15382:     if ($lctype ne 'community') {
                   15383:         $lctype = 'course';
                   15384:     }
1.566     albertel 15385:     if ($clonehome eq 'no_host') {
1.944     raeburn  15386:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15387:             $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'});
                   15388:         } else {
                   15389:             $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'});
                   15390:         }     
1.566     albertel 15391:     } else {
                   15392: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  15393:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15394:             if ($clonedesc{'type'} ne 'Community') {
                   15395:                  $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'});
                   15396:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15397:             }
                   15398:         }
1.1075.2.119  raeburn  15399: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  15400:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 15401: 	    $can_clone = 1;
                   15402: 	} else {
1.1075.2.95  raeburn  15403: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 15404: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  15405:             if ($clonehash{'cloners'} eq '') {
                   15406:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   15407:                 if ($domdefs{'canclone'}) {
                   15408:                     unless ($domdefs{'canclone'} eq 'none') {
                   15409:                         if ($domdefs{'canclone'} eq 'domain') {
                   15410:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   15411:                                 $can_clone = 1;
                   15412:                             }
                   15413:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15414:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   15415:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   15416:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   15417:                                 $can_clone = 1;
                   15418:                             }
                   15419:                         }
                   15420:                     }
1.908     raeburn  15421:                 }
1.1075.2.95  raeburn  15422:             } else {
                   15423: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   15424:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  15425:                     $can_clone = 1;
1.1075.2.95  raeburn  15426:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  15427:                     $can_clone = 1;
1.1075.2.96  raeburn  15428:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   15429:                     $can_clone = 1;
1.1075.2.95  raeburn  15430:                 }
                   15431:                 unless ($can_clone) {
1.1075.2.96  raeburn  15432:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15433:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  15434:                         my (%gotdomdefaults,%gotcodedefaults);
                   15435:                         foreach my $cloner (@cloners) {
                   15436:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   15437:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   15438:                                 my (%codedefaults,@code_order);
                   15439:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   15440:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   15441:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   15442:                                     }
                   15443:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   15444:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   15445:                                     }
                   15446:                                 } else {
                   15447:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   15448:                                                                             \%codedefaults,
                   15449:                                                                             \@code_order);
                   15450:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   15451:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   15452:                                 }
                   15453:                                 if (@code_order > 0) {
                   15454:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   15455:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   15456:                                                                                 $args->{'crscode'})) {
                   15457:                                         $can_clone = 1;
                   15458:                                         last;
                   15459:                                     }
                   15460:                                 }
                   15461:                             }
                   15462:                         }
                   15463:                     }
1.1075.2.96  raeburn  15464:                 }
                   15465:             }
                   15466:             unless ($can_clone) {
                   15467:                 my $ccrole = 'cc';
                   15468:                 if ($args->{'crstype'} eq 'Community') {
                   15469:                     $ccrole = 'co';
                   15470:                 }
                   15471:                 my %roleshash =
                   15472:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   15473:                                                   $args->{'ccdomain'},
                   15474:                                                   'userroles',['active'],[$ccrole],
                   15475:                                                   [$args->{'clonedomain'}]);
                   15476:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   15477:                     $can_clone = 1;
                   15478:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   15479:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   15480:                     $can_clone = 1;
1.1075.2.95  raeburn  15481:                 }
                   15482:             }
                   15483:             unless ($can_clone) {
                   15484:                 if ($args->{'crstype'} eq 'Community') {
                   15485:                     $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'});
                   15486:                 } else {
                   15487:                     $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  15488: 	        }
1.566     albertel 15489: 	    }
1.578     raeburn  15490:         }
1.566     albertel 15491:     }
                   15492:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15493: }
                   15494: 
1.444     albertel 15495: sub construct_course {
1.1075.2.119  raeburn  15496:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
                   15497:         $cnum,$category,$coderef) = @_;
1.444     albertel 15498:     my $outcome;
1.541     raeburn  15499:     my $linefeed =  '<br />'."\n";
                   15500:     if ($context eq 'auto') {
                   15501:         $linefeed = "\n";
                   15502:     }
1.566     albertel 15503: 
                   15504: #
                   15505: # Are we cloning?
                   15506: #
                   15507:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15508:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  15509: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 15510: 	if ($context ne 'auto') {
1.578     raeburn  15511:             if ($clonemsg ne '') {
                   15512: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   15513:             }
1.566     albertel 15514: 	}
                   15515: 	$outcome .= $clonemsg.$linefeed;
                   15516: 
                   15517:         if (!$can_clone) {
                   15518: 	    return (0,$outcome);
                   15519: 	}
                   15520:     }
                   15521: 
1.444     albertel 15522: #
                   15523: # Open course
                   15524: #
                   15525:     my $crstype = lc($args->{'crstype'});
                   15526:     my %cenv=();
                   15527:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   15528:                                              $args->{'cdescr'},
                   15529:                                              $args->{'curl'},
                   15530:                                              $args->{'course_home'},
                   15531:                                              $args->{'nonstandard'},
                   15532:                                              $args->{'crscode'},
                   15533:                                              $args->{'ccuname'}.':'.
                   15534:                                              $args->{'ccdomain'},
1.882     raeburn  15535:                                              $args->{'crstype'},
1.885     raeburn  15536:                                              $cnum,$context,$category);
1.444     albertel 15537: 
                   15538:     # Note: The testing routines depend on this being output; see 
                   15539:     # Utils::Course. This needs to at least be output as a comment
                   15540:     # if anyone ever decides to not show this, and Utils::Course::new
                   15541:     # will need to be suitably modified.
1.541     raeburn  15542:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  15543:     if ($$courseid =~ /^error:/) {
                   15544:         return (0,$outcome);
                   15545:     }
                   15546: 
1.444     albertel 15547: #
                   15548: # Check if created correctly
                   15549: #
1.479     albertel 15550:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 15551:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  15552:     if ($crsuhome eq 'no_host') {
                   15553:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   15554:         return (0,$outcome);
                   15555:     }
1.541     raeburn  15556:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 15557: 
1.444     albertel 15558: #
1.566     albertel 15559: # Do the cloning
                   15560: #   
                   15561:     if ($can_clone && $cloneid) {
                   15562: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   15563: 	if ($context ne 'auto') {
                   15564: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   15565: 	}
                   15566: 	$outcome .= $clonemsg.$linefeed;
                   15567: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 15568: # Copy all files
1.637     www      15569: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 15570: # Restore URL
1.566     albertel 15571: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 15572: # Restore title
1.566     albertel 15573: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  15574: # Restore creation date, creator and creation context.
                   15575:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   15576:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   15577:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 15578: # Mark as cloned
1.566     albertel 15579: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      15580: # Need to clone grading mode
                   15581:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   15582:         $cenv{'grading'}=$newenv{'grading'};
                   15583: # Do not clone these environment entries
                   15584:         &Apache::lonnet::del('environment',
                   15585:                   ['default_enrollment_start_date',
                   15586:                    'default_enrollment_end_date',
                   15587:                    'question.email',
                   15588:                    'policy.email',
                   15589:                    'comment.email',
                   15590:                    'pch.users.denied',
1.725     raeburn  15591:                    'plc.users.denied',
                   15592:                    'hidefromcat',
1.1075.2.36  raeburn  15593:                    'checkforpriv',
1.1075.2.158  raeburn  15594:                    'categories'],
1.638     www      15595:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  15596:         if ($args->{'textbook'}) {
                   15597:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   15598:         }
1.444     albertel 15599:     }
1.566     albertel 15600: 
1.444     albertel 15601: #
                   15602: # Set environment (will override cloned, if existing)
                   15603: #
                   15604:     my @sections = ();
                   15605:     my @xlists = ();
                   15606:     if ($args->{'crstype'}) {
                   15607:         $cenv{'type'}=$args->{'crstype'};
                   15608:     }
                   15609:     if ($args->{'crsid'}) {
                   15610:         $cenv{'courseid'}=$args->{'crsid'};
                   15611:     }
                   15612:     if ($args->{'crscode'}) {
                   15613:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   15614:     }
                   15615:     if ($args->{'crsquota'} ne '') {
                   15616:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   15617:     } else {
                   15618:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   15619:     }
                   15620:     if ($args->{'ccuname'}) {
                   15621:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   15622:                                         ':'.$args->{'ccdomain'};
                   15623:     } else {
                   15624:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   15625:     }
1.1075.2.31  raeburn  15626:     if ($args->{'defaultcredits'}) {
                   15627:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   15628:     }
1.444     albertel 15629:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1075.2.166  raeburn  15630:     my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444     albertel 15631:     if ($args->{'crssections'}) {
                   15632:         $cenv{'internal.sectionnums'} = '';
                   15633:         if ($args->{'crssections'} =~ m/,/) {
                   15634:             @sections = split/,/,$args->{'crssections'};
                   15635:         } else {
                   15636:             $sections[0] = $args->{'crssections'};
                   15637:         }
                   15638:         if (@sections > 0) {
                   15639:             foreach my $item (@sections) {
                   15640:                 my ($sec,$gp) = split/:/,$item;
                   15641:                 my $class = $args->{'crscode'}.$sec;
                   15642:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   15643:                 $cenv{'internal.sectionnums'} .= $item.',';
1.1075.2.166  raeburn  15644:                 if ($addcheck eq 'ok') {
                   15645:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   15646:                         push(@oklcsecs,$gp);
                   15647:                     }
                   15648:                 } else {
1.1075.2.119  raeburn  15649:                     push(@badclasses,$class);
1.444     albertel 15650:                 }
                   15651:             }
                   15652:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   15653:         }
                   15654:     }
                   15655: # do not hide course coordinator from staff listing, 
                   15656: # even if privileged
                   15657:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  15658: # add course coordinator's domain to domains to check for privileged users
                   15659: # if different to course domain
                   15660:     if ($$crsudom ne $args->{'ccdomain'}) {
                   15661:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   15662:     }
1.444     albertel 15663: # add crosslistings
                   15664:     if ($args->{'crsxlist'}) {
                   15665:         $cenv{'internal.crosslistings'}='';
                   15666:         if ($args->{'crsxlist'} =~ m/,/) {
                   15667:             @xlists = split/,/,$args->{'crsxlist'};
                   15668:         } else {
                   15669:             $xlists[0] = $args->{'crsxlist'};
                   15670:         }
                   15671:         if (@xlists > 0) {
                   15672:             foreach my $item (@xlists) {
                   15673:                 my ($xl,$gp) = split/:/,$item;
                   15674:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   15675:                 $cenv{'internal.crosslistings'} .= $item.',';
1.1075.2.166  raeburn  15676:                 if ($addcheck eq 'ok') {
                   15677:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   15678:                         push(@oklcsecs,$gp);
                   15679:                     }
                   15680:                 } else {
1.1075.2.119  raeburn  15681:                     push(@badclasses,$xl);
1.444     albertel 15682:                 }
                   15683:             }
                   15684:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   15685:         }
                   15686:     }
                   15687:     if ($args->{'autoadds'}) {
                   15688:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   15689:     }
                   15690:     if ($args->{'autodrops'}) {
                   15691:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   15692:     }
                   15693: # check for notification of enrollment changes
                   15694:     my @notified = ();
                   15695:     if ($args->{'notify_owner'}) {
                   15696:         if ($args->{'ccuname'} ne '') {
                   15697:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   15698:         }
                   15699:     }
                   15700:     if ($args->{'notify_dc'}) {
                   15701:         if ($uname ne '') { 
1.630     raeburn  15702:             push(@notified,$uname.':'.$udom);
1.444     albertel 15703:         }
                   15704:     }
                   15705:     if (@notified > 0) {
                   15706:         my $notifylist;
                   15707:         if (@notified > 1) {
                   15708:             $notifylist = join(',',@notified);
                   15709:         } else {
                   15710:             $notifylist = $notified[0];
                   15711:         }
                   15712:         $cenv{'internal.notifylist'} = $notifylist;
                   15713:     }
                   15714:     if (@badclasses > 0) {
                   15715:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  15716:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   15717:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   15718:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 15719:         );
1.1075.2.119  raeburn  15720:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   15721:                            &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  15722:         if ($context eq 'auto') {
                   15723:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  15724:         } else {
1.566     albertel 15725:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  15726:         }
                   15727:         foreach my $item (@badclasses) {
1.541     raeburn  15728:             if ($context eq 'auto') {
1.1075.2.119  raeburn  15729:                 $outcome .= " - $item\n";
1.541     raeburn  15730:             } else {
1.1075.2.119  raeburn  15731:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  15732:             }
1.1075.2.119  raeburn  15733:         }
                   15734:         if ($context eq 'auto') {
                   15735:             $outcome .= $linefeed;
                   15736:         } else {
                   15737:             $outcome .= "</ul><br /><br /></div>\n";
                   15738:         }
1.444     albertel 15739:     }
                   15740:     if ($args->{'no_end_date'}) {
                   15741:         $args->{'endaccess'} = 0;
                   15742:     }
1.1075.2.166  raeburn  15743: #  If an official course with institutional sections is created by cloning
                   15744: #  an existing course, section-specific hiding of course totals in student's
                   15745: #  view of grades as copied from cloned course, will be checked for valid
                   15746: #  sections.
                   15747:     if (($can_clone && $cloneid) &&
                   15748:         ($cenv{'internal.coursecode'} ne '') &&
                   15749:         ($cenv{'grading'} eq 'standard') &&
                   15750:         ($cenv{'hidetotals'} ne '') &&
                   15751:         ($cenv{'hidetotals'} ne 'all')) {
                   15752:         my @hidesecs;
                   15753:         my $deletehidetotals;
                   15754:         if (@oklcsecs) {
                   15755:             foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
                   15756:                 if (grep(/^\Q$sec$/,@oklcsecs)) {
                   15757:                     push(@hidesecs,$sec);
                   15758:                 }
                   15759:             }
                   15760:             if (@hidesecs) {
                   15761:                 $cenv{'hidetotals'} = join(',',@hidesecs);
                   15762:             } else {
                   15763:                 $deletehidetotals = 1;
                   15764:             }
                   15765:         } else {
                   15766:             $deletehidetotals = 1;
                   15767:         }
                   15768:         if ($deletehidetotals) {
                   15769:             delete($cenv{'hidetotals'});
                   15770:             &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
                   15771:         }
                   15772:     }
1.444     albertel 15773:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   15774:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   15775:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   15776:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   15777:     if ($args->{'showphotos'}) {
                   15778:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   15779:     }
                   15780:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   15781:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   15782:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   15783:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  15784:             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'); 
                   15785:             if ($context eq 'auto') {
                   15786:                 $outcome .= $krb_msg;
                   15787:             } else {
1.566     albertel 15788:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  15789:             }
                   15790:             $outcome .= $linefeed;
1.444     albertel 15791:         }
                   15792:     }
                   15793:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   15794:        if ($args->{'setpolicy'}) {
                   15795:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15796:        }
                   15797:        if ($args->{'setcontent'}) {
                   15798:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15799:        }
1.1075.2.110  raeburn  15800:        if ($args->{'setcomment'}) {
                   15801:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15802:        }
1.444     albertel 15803:     }
                   15804:     if ($args->{'reshome'}) {
                   15805: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   15806: 	$cenv{'reshome'}=~s/\/+$/\//;
                   15807:     }
                   15808: #
                   15809: # course has keyed access
                   15810: #
                   15811:     if ($args->{'setkeys'}) {
                   15812:        $cenv{'keyaccess'}='yes';
                   15813:     }
                   15814: # if specified, key authority is not course, but user
                   15815: # only active if keyaccess is yes
                   15816:     if ($args->{'keyauth'}) {
1.487     albertel 15817: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   15818: 	$user = &LONCAPA::clean_username($user);
                   15819: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     15820: 	if ($user ne '' && $domain ne '') {
1.487     albertel 15821: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 15822: 	}
                   15823:     }
                   15824: 
1.1075.2.59  raeburn  15825: #
                   15826: #  generate and store uniquecode (available to course requester), if course should have one.
                   15827: #
                   15828:     if ($args->{'uniquecode'}) {
                   15829:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   15830:         if ($code) {
                   15831:             $cenv{'internal.uniquecode'} = $code;
                   15832:             my %crsinfo =
                   15833:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   15834:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   15835:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   15836:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   15837:             }
                   15838:             if (ref($coderef)) {
                   15839:                 $$coderef = $code;
                   15840:             }
                   15841:         }
                   15842:     }
                   15843: 
1.444     albertel 15844:     if ($args->{'disresdis'}) {
                   15845:         $cenv{'pch.roles.denied'}='st';
                   15846:     }
                   15847:     if ($args->{'disablechat'}) {
                   15848:         $cenv{'plc.roles.denied'}='st';
                   15849:     }
                   15850: 
                   15851:     # Record we've not yet viewed the Course Initialization Helper for this 
                   15852:     # course
                   15853:     $cenv{'course.helper.not.run'} = 1;
                   15854:     #
                   15855:     # Use new Randomseed
                   15856:     #
                   15857:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   15858:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   15859:     #
                   15860:     # The encryption code and receipt prefix for this course
                   15861:     #
                   15862:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   15863:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   15864:     #
                   15865:     # By default, use standard grading
                   15866:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   15867: 
1.541     raeburn  15868:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   15869:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15870: #
                   15871: # Open all assignments
                   15872: #
                   15873:     if ($args->{'openall'}) {
1.1075.2.146  raeburn  15874:        my $opendate = time;
                   15875:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   15876:            $opendate = $args->{'openallfrom'};
                   15877:        }
1.444     albertel 15878:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.146  raeburn  15879:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 15880:                            $storeunder.'.type' => 'date_start');
1.1075.2.146  raeburn  15881:        $outcome .= &mt('All assignments open starting [_1]',
                   15882:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   15883:                    &Apache::lonnet::cput
                   15884:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15885:    }
                   15886: #
                   15887: # Set first page
                   15888: #
                   15889:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   15890: 	    || ($cloneid)) {
1.445     albertel 15891: 	use LONCAPA::map;
1.444     albertel 15892: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 15893: 
                   15894: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   15895:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   15896: 
1.444     albertel 15897:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   15898:         my $title; my $url;
                   15899:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   15900: 	    $title=&mt('Syllabus');
1.444     albertel 15901:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   15902:         } else {
1.963     raeburn  15903:             $title=&mt('Table of Contents');
1.444     albertel 15904:             $url='/adm/navmaps';
                   15905:         }
1.445     albertel 15906: 
                   15907:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   15908: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   15909: 
                   15910: 	if ($errtext) { $fatal=2; }
1.541     raeburn  15911:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 15912:     }
1.566     albertel 15913: 
                   15914:     return (1,$outcome);
1.444     albertel 15915: }
                   15916: 
1.1075.2.59  raeburn  15917: sub make_unique_code {
                   15918:     my ($cdom,$cnum) = @_;
                   15919:     # get lock on uniquecodes db
                   15920:     my $lockhash = {
                   15921:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   15922:                                                   ':'.$env{'user.domain'},
                   15923:                    };
                   15924:     my $tries = 0;
                   15925:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15926:     my ($code,$error);
                   15927: 
                   15928:     while (($gotlock ne 'ok') && ($tries<3)) {
                   15929:         $tries ++;
                   15930:         sleep 1;
                   15931:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15932:     }
                   15933:     if ($gotlock eq 'ok') {
                   15934:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   15935:         my $gotcode;
                   15936:         my $attempts = 0;
                   15937:         while ((!$gotcode) && ($attempts < 100)) {
                   15938:             $code = &generate_code();
                   15939:             if (!exists($currcodes{$code})) {
                   15940:                 $gotcode = 1;
                   15941:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   15942:                     $error = 'nostore';
                   15943:                 }
                   15944:             }
                   15945:             $attempts ++;
                   15946:         }
                   15947:         my @del_lock = ($cnum."\0".'uniquecodes');
                   15948:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   15949:     } else {
                   15950:         $error = 'nolock';
                   15951:     }
                   15952:     return ($code,$error);
                   15953: }
                   15954: 
                   15955: sub generate_code {
                   15956:     my $code;
                   15957:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   15958:     for (my $i=0; $i<6; $i++) {
                   15959:         my $lettnum = int (rand 2);
                   15960:         my $item = '';
                   15961:         if ($lettnum) {
                   15962:             $item = $letts[int( rand(18) )];
                   15963:         } else {
                   15964:             $item = 1+int( rand(8) );
                   15965:         }
                   15966:         $code .= $item;
                   15967:     }
                   15968:     return $code;
                   15969: }
                   15970: 
1.444     albertel 15971: ############################################################
                   15972: ############################################################
                   15973: 
1.953     droeschl 15974: #SD
                   15975: # only Community and Course, or anything else?
1.378     raeburn  15976: sub course_type {
                   15977:     my ($cid) = @_;
                   15978:     if (!defined($cid)) {
                   15979:         $cid = $env{'request.course.id'};
                   15980:     }
1.404     albertel 15981:     if (defined($env{'course.'.$cid.'.type'})) {
                   15982:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  15983:     } else {
                   15984:         return 'Course';
1.377     raeburn  15985:     }
                   15986: }
1.156     albertel 15987: 
1.406     raeburn  15988: sub group_term {
                   15989:     my $crstype = &course_type();
                   15990:     my %names = (
                   15991:                   'Course' => 'group',
1.865     raeburn  15992:                   'Community' => 'group',
1.406     raeburn  15993:                 );
                   15994:     return $names{$crstype};
                   15995: }
                   15996: 
1.902     raeburn  15997: sub course_types {
1.1075.2.59  raeburn  15998:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  15999:     my %typename = (
                   16000:                          official   => 'Official course',
                   16001:                          unofficial => 'Unofficial course',
                   16002:                          community  => 'Community',
1.1075.2.59  raeburn  16003:                          textbook   => 'Textbook course',
1.902     raeburn  16004:                    );
                   16005:     return (\@types,\%typename);
                   16006: }
                   16007: 
1.156     albertel 16008: sub icon {
                   16009:     my ($file)=@_;
1.505     albertel 16010:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 16011:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 16012:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 16013:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   16014: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   16015: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   16016: 	            $curfext.".gif") {
                   16017: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   16018: 		$curfext.".gif";
                   16019: 	}
                   16020:     }
1.249     albertel 16021:     return &lonhttpdurl($iconname);
1.154     albertel 16022: } 
1.84      albertel 16023: 
1.575     albertel 16024: sub lonhttpdurl {
1.692     www      16025: #
                   16026: # Had been used for "small fry" static images on separate port 8080.
                   16027: # Modify here if lightweight http functionality desired again.
                   16028: # Currently eliminated due to increasing firewall issues.
                   16029: #
1.575     albertel 16030:     my ($url)=@_;
1.692     www      16031:     return $url;
1.215     albertel 16032: }
                   16033: 
1.213     albertel 16034: sub connection_aborted {
                   16035:     my ($r)=@_;
                   16036:     $r->print(" ");$r->rflush();
                   16037:     my $c = $r->connection;
                   16038:     return $c->aborted();
                   16039: }
                   16040: 
1.221     foxr     16041: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     16042: #    strings as 'strings'.
                   16043: sub escape_single {
1.221     foxr     16044:     my ($input) = @_;
1.223     albertel 16045:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     16046:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   16047:     return $input;
                   16048: }
1.223     albertel 16049: 
1.222     foxr     16050: #  Same as escape_single, but escape's "'s  This 
                   16051: #  can be used for  "strings"
                   16052: sub escape_double {
                   16053:     my ($input) = @_;
                   16054:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   16055:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   16056:     return $input;
                   16057: }
1.223     albertel 16058:  
1.222     foxr     16059: #   Escapes the last element of a full URL.
                   16060: sub escape_url {
                   16061:     my ($url)   = @_;
1.238     raeburn  16062:     my @urlslices = split(/\//, $url,-1);
1.369     www      16063:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  16064:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     16065: }
1.462     albertel 16066: 
1.820     raeburn  16067: sub compare_arrays {
                   16068:     my ($arrayref1,$arrayref2) = @_;
                   16069:     my (@difference,%count);
                   16070:     @difference = ();
                   16071:     %count = ();
                   16072:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   16073:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   16074:         foreach my $element (keys(%count)) {
                   16075:             if ($count{$element} == 1) {
                   16076:                 push(@difference,$element);
                   16077:             }
                   16078:         }
                   16079:     }
                   16080:     return @difference;
                   16081: }
                   16082: 
1.1075.2.152  raeburn  16083: sub lon_status_items {
                   16084:     my %defaults = (
                   16085:                      E         => 100,
                   16086:                      W         => 4,
                   16087:                      N         => 1,
                   16088:                      U         => 5,
                   16089:                      threshold => 200,
                   16090:                      sysmail   => 2500,
                   16091:                    );
                   16092:     my %names = (
                   16093:                    E => 'Errors',
                   16094:                    W => 'Warnings',
                   16095:                    N => 'Notices',
                   16096:                    U => 'Unsent',
                   16097:                 );
                   16098:     return (\%defaults,\%names);
                   16099: }
                   16100: 
1.817     bisitz   16101: # -------------------------------------------------------- Initialize user login
1.462     albertel 16102: sub init_user_environment {
1.463     albertel 16103:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 16104:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   16105: 
                   16106:     my $public=($username eq 'public' && $domain eq 'public');
                   16107: 
                   16108: # See if old ID present, if so, remove
                   16109: 
1.1062    raeburn  16110:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 16111:     my $now=time;
                   16112: 
                   16113:     if ($public) {
                   16114: 	my $max_public=100;
                   16115: 	my $oldest;
                   16116: 	my $oldest_time=0;
                   16117: 	for(my $next=1;$next<=$max_public;$next++) {
                   16118: 	    if (-e $lonids."/publicuser_$next.id") {
                   16119: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   16120: 		if ($mtime<$oldest_time || !$oldest_time) {
                   16121: 		    $oldest_time=$mtime;
                   16122: 		    $oldest=$next;
                   16123: 		}
                   16124: 	    } else {
                   16125: 		$cookie="publicuser_$next";
                   16126: 		last;
                   16127: 	    }
                   16128: 	}
                   16129: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   16130:     } else {
1.463     albertel 16131: 	# if this isn't a robot, kill any existing non-robot sessions
                   16132: 	if (!$args->{'robot'}) {
                   16133: 	    opendir(DIR,$lonids);
                   16134: 	    while ($filename=readdir(DIR)) {
                   16135: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136  raeburn  16136:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   16137:                             &GDBM_READER(),0640)) {
                   16138:                         my $linkedfile;
                   16139:                         if (exists($oldenv{'user.linkedenv'})) {
                   16140:                             $linkedfile = $oldenv{'user.linkedenv'};
                   16141:                         }
                   16142:                         untie(%oldenv);
                   16143:                         if (unlink("$lonids/$filename")) {
                   16144:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   16145:                                 if (-l "$lonids/$linkedfile.id") {
                   16146:                                     unlink("$lonids/$linkedfile.id");
                   16147:                                 }
                   16148:                             }
                   16149:                         }
                   16150:                     } else {
                   16151:                         unlink($lonids.'/'.$filename);
                   16152:                     }
1.463     albertel 16153: 		}
1.462     albertel 16154: 	    }
1.463     albertel 16155: 	    closedir(DIR);
1.1075.2.84  raeburn  16156: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   16157:             my $namespace = 'nohist_courseeditor';
                   16158:             my $lockingkey = 'paste'."\0".'locked_num';
                   16159:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   16160:                                                 $domain,$username);
                   16161:             if (exists($lockhash{$lockingkey})) {
                   16162:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   16163:                 unless ($delresult eq 'ok') {
                   16164:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   16165:                 }
                   16166:             }
1.462     albertel 16167: 	}
                   16168: # Give them a new cookie
1.463     albertel 16169: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      16170: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 16171: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 16172:     
                   16173: # Initialize roles
                   16174: 
1.1062    raeburn  16175: 	($userroles,$firstaccenv,$timerintenv) = 
                   16176:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 16177:     }
                   16178: # ------------------------------------ Check browser type and MathML capability
                   16179: 
1.1075.2.77  raeburn  16180:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   16181:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 16182: 
                   16183: # ------------------------------------------------------------- Get environment
                   16184: 
                   16185:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   16186:     my ($tmp) = keys(%userenv);
                   16187:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   16188:     } else {
                   16189: 	undef(%userenv);
                   16190:     }
                   16191:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   16192: 	$form->{'interface'}=$userenv{'interface'};
                   16193:     }
                   16194:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   16195: 
                   16196: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   16197:     foreach my $option ('interface','localpath','localres') {
                   16198:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 16199:     }
                   16200: # --------------------------------------------------------- Write first profile
                   16201: 
                   16202:     {
1.1075.2.150  raeburn  16203:         my $ip = &Apache::lonnet::get_requestor_ip();
1.462     albertel 16204: 	my %initial_env = 
                   16205: 	    ("user.name"          => $username,
                   16206: 	     "user.domain"        => $domain,
                   16207: 	     "user.home"          => $authhost,
                   16208: 	     "browser.type"       => $clientbrowser,
                   16209: 	     "browser.version"    => $clientversion,
                   16210: 	     "browser.mathml"     => $clientmathml,
                   16211: 	     "browser.unicode"    => $clientunicode,
                   16212: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  16213:              "browser.mobile"     => $clientmobile,
                   16214:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  16215:              "browser.osversion"  => $clientosversion,
1.462     albertel 16216: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   16217: 	     "request.course.fn"  => '',
                   16218: 	     "request.course.uri" => '',
                   16219: 	     "request.course.sec" => '',
                   16220: 	     "request.role"       => 'cm',
                   16221: 	     "request.role.adv"   => $env{'user.adv'},
1.1075.2.150  raeburn  16222: 	     "request.host"       => $ip,);
1.462     albertel 16223: 
                   16224:         if ($form->{'localpath'}) {
                   16225: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   16226: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   16227:         }
                   16228: 	
                   16229: 	if ($form->{'interface'}) {
                   16230: 	    $form->{'interface'}=~s/\W//gs;
                   16231: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   16232: 	    $env{'browser.interface'}=$form->{'interface'};
                   16233: 	}
                   16234: 
1.1075.2.54  raeburn  16235:         if ($form->{'iptoken'}) {
                   16236:             my $lonhost = $r->dir_config('lonHostID');
                   16237:             $initial_env{"user.noloadbalance"} = $lonhost;
                   16238:             $env{'user.noloadbalance'} = $lonhost;
                   16239:         }
                   16240: 
1.1075.2.120  raeburn  16241:         if ($form->{'noloadbalance'}) {
                   16242:             my @hosts = &Apache::lonnet::current_machine_ids();
                   16243:             my $hosthere = $form->{'noloadbalance'};
                   16244:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   16245:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   16246:                 $env{'user.noloadbalance'} = $hosthere;
                   16247:             }
                   16248:         }
                   16249: 
1.1016    raeburn  16250:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  16251:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   16252:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  16253: 
1.1075.2.125  raeburn  16254:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   16255:                 $userenv{'availabletools.'.$tool} = 
                   16256:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   16257:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   16258:             }
1.724     raeburn  16259: 
1.1075.2.125  raeburn  16260:             foreach my $crstype ('official','unofficial','community','textbook') {
                   16261:                 $userenv{'canrequest.'.$crstype} =
                   16262:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   16263:                                                       'reload','requestcourses',
                   16264:                                                       \%userenv,\%domdef,\%is_adv);
                   16265:             }
1.765     raeburn  16266: 
1.1075.2.125  raeburn  16267:             $userenv{'canrequest.author'} =
                   16268:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   16269:                                                   'reload','requestauthor',
                   16270:                                                   \%userenv,\%domdef,\%is_adv);
                   16271:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   16272:                                                  $domain,$username);
                   16273:             my $reqstatus = $reqauthor{'author_status'};
                   16274:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   16275:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   16276:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   16277:                                                       $reqauthor{'author'}{'timestamp'};
                   16278:                 }
1.1075.2.14  raeburn  16279:             }
                   16280:         }
                   16281: 
1.462     albertel 16282: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  16283: 
1.462     albertel 16284: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   16285: 		 &GDBM_WRCREAT(),0640)) {
                   16286: 	    &_add_to_env(\%disk_env,\%initial_env);
                   16287: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   16288: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  16289:             if (ref($firstaccenv) eq 'HASH') {
                   16290:                 &_add_to_env(\%disk_env,$firstaccenv);
                   16291:             }
                   16292:             if (ref($timerintenv) eq 'HASH') {
                   16293:                 &_add_to_env(\%disk_env,$timerintenv);
                   16294:             }
1.463     albertel 16295: 	    if (ref($args->{'extra_env'})) {
                   16296: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   16297: 	    }
1.462     albertel 16298: 	    untie(%disk_env);
                   16299: 	} else {
1.705     tempelho 16300: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   16301: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 16302: 	    return 'error: '.$!;
                   16303: 	}
                   16304:     }
                   16305:     $env{'request.role'}='cm';
                   16306:     $env{'request.role.adv'}=$env{'user.adv'};
                   16307:     $env{'browser.type'}=$clientbrowser;
                   16308: 
                   16309:     return $cookie;
                   16310: 
                   16311: }
                   16312: 
                   16313: sub _add_to_env {
                   16314:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  16315:     if (ref($env_data) eq 'HASH') {
                   16316:         while (my ($key,$value) = each(%$env_data)) {
                   16317: 	    $idf->{$prefix.$key} = $value;
                   16318: 	    $env{$prefix.$key}   = $value;
                   16319:         }
1.462     albertel 16320:     }
                   16321: }
                   16322: 
1.685     tempelho 16323: # --- Get the symbolic name of a problem and the url
                   16324: sub get_symb {
                   16325:     my ($request,$silent) = @_;
1.726     raeburn  16326:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 16327:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   16328:     if ($symb eq '') {
                   16329:         if (!$silent) {
1.1071    raeburn  16330:             if (ref($request)) { 
                   16331:                 $request->print("Unable to handle ambiguous references:$url:.");
                   16332:             }
1.685     tempelho 16333:             return ();
                   16334:         }
                   16335:     }
                   16336:     &Apache::lonenc::check_decrypt(\$symb);
                   16337:     return ($symb);
                   16338: }
                   16339: 
                   16340: # --------------------------------------------------------------Get annotation
                   16341: 
                   16342: sub get_annotation {
                   16343:     my ($symb,$enc) = @_;
                   16344: 
                   16345:     my $key = $symb;
                   16346:     if (!$enc) {
                   16347:         $key =
                   16348:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   16349:     }
                   16350:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   16351:     return $annotation{$key};
                   16352: }
                   16353: 
                   16354: sub clean_symb {
1.731     raeburn  16355:     my ($symb,$delete_enc) = @_;
1.685     tempelho 16356: 
                   16357:     &Apache::lonenc::check_decrypt(\$symb);
                   16358:     my $enc = $env{'request.enc'};
1.731     raeburn  16359:     if ($delete_enc) {
1.730     raeburn  16360:         delete($env{'request.enc'});
                   16361:     }
1.685     tempelho 16362: 
                   16363:     return ($symb,$enc);
                   16364: }
1.462     albertel 16365: 
1.1075.2.69  raeburn  16366: ############################################################
                   16367: ############################################################
                   16368: 
                   16369: =pod
                   16370: 
                   16371: =head1 Routines for building display used to search for courses
                   16372: 
                   16373: 
                   16374: =over 4
                   16375: 
                   16376: =item * &build_filters()
                   16377: 
                   16378: Create markup for a table used to set filters to use when selecting
                   16379: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   16380: and quotacheck.pl
                   16381: 
                   16382: 
                   16383: Inputs:
                   16384: 
                   16385: filterlist - anonymous array of fields to include as potential filters
                   16386: 
                   16387: crstype - course type
                   16388: 
                   16389: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   16390:               to pop-open a course selector (will contain "extra element").
                   16391: 
                   16392: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   16393: 
                   16394: filter - anonymous hash of criteria and their values
                   16395: 
                   16396: action - form action
                   16397: 
                   16398: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   16399: 
                   16400: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   16401: 
                   16402: cloneruname - username of owner of new course who wants to clone
                   16403: 
                   16404: clonerudom - domain of owner of new course who wants to clone
                   16405: 
                   16406: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   16407: 
                   16408: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   16409: 
                   16410: codedom - domain
                   16411: 
                   16412: formname - value of form element named "form".
                   16413: 
                   16414: fixeddom - domain, if fixed.
                   16415: 
                   16416: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   16417: 
                   16418: cnameelement - name of form element in form on opener page which will receive title of selected course
                   16419: 
                   16420: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   16421: 
                   16422: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   16423: 
                   16424: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   16425: 
                   16426: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   16427: 
                   16428: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   16429: 
                   16430: 
                   16431: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   16432: 
                   16433: 
                   16434: Side Effects: None
                   16435: 
                   16436: =cut
                   16437: 
                   16438: # ---------------------------------------------- search for courses based on last activity etc.
                   16439: 
                   16440: sub build_filters {
                   16441:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   16442:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   16443:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   16444:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   16445:         $clonetext,$clonewarning) = @_;
                   16446:     my ($list,$jscript);
                   16447:     my $onchange = 'javascript:updateFilters(this)';
                   16448:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   16449:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   16450:         $typeselectform,$instcodetitle);
                   16451:     if ($formname eq '') {
                   16452:         $formname = $caller;
                   16453:     }
                   16454:     foreach my $item (@{$filterlist}) {
                   16455:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   16456:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   16457:             if ($item eq 'domainfilter') {
                   16458:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   16459:             } elsif ($item eq 'coursefilter') {
                   16460:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   16461:             } elsif ($item eq 'ownerfilter') {
                   16462:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16463:             } elsif ($item eq 'ownerdomfilter') {
                   16464:                 $filter->{'ownerdomfilter'} =
                   16465:                     &LONCAPA::clean_domain($filter->{$item});
                   16466:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   16467:                                                        'ownerdomfilter',1);
                   16468:             } elsif ($item eq 'personfilter') {
                   16469:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16470:             } elsif ($item eq 'persondomfilter') {
                   16471:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   16472:                                                         'persondomfilter',1);
                   16473:             } else {
                   16474:                 $filter->{$item} =~ s/\W//g;
                   16475:             }
                   16476:             if (!$filter->{$item}) {
                   16477:                 $filter->{$item} = '';
                   16478:             }
                   16479:         }
                   16480:         if ($item eq 'domainfilter') {
                   16481:             my $allow_blank = 1;
                   16482:             if ($formname eq 'portform') {
                   16483:                 $allow_blank=0;
                   16484:             } elsif ($formname eq 'studentform') {
                   16485:                 $allow_blank=0;
                   16486:             }
                   16487:             if ($fixeddom) {
                   16488:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   16489:                                     ' value="'.$codedom.'" />'.
                   16490:                                     &Apache::lonnet::domain($codedom,'description');
                   16491:             } else {
                   16492:                 $domainselectform = &select_dom_form($filter->{$item},
                   16493:                                                      'domainfilter',
                   16494:                                                       $allow_blank,'',$onchange);
                   16495:             }
                   16496:         } else {
                   16497:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   16498:         }
                   16499:     }
                   16500: 
                   16501:     # last course activity filter and selection
                   16502:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   16503: 
                   16504:     # course created filter and selection
                   16505:     if (exists($filter->{'createdfilter'})) {
                   16506:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   16507:     }
                   16508: 
                   16509:     my %lt = &Apache::lonlocal::texthash(
                   16510:                 'cac' => "$crstype Activity",
                   16511:                 'ccr' => "$crstype Created",
                   16512:                 'cde' => "$crstype Title",
                   16513:                 'cdo' => "$crstype Domain",
                   16514:                 'ins' => 'Institutional Code',
                   16515:                 'inc' => 'Institutional Categorization',
                   16516:                 'cow' => "$crstype Owner/Co-owner",
                   16517:                 'cop' => "$crstype Personnel Includes",
                   16518:                 'cog' => 'Type',
                   16519:              );
                   16520: 
                   16521:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16522:         my $typeval = 'Course';
                   16523:         if ($crstype eq 'Community') {
                   16524:             $typeval = 'Community';
                   16525:         }
                   16526:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   16527:     } else {
                   16528:         $typeselectform =  '<select name="type" size="1"';
                   16529:         if ($onchange) {
                   16530:             $typeselectform .= ' onchange="'.$onchange.'"';
                   16531:         }
                   16532:         $typeselectform .= '>'."\n";
                   16533:         foreach my $posstype ('Course','Community') {
                   16534:             $typeselectform.='<option value="'.$posstype.'"'.
                   16535:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   16536:         }
                   16537:         $typeselectform.="</select>";
                   16538:     }
                   16539: 
                   16540:     my ($cloneableonlyform,$cloneabletitle);
                   16541:     if (exists($filter->{'cloneableonly'})) {
                   16542:         my $cloneableon = '';
                   16543:         my $cloneableoff = ' checked="checked"';
                   16544:         if ($filter->{'cloneableonly'}) {
                   16545:             $cloneableon = $cloneableoff;
                   16546:             $cloneableoff = '';
                   16547:         }
                   16548:         $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>';
                   16549:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  16550:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  16551:         } else {
                   16552:             $cloneabletitle = &mt('Cloneable by you');
                   16553:         }
                   16554:     }
                   16555:     my $officialjs;
                   16556:     if ($crstype eq 'Course') {
                   16557:         if (exists($filter->{'instcodefilter'})) {
                   16558: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   16559: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   16560:             if ($codedom) {
                   16561:                 $officialjs = 1;
                   16562:                 ($instcodeform,$jscript,$$numtitlesref) =
                   16563:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   16564:                                                                   $officialjs,$codetitlesref);
                   16565:                 if ($jscript) {
                   16566:                     $jscript = '<script type="text/javascript">'."\n".
                   16567:                                '// <![CDATA['."\n".
                   16568:                                $jscript."\n".
                   16569:                                '// ]]>'."\n".
                   16570:                                '</script>'."\n";
                   16571:                 }
                   16572:             }
                   16573:             if ($instcodeform eq '') {
                   16574:                 $instcodeform =
                   16575:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   16576:                     $list->{'instcodefilter'}.'" />';
                   16577:                 $instcodetitle = $lt{'ins'};
                   16578:             } else {
                   16579:                 $instcodetitle = $lt{'inc'};
                   16580:             }
                   16581:             if ($fixeddom) {
                   16582:                 $instcodetitle .= '<br />('.$codedom.')';
                   16583:             }
                   16584:         }
                   16585:     }
                   16586:     my $output = qq|
                   16587: <form method="post" name="filterpicker" action="$action">
                   16588: <input type="hidden" name="form" value="$formname" />
                   16589: |;
                   16590:     if ($formname eq 'modifycourse') {
                   16591:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   16592:                    '<input type="hidden" name="prevphase" value="'.
                   16593:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  16594:     } elsif ($formname eq 'quotacheck') {
                   16595:         $output .= qq|
                   16596: <input type="hidden" name="sortby" value="" />
                   16597: <input type="hidden" name="sortorder" value="" />
                   16598: |;
                   16599:     } else {
1.1075.2.69  raeburn  16600:         my $name_input;
                   16601:         if ($cnameelement ne '') {
                   16602:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   16603:                           $cnameelement.'" />';
                   16604:         }
                   16605:         $output .= qq|
                   16606: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   16607: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   16608: $name_input
                   16609: $roleelement
                   16610: $multelement
                   16611: $typeelement
                   16612: |;
                   16613:         if ($formname eq 'portform') {
                   16614:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   16615:         }
                   16616:     }
                   16617:     if ($fixeddom) {
                   16618:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   16619:     }
                   16620:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   16621:     if ($sincefilterform) {
                   16622:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   16623:                   .$sincefilterform
                   16624:                   .&Apache::lonhtmlcommon::row_closure();
                   16625:     }
                   16626:     if ($createdfilterform) {
                   16627:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   16628:                   .$createdfilterform
                   16629:                   .&Apache::lonhtmlcommon::row_closure();
                   16630:     }
                   16631:     if ($domainselectform) {
                   16632:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   16633:                   .$domainselectform
                   16634:                   .&Apache::lonhtmlcommon::row_closure();
                   16635:     }
                   16636:     if ($typeselectform) {
                   16637:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16638:             $output .= $typeselectform;
                   16639:         } else {
                   16640:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   16641:                       .$typeselectform
                   16642:                       .&Apache::lonhtmlcommon::row_closure();
                   16643:         }
                   16644:     }
                   16645:     if ($instcodeform) {
                   16646:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   16647:                   .$instcodeform
                   16648:                   .&Apache::lonhtmlcommon::row_closure();
                   16649:     }
                   16650:     if (exists($filter->{'ownerfilter'})) {
                   16651:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   16652:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16653:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   16654:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16655:                    $ownerdomselectform.'</td></tr></table>'.
                   16656:                    &Apache::lonhtmlcommon::row_closure();
                   16657:     }
                   16658:     if (exists($filter->{'personfilter'})) {
                   16659:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   16660:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16661:                    '<input type="text" name="personfilter" size="20" value="'.
                   16662:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16663:                    $persondomselectform.'</td></tr></table>'.
                   16664:                    &Apache::lonhtmlcommon::row_closure();
                   16665:     }
                   16666:     if (exists($filter->{'coursefilter'})) {
                   16667:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   16668:                   .'<input type="text" name="coursefilter" size="25" value="'
                   16669:                   .$list->{'coursefilter'}.'" />'
                   16670:                   .&Apache::lonhtmlcommon::row_closure();
                   16671:     }
                   16672:     if ($cloneableonlyform) {
                   16673:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   16674:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   16675:     }
                   16676:     if (exists($filter->{'descriptfilter'})) {
                   16677:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   16678:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   16679:                   .$list->{'descriptfilter'}.'" />'
                   16680:                   .&Apache::lonhtmlcommon::row_closure(1);
                   16681:     }
                   16682:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   16683:                '<input type="hidden" name="updater" value="" />'."\n".
                   16684:                '<input type="submit" name="gosearch" value="'.
                   16685:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   16686:     return $jscript.$clonewarning.$output;
                   16687: }
                   16688: 
                   16689: =pod
                   16690: 
                   16691: =item * &timebased_select_form()
                   16692: 
                   16693: Create markup for a dropdown list used to select a time-based
                   16694: filter e.g., Course Activity, Course Created, when searching for courses
                   16695: or communities
                   16696: 
                   16697: Inputs:
                   16698: 
                   16699: item - name of form element (sincefilter or createdfilter)
                   16700: 
                   16701: filter - anonymous hash of criteria and their values
                   16702: 
                   16703: Returns: HTML for a select box contained a blank, then six time selections,
                   16704:          with value set in incoming form variables currently selected.
                   16705: 
                   16706: Side Effects: None
                   16707: 
                   16708: =cut
                   16709: 
                   16710: sub timebased_select_form {
                   16711:     my ($item,$filter) = @_;
                   16712:     if (ref($filter) eq 'HASH') {
                   16713:         $filter->{$item} =~ s/[^\d-]//g;
                   16714:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   16715:         return &select_form(
                   16716:                             $filter->{$item},
                   16717:                             $item,
                   16718:                             {      '-1' => '',
                   16719:                                 '86400' => &mt('today'),
                   16720:                                '604800' => &mt('last week'),
                   16721:                               '2592000' => &mt('last month'),
                   16722:                               '7776000' => &mt('last three months'),
                   16723:                              '15552000' => &mt('last six months'),
                   16724:                              '31104000' => &mt('last year'),
                   16725:                     'select_form_order' =>
                   16726:                            ['-1','86400','604800','2592000','7776000',
                   16727:                             '15552000','31104000']});
                   16728:     }
                   16729: }
                   16730: 
                   16731: =pod
                   16732: 
                   16733: =item * &js_changer()
                   16734: 
                   16735: Create script tag containing Javascript used to submit course search form
                   16736: when course type or domain is changed, and also to hide 'Searching ...' on
                   16737: page load completion for page showing search result.
                   16738: 
                   16739: Inputs: None
                   16740: 
                   16741: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   16742: 
                   16743: Side Effects: None
                   16744: 
                   16745: =cut
                   16746: 
                   16747: sub js_changer {
                   16748:     return <<ENDJS;
                   16749: <script type="text/javascript">
                   16750: // <![CDATA[
                   16751: function updateFilters(caller) {
                   16752:     if (typeof(caller) != "undefined") {
                   16753:         document.filterpicker.updater.value = caller.name;
                   16754:     }
                   16755:     document.filterpicker.submit();
                   16756: }
                   16757: 
                   16758: function hideSearching() {
                   16759:     if (document.getElementById('searching')) {
                   16760:         document.getElementById('searching').style.display = 'none';
                   16761:     }
                   16762:     return;
                   16763: }
                   16764: 
                   16765: // ]]>
                   16766: </script>
                   16767: 
                   16768: ENDJS
                   16769: }
                   16770: 
                   16771: =pod
                   16772: 
                   16773: =item * &search_courses()
                   16774: 
                   16775: Process selected filters form course search form and pass to lonnet::courseiddump
                   16776: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   16777: 
                   16778: Inputs:
                   16779: 
                   16780: dom - domain being searched
                   16781: 
                   16782: type - course type ('Course' or 'Community' or '.' if any).
                   16783: 
                   16784: filter - anonymous hash of criteria and their values
                   16785: 
                   16786: numtitles - for institutional codes - number of categories
                   16787: 
                   16788: cloneruname - optional username of new course owner
                   16789: 
                   16790: clonerudom - optional domain of new course owner
                   16791: 
1.1075.2.95  raeburn  16792: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  16793:             (used when DC is using course creation form)
                   16794: 
                   16795: codetitles - reference to array of titles of components in institutional codes (official courses).
                   16796: 
1.1075.2.95  raeburn  16797: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   16798:            (and so can clone automatically)
                   16799: 
                   16800: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   16801: 
                   16802: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   16803:               courses to clone
1.1075.2.69  raeburn  16804: 
                   16805: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   16806: 
                   16807: 
                   16808: Side Effects: None
                   16809: 
                   16810: =cut
                   16811: 
                   16812: 
                   16813: sub search_courses {
1.1075.2.95  raeburn  16814:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   16815:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  16816:     my (%courses,%showcourses,$cloner);
                   16817:     if (($filter->{'ownerfilter'} ne '') ||
                   16818:         ($filter->{'ownerdomfilter'} ne '')) {
                   16819:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   16820:                                        $filter->{'ownerdomfilter'};
                   16821:     }
                   16822:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   16823:         if (!$filter->{$item}) {
                   16824:             $filter->{$item}='.';
                   16825:         }
                   16826:     }
                   16827:     my $now = time;
                   16828:     my $timefilter =
                   16829:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   16830:     my ($createdbefore,$createdafter);
                   16831:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   16832:         $createdbefore = $now;
                   16833:         $createdafter = $now-$filter->{'createdfilter'};
                   16834:     }
                   16835:     my ($instcodefilter,$regexpok);
                   16836:     if ($numtitles) {
                   16837:         if ($env{'form.official'} eq 'on') {
                   16838:             $instcodefilter =
                   16839:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16840:             $regexpok = 1;
                   16841:         } elsif ($env{'form.official'} eq 'off') {
                   16842:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16843:             unless ($instcodefilter eq '') {
                   16844:                 $regexpok = -1;
                   16845:             }
                   16846:         }
                   16847:     } else {
                   16848:         $instcodefilter = $filter->{'instcodefilter'};
                   16849:     }
                   16850:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   16851:     if ($type eq '') { $type = '.'; }
                   16852: 
                   16853:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   16854:         $cloner = $cloneruname.':'.$clonerudom;
                   16855:     }
                   16856:     %courses = &Apache::lonnet::courseiddump($dom,
                   16857:                                              $filter->{'descriptfilter'},
                   16858:                                              $timefilter,
                   16859:                                              $instcodefilter,
                   16860:                                              $filter->{'combownerfilter'},
                   16861:                                              $filter->{'coursefilter'},
                   16862:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  16863:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  16864:                                              $filter->{'cloneableonly'},
                   16865:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  16866:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  16867:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   16868:         my $ccrole;
                   16869:         if ($type eq 'Community') {
                   16870:             $ccrole = 'co';
                   16871:         } else {
                   16872:             $ccrole = 'cc';
                   16873:         }
                   16874:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   16875:                                                      $filter->{'persondomfilter'},
                   16876:                                                      'userroles',undef,
                   16877:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   16878:                                                      $dom);
                   16879:         foreach my $role (keys(%rolehash)) {
                   16880:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   16881:             my $cid = $cdom.'_'.$cnum;
                   16882:             if (exists($courses{$cid})) {
                   16883:                 if (ref($courses{$cid}) eq 'HASH') {
                   16884:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   16885:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  16886:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  16887:                         }
                   16888:                     } else {
                   16889:                         $courses{$cid}{roles} = [$courserole];
                   16890:                     }
                   16891:                     $showcourses{$cid} = $courses{$cid};
                   16892:                 }
                   16893:             }
                   16894:         }
                   16895:         %courses = %showcourses;
                   16896:     }
                   16897:     return %courses;
                   16898: }
                   16899: 
                   16900: =pod
                   16901: 
                   16902: =back
                   16903: 
1.1075.2.88  raeburn  16904: =head1 Routines for version requirements for current course.
                   16905: 
                   16906: =over 4
                   16907: 
                   16908: =item * &check_release_required()
                   16909: 
                   16910: Compares required LON-CAPA version with version on server, and
                   16911: if required version is newer looks for a server with the required version.
                   16912: 
                   16913: Looks first at servers in user's owen domain; if none suitable, looks at
                   16914: servers in course's domain are permitted to host sessions for user's domain.
                   16915: 
                   16916: Inputs:
                   16917: 
                   16918: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16919: 
                   16920: $courseid - Course ID of current course
                   16921: 
                   16922: $rolecode - User's current role in course (for switchserver query string).
                   16923: 
                   16924: $required - LON-CAPA version needed by course (format: Major.Minor).
                   16925: 
                   16926: 
                   16927: Returns:
                   16928: 
                   16929: $switchserver - query string tp append to /adm/switchserver call (if
                   16930:                 current server's LON-CAPA version is too old.
                   16931: 
                   16932: $warning - Message is displayed if no suitable server could be found.
                   16933: 
                   16934: =cut
                   16935: 
                   16936: sub check_release_required {
                   16937:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   16938:     my ($switchserver,$warning);
                   16939:     if ($required ne '') {
                   16940:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   16941:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16942:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   16943:             my $otherserver;
                   16944:             if (($major eq '' && $minor eq '') ||
                   16945:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   16946:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   16947:                 my $switchlcrev =
                   16948:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   16949:                                                            $userdomserver);
                   16950:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16951:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   16952:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   16953:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   16954:                     if ($cdom ne $env{'user.domain'}) {
                   16955:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   16956:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   16957:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   16958:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   16959:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   16960:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   16961:                         my $canhost =
                   16962:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   16963:                                                               $coursedomserver,
                   16964:                                                               $remoterev,
                   16965:                                                               $udomdefaults{'remotesessions'},
                   16966:                                                               $defdomdefaults{'hostedsessions'});
                   16967: 
                   16968:                         if ($canhost) {
                   16969:                             $otherserver = $coursedomserver;
                   16970:                         } else {
                   16971:                             $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.");
                   16972:                         }
                   16973:                     } else {
                   16974:                         $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).");
                   16975:                     }
                   16976:                 } else {
                   16977:                     $otherserver = $userdomserver;
                   16978:                 }
                   16979:             }
                   16980:             if ($otherserver ne '') {
                   16981:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   16982:             }
                   16983:         }
                   16984:     }
                   16985:     return ($switchserver,$warning);
                   16986: }
                   16987: 
                   16988: =pod
                   16989: 
                   16990: =item * &check_release_result()
                   16991: 
                   16992: Inputs:
                   16993: 
                   16994: $switchwarning - Warning message if no suitable server found to host session.
                   16995: 
                   16996: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16997:                 and current role.
                   16998: 
                   16999: Returns: HTML to display with information about requirement to switch server.
                   17000:          Either displaying warning with link to Roles/Courses screen or
                   17001:          display link to switchserver.
                   17002: 
1.1075.2.69  raeburn  17003: =cut
                   17004: 
1.1075.2.88  raeburn  17005: sub check_release_result {
                   17006:     my ($switchwarning,$switchserver) = @_;
                   17007:     my $output = &start_page('Selected course unavailable on this server').
                   17008:                  '<p class="LC_warning">';
                   17009:     if ($switchwarning) {
                   17010:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   17011:         if (&show_course()) {
                   17012:             $output .= &mt('Display courses');
                   17013:         } else {
                   17014:             $output .= &mt('Display roles');
                   17015:         }
                   17016:         $output .= '</a>';
                   17017:     } elsif ($switchserver) {
                   17018:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   17019:                    '<br />'.
                   17020:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   17021:                    &mt('Switch Server').
                   17022:                    '</a>';
                   17023:     }
                   17024:     $output .= '</p>'.&end_page();
                   17025:     return $output;
                   17026: }
                   17027: 
                   17028: =pod
                   17029: 
                   17030: =item * &needs_coursereinit()
                   17031: 
                   17032: Determine if course contents stored for user's session needs to be
                   17033: refreshed, because content has changed since "Big Hash" last tied.
                   17034: 
                   17035: Check for change is made if time last checked is more than 10 minutes ago
                   17036: (by default).
                   17037: 
                   17038: Inputs:
                   17039: 
                   17040: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   17041: 
                   17042: $interval (optional) - Time which may elapse (in s) between last check for content
                   17043:                        change in current course. (default: 600 s).
                   17044: 
                   17045: Returns: an array; first element is:
                   17046: 
                   17047: =over 4
                   17048: 
                   17049: 'switch' - if content updates mean user's session
                   17050:            needs to be switched to a server running a newer LON-CAPA version
                   17051: 
                   17052: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   17053:            on current server hosting user's session
                   17054: 
                   17055: ''       - if no action required.
                   17056: 
                   17057: =back
                   17058: 
                   17059: If first item element is 'switch':
                   17060: 
                   17061: second item is $switchwarning - Warning message if no suitable server found to host session.
                   17062: 
                   17063: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   17064:                               and current role.
                   17065: 
                   17066: otherwise: no other elements returned.
                   17067: 
                   17068: =back
                   17069: 
                   17070: =cut
                   17071: 
                   17072: sub needs_coursereinit {
                   17073:     my ($loncaparev,$interval) = @_;
                   17074:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   17075:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   17076:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   17077:     my $now = time;
                   17078:     if ($interval eq '') {
                   17079:         $interval = 600;
                   17080:     }
                   17081:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   17082:         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   17083:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
                   17084:         if ($lastchange > $env{'request.course.tied'}) {
                   17085:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17086:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   17087:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   17088:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   17089:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   17090:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   17091:                     my ($switchserver,$switchwarning) =
                   17092:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   17093:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   17094:                     if ($switchwarning ne '' || $switchserver ne '') {
                   17095:                         return ('switch',$switchwarning,$switchserver);
                   17096:                     }
                   17097:                 }
                   17098:             }
                   17099:             return ('update');
                   17100:         }
                   17101:     }
                   17102:     return ();
                   17103: }
1.1075.2.69  raeburn  17104: 
1.1075.2.11  raeburn  17105: sub update_content_constraints {
                   17106:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17107:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17108:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   17109:     my %checkresponsetypes;
                   17110:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   17111:         my ($item,$name,$value) = split(/:/,$key);
                   17112:         if ($item eq 'resourcetag') {
                   17113:             if ($name eq 'responsetype') {
                   17114:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   17115:             }
                   17116:         }
                   17117:     }
                   17118:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17119:     if (defined($navmap)) {
                   17120:         my %allresponses;
                   17121:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   17122:             my %responses = $res->responseTypes();
                   17123:             foreach my $key (keys(%responses)) {
                   17124:                 next unless(exists($checkresponsetypes{$key}));
                   17125:                 $allresponses{$key} += $responses{$key};
                   17126:             }
                   17127:         }
                   17128:         foreach my $key (keys(%allresponses)) {
                   17129:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   17130:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   17131:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   17132:             }
                   17133:         }
                   17134:         undef($navmap);
                   17135:     }
                   17136:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   17137:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   17138:     }
                   17139:     return;
                   17140: }
                   17141: 
1.1075.2.27  raeburn  17142: sub allmaps_incourse {
                   17143:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17144:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   17145:         $cid = $env{'request.course.id'};
                   17146:         $cdom = $env{'course.'.$cid.'.domain'};
                   17147:         $cnum = $env{'course.'.$cid.'.num'};
                   17148:         $chome = $env{'course.'.$cid.'.home'};
                   17149:     }
                   17150:     my %allmaps = ();
                   17151:     my $lastchange =
                   17152:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   17153:     if ($lastchange > $env{'request.course.tied'}) {
                   17154:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   17155:         unless ($ferr) {
                   17156:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   17157:         }
                   17158:     }
                   17159:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17160:     if (defined($navmap)) {
                   17161:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   17162:             $allmaps{$res->src()} = 1;
                   17163:         }
                   17164:     }
                   17165:     return \%allmaps;
                   17166: }
                   17167: 
1.1075.2.11  raeburn  17168: sub parse_supplemental_title {
                   17169:     my ($title) = @_;
                   17170: 
                   17171:     my ($foldertitle,$renametitle);
                   17172:     if ($title =~ /&amp;&amp;&amp;/) {
                   17173:         $title = &HTML::Entites::decode($title);
                   17174:     }
                   17175:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   17176:         $renametitle=$4;
                   17177:         my ($time,$uname,$udom) = ($1,$2,$3);
                   17178:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   17179:         my $name =  &plainname($uname,$udom);
                   17180:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   17181:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   17182:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   17183:             $name.': <br />'.$foldertitle;
                   17184:     }
                   17185:     if (wantarray) {
                   17186:         return ($title,$foldertitle,$renametitle);
                   17187:     }
                   17188:     return $title;
                   17189: }
                   17190: 
1.1075.2.43  raeburn  17191: sub recurse_supplemental {
                   17192:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   17193:     if ($suppmap) {
                   17194:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   17195:         if ($fatal) {
                   17196:             $errors ++;
                   17197:         } else {
1.1075.2.167  raeburn  17198:             my @order = @LONCAPA::map::order;
                   17199:             if (@order > 0) {
                   17200:                 my @resources = @LONCAPA::map::resources;
                   17201:                 my @resparms = @LONCAPA::map::resparms;
                   17202:                 foreach my $idx (@order) {
                   17203:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1075.2.43  raeburn  17204:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  17205:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   17206:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  17207:                         } else {
                   17208:                             $numfiles ++;
                   17209:                         }
                   17210:                     }
                   17211:                 }
                   17212:             }
                   17213:         }
                   17214:     }
                   17215:     return ($numfiles,$errors);
                   17216: }
                   17217: 
1.1075.2.18  raeburn  17218: sub symb_to_docspath {
1.1075.2.119  raeburn  17219:     my ($symb,$navmapref) = @_;
                   17220:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  17221:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   17222:     if ($resurl=~/\.(sequence|page)$/) {
                   17223:         $mapurl=$resurl;
                   17224:     } elsif ($resurl eq 'adm/navmaps') {
                   17225:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   17226:     }
                   17227:     my $mapresobj;
1.1075.2.119  raeburn  17228:     unless (ref($$navmapref)) {
                   17229:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   17230:     }
                   17231:     if (ref($$navmapref)) {
                   17232:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  17233:     }
                   17234:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   17235:     my $type=$2;
                   17236:     my $path;
                   17237:     if (ref($mapresobj)) {
                   17238:         my $pcslist = $mapresobj->map_hierarchy();
                   17239:         if ($pcslist ne '') {
                   17240:             foreach my $pc (split(/,/,$pcslist)) {
                   17241:                 next if ($pc <= 1);
1.1075.2.119  raeburn  17242:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  17243:                 if (ref($res)) {
                   17244:                     my $thisurl = $res->src();
                   17245:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   17246:                     my $thistitle = $res->title();
                   17247:                     $path .= '&'.
                   17248:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  17249:                              &escape($thistitle).
1.1075.2.18  raeburn  17250:                              ':'.$res->randompick().
                   17251:                              ':'.$res->randomout().
                   17252:                              ':'.$res->encrypted().
                   17253:                              ':'.$res->randomorder().
                   17254:                              ':'.$res->is_page();
                   17255:                 }
                   17256:             }
                   17257:         }
                   17258:         $path =~ s/^\&//;
                   17259:         my $maptitle = $mapresobj->title();
                   17260:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17261:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17262:         }
                   17263:         $path .= (($path ne '')? '&' : '').
                   17264:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17265:                  &escape($maptitle).
1.1075.2.18  raeburn  17266:                  ':'.$mapresobj->randompick().
                   17267:                  ':'.$mapresobj->randomout().
                   17268:                  ':'.$mapresobj->encrypted().
                   17269:                  ':'.$mapresobj->randomorder().
                   17270:                  ':'.$mapresobj->is_page();
                   17271:     } else {
                   17272:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   17273:         my $ispage = (($type eq 'page')? 1 : '');
                   17274:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17275:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17276:         }
                   17277:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17278:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  17279:     }
                   17280:     unless ($mapurl eq 'default') {
                   17281:         $path = 'default&'.
1.1075.2.46  raeburn  17282:                 &escape('Main Content').
1.1075.2.18  raeburn  17283:                 ':::::&'.$path;
                   17284:     }
                   17285:     return $path;
                   17286: }
                   17287: 
1.1075.2.14  raeburn  17288: sub captcha_display {
1.1075.2.137  raeburn  17289:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17290:     my ($output,$error);
1.1075.2.107  raeburn  17291:     my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137  raeburn  17292:         &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17293:     if ($captcha eq 'original') {
                   17294:         $output = &create_captcha();
                   17295:         unless ($output) {
                   17296:             $error = 'captcha';
                   17297:         }
                   17298:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17299:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  17300:         unless ($output) {
                   17301:             $error = 'recaptcha';
                   17302:         }
                   17303:     }
1.1075.2.107  raeburn  17304:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  17305: }
                   17306: 
                   17307: sub captcha_response {
1.1075.2.137  raeburn  17308:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17309:     my ($captcha_chk,$captcha_error);
1.1075.2.137  raeburn  17310:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17311:     if ($captcha eq 'original') {
                   17312:         ($captcha_chk,$captcha_error) = &check_captcha();
                   17313:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17314:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  17315:     } else {
                   17316:         $captcha_chk = 1;
                   17317:     }
                   17318:     return ($captcha_chk,$captcha_error);
                   17319: }
                   17320: 
                   17321: sub get_captcha_config {
1.1075.2.137  raeburn  17322:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107  raeburn  17323:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  17324:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   17325:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   17326:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17327:     if ($context eq 'usercreation') {
                   17328:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   17329:         if (ref($domconfig{$context}) eq 'HASH') {
                   17330:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   17331:             if (ref($hashtocheck) eq 'HASH') {
                   17332:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   17333:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   17334:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   17335:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   17336:                     }
                   17337:                     if ($privkey && $pubkey) {
                   17338:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  17339:                         $version = $hashtocheck->{'recaptchaversion'};
                   17340:                         if ($version ne '2') {
                   17341:                             $version = 1;
                   17342:                         }
1.1075.2.14  raeburn  17343:                     } else {
                   17344:                         $captcha = 'original';
                   17345:                     }
                   17346:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   17347:                     $captcha = 'original';
                   17348:                 }
                   17349:             }
                   17350:         } else {
                   17351:             $captcha = 'captcha';
                   17352:         }
                   17353:     } elsif ($context eq 'login') {
                   17354:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   17355:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   17356:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   17357:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   17358:             if ($privkey && $pubkey) {
                   17359:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  17360:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   17361:                 if ($version ne '2') {
                   17362:                     $version = 1;
                   17363:                 }
1.1075.2.14  raeburn  17364:             } else {
                   17365:                 $captcha = 'original';
                   17366:             }
                   17367:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   17368:             $captcha = 'original';
                   17369:         }
1.1075.2.137  raeburn  17370:     } elsif ($context eq 'passwords') {
                   17371:         if ($dom_in_effect) {
                   17372:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   17373:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   17374:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   17375:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   17376:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   17377:                 }
                   17378:                 if ($privkey && $pubkey) {
                   17379:                     $captcha = 'recaptcha';
                   17380:                     $version = $passwdconf{'recaptchaversion'};
                   17381:                     if ($version ne '2') {
                   17382:                         $version = 1;
                   17383:                     }
                   17384:                 } else {
                   17385:                     $captcha = 'original';
                   17386:                 }
                   17387:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   17388:                 $captcha = 'original';
                   17389:             }
                   17390:         }
1.1075.2.14  raeburn  17391:     }
1.1075.2.107  raeburn  17392:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  17393: }
                   17394: 
                   17395: sub create_captcha {
                   17396:     my %captcha_params = &captcha_settings();
                   17397:     my ($output,$maxtries,$tries) = ('',10,0);
                   17398:     while ($tries < $maxtries) {
                   17399:         $tries ++;
                   17400:         my $captcha = Authen::Captcha->new (
                   17401:                                            output_folder => $captcha_params{'output_dir'},
                   17402:                                            data_folder   => $captcha_params{'db_dir'},
                   17403:                                           );
                   17404:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   17405: 
                   17406:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   17407:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1075.2.158  raeburn  17408:                       '<span class="LC_nobreak">'.
1.1075.2.14  raeburn  17409:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.167  raeburn  17410:                       '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1075.2.158  raeburn  17411:                       '</span><br />'.
1.1075.2.66  raeburn  17412:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  17413:             last;
                   17414:         }
                   17415:     }
1.1075.2.158  raeburn  17416:     if ($output eq '') {
                   17417:         &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
                   17418:     }
1.1075.2.14  raeburn  17419:     return $output;
                   17420: }
                   17421: 
                   17422: sub captcha_settings {
                   17423:     my %captcha_params = (
                   17424:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   17425:                            www_output_dir => "/captchaspool",
                   17426:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   17427:                            numchars       => '5',
                   17428:                          );
                   17429:     return %captcha_params;
                   17430: }
                   17431: 
                   17432: sub check_captcha {
                   17433:     my ($captcha_chk,$captcha_error);
                   17434:     my $code = $env{'form.code'};
                   17435:     my $md5sum = $env{'form.crypt'};
                   17436:     my %captcha_params = &captcha_settings();
                   17437:     my $captcha = Authen::Captcha->new(
                   17438:                       output_folder => $captcha_params{'output_dir'},
                   17439:                       data_folder   => $captcha_params{'db_dir'},
                   17440:                   );
1.1075.2.26  raeburn  17441:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  17442:     my %captcha_hash = (
                   17443:                         0       => 'Code not checked (file error)',
                   17444:                        -1      => 'Failed: code expired',
                   17445:                        -2      => 'Failed: invalid code (not in database)',
                   17446:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   17447:     );
                   17448:     if ($captcha_chk != 1) {
                   17449:         $captcha_error = $captcha_hash{$captcha_chk}
                   17450:     }
                   17451:     return ($captcha_chk,$captcha_error);
                   17452: }
                   17453: 
                   17454: sub create_recaptcha {
1.1075.2.107  raeburn  17455:     my ($pubkey,$version) = @_;
                   17456:     if ($version >= 2) {
1.1075.2.158  raeburn  17457:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
                   17458:                '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1075.2.107  raeburn  17459:     } else {
                   17460:         my $use_ssl;
                   17461:         if ($ENV{'SERVER_PORT'} == 443) {
                   17462:             $use_ssl = 1;
                   17463:         }
                   17464:         my $captcha = Captcha::reCAPTCHA->new;
                   17465:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   17466:                $captcha->get_html($pubkey,undef,$use_ssl).
                   17467:                &mt('If the text is hard to read, [_1] will replace them.',
                   17468:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   17469:                '<br /><br />';
                   17470:      }
1.1075.2.14  raeburn  17471: }
                   17472: 
                   17473: sub check_recaptcha {
1.1075.2.107  raeburn  17474:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  17475:     my $captcha_chk;
1.1075.2.150  raeburn  17476:     my $ip = &Apache::lonnet::get_requestor_ip(); 
1.1075.2.107  raeburn  17477:     if ($version >= 2) {
                   17478:         my $ua = LWP::UserAgent->new;
                   17479:         $ua->timeout(10);
                   17480:         my %info = (
                   17481:                      secret   => $privkey,
                   17482:                      response => $env{'form.g-recaptcha-response'},
1.1075.2.150  raeburn  17483:                      remoteip => $ip,
1.1075.2.107  raeburn  17484:                    );
                   17485:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   17486:         if ($response->is_success)  {
                   17487:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   17488:             if (ref($data) eq 'HASH') {
                   17489:                 if ($data->{'success'}) {
                   17490:                     $captcha_chk = 1;
                   17491:                 }
                   17492:             }
                   17493:         }
                   17494:     } else {
                   17495:         my $captcha = Captcha::reCAPTCHA->new;
                   17496:         my $captcha_result =
                   17497:             $captcha->check_answer(
                   17498:                                     $privkey,
1.1075.2.150  raeburn  17499:                                     $ip,
1.1075.2.107  raeburn  17500:                                     $env{'form.recaptcha_challenge_field'},
                   17501:                                     $env{'form.recaptcha_response_field'},
                   17502:                                   );
                   17503:         if ($captcha_result->{is_valid}) {
                   17504:             $captcha_chk = 1;
                   17505:         }
1.1075.2.14  raeburn  17506:     }
                   17507:     return $captcha_chk;
                   17508: }
                   17509: 
1.1075.2.64  raeburn  17510: sub emailusername_info {
1.1075.2.103  raeburn  17511:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  17512:     my %titles = &Apache::lonlocal::texthash (
                   17513:                      lastname      => 'Last Name',
                   17514:                      firstname     => 'First Name',
                   17515:                      institution   => 'School/college/university',
                   17516:                      location      => "School's city, state/province, country",
                   17517:                      web           => "School's web address",
                   17518:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  17519:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  17520:                  );
                   17521:     return (\@fields,\%titles);
                   17522: }
                   17523: 
1.1075.2.56  raeburn  17524: sub cleanup_html {
                   17525:     my ($incoming) = @_;
                   17526:     my $outgoing;
                   17527:     if ($incoming ne '') {
                   17528:         $outgoing = $incoming;
                   17529:         $outgoing =~ s/;/&#059;/g;
                   17530:         $outgoing =~ s/\#/&#035;/g;
                   17531:         $outgoing =~ s/\&/&#038;/g;
                   17532:         $outgoing =~ s/</&#060;/g;
                   17533:         $outgoing =~ s/>/&#062;/g;
                   17534:         $outgoing =~ s/\(/&#040/g;
                   17535:         $outgoing =~ s/\)/&#041;/g;
                   17536:         $outgoing =~ s/"/&#034;/g;
                   17537:         $outgoing =~ s/'/&#039;/g;
                   17538:         $outgoing =~ s/\$/&#036;/g;
                   17539:         $outgoing =~ s{/}{&#047;}g;
                   17540:         $outgoing =~ s/=/&#061;/g;
                   17541:         $outgoing =~ s/\\/&#092;/g
                   17542:     }
                   17543:     return $outgoing;
                   17544: }
                   17545: 
1.1075.2.74  raeburn  17546: # Checks for critical messages and returns a redirect url if one exists.
                   17547: # $interval indicates how often to check for messages.
                   17548: sub critical_redirect {
                   17549:     my ($interval) = @_;
1.1075.2.158  raeburn  17550:     unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   17551:         return ();
                   17552:     }
1.1075.2.74  raeburn  17553:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
                   17554:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   17555:                                         $env{'user.name'});
                   17556:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   17557:         my $redirecturl;
                   17558:         if ($what[0]) {
1.1075.2.158  raeburn  17559:             if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1075.2.74  raeburn  17560:                 $redirecturl='/adm/email?critical=display';
                   17561:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   17562:                 return (1, $url);
                   17563:             }
                   17564:         }
                   17565:     }
                   17566:     return ();
                   17567: }
                   17568: 
1.1075.2.64  raeburn  17569: # Use:
                   17570: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   17571: #
                   17572: ##################################################
                   17573: #          password associated functions         #
                   17574: ##################################################
                   17575: sub des_keys {
                   17576:     # Make a new key for DES encryption.
                   17577:     # Each key has two parts which are returned separately.
                   17578:     # Please note:  Each key must be passed through the &hex function
                   17579:     # before it is output to the web browser.  The hex versions cannot
                   17580:     # be used to decrypt.
                   17581:     my @hexstr=('0','1','2','3','4','5','6','7',
                   17582:                 '8','9','a','b','c','d','e','f');
                   17583:     my $lkey='';
                   17584:     for (0..7) {
                   17585:         $lkey.=$hexstr[rand(15)];
                   17586:     }
                   17587:     my $ukey='';
                   17588:     for (0..7) {
                   17589:         $ukey.=$hexstr[rand(15)];
                   17590:     }
                   17591:     return ($lkey,$ukey);
                   17592: }
                   17593: 
                   17594: sub des_decrypt {
                   17595:     my ($key,$cyphertext) = @_;
                   17596:     my $keybin=pack("H16",$key);
                   17597:     my $cypher;
                   17598:     if ($Crypt::DES::VERSION>=2.03) {
                   17599:         $cypher=new Crypt::DES $keybin;
                   17600:     } else {
                   17601:         $cypher=new DES $keybin;
                   17602:     }
1.1075.2.106  raeburn  17603:     my $plaintext='';
                   17604:     my $cypherlength = length($cyphertext);
                   17605:     my $numchunks = int($cypherlength/32);
                   17606:     for (my $j=0; $j<$numchunks; $j++) {
                   17607:         my $start = $j*32;
                   17608:         my $cypherblock = substr($cyphertext,$start,32);
                   17609:         my $chunk =
                   17610:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   17611:         $chunk .=
                   17612:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   17613:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   17614:         $plaintext .= $chunk;
                   17615:     }
1.1075.2.64  raeburn  17616:     return $plaintext;
                   17617: }
                   17618: 
1.1075.2.135  raeburn  17619: sub is_nonframeable {
                   17620:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   17621:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
                   17622:     return if (($remprotocol eq '') || ($remhost eq ''));
                   17623: 
                   17624:     $remprotocol = lc($remprotocol);
                   17625:     $remhost = lc($remhost);
                   17626:     my $remport = 80;
                   17627:     if ($remprotocol eq 'https') {
                   17628:         $remport = 443;
                   17629:     }
                   17630:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
                   17631:     if ($cached) {
                   17632:         unless ($nocache) {
                   17633:             if ($result) {
                   17634:                 return 1;
                   17635:             } else {
                   17636:                 return 0;
                   17637:             }
                   17638:         }
                   17639:     }
                   17640:     my $uselink;
                   17641:     my $request = new HTTP::Request('HEAD',$url);
1.1075.2.142  raeburn  17642:     my $ua = LWP::UserAgent->new;
                   17643:     $ua->timeout(5);
                   17644:     my $response=$ua->request($request);
1.1075.2.135  raeburn  17645:     if ($response->is_success()) {
                   17646:         my $secpolicy = lc($response->header('content-security-policy'));
                   17647:         my $xframeop = lc($response->header('x-frame-options'));
                   17648:         $secpolicy =~ s/^\s+|\s+$//g;
                   17649:         $xframeop =~ s/^\s+|\s+$//g;
                   17650:         if (($secpolicy ne '') || ($xframeop ne '')) {
                   17651:             my $remotehost = $remprotocol.'://'.$remhost;
                   17652:             my ($origin,$protocol,$port);
                   17653:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   17654:                 $port = $ENV{'SERVER_PORT'};
                   17655:             } else {
                   17656:                 $port = 80;
                   17657:             }
                   17658:             if ($absolute eq '') {
                   17659:                 $protocol = 'http:';
                   17660:                 if ($port == 443) {
                   17661:                     $protocol = 'https:';
                   17662:                 }
                   17663:                 $origin = $protocol.'//'.lc($hostname);
                   17664:             } else {
                   17665:                 $origin = lc($absolute);
                   17666:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   17667:             }
                   17668:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   17669:                 my $framepolicy = $1;
                   17670:                 $framepolicy =~ s/^\s+|\s+$//g;
                   17671:                 my @policies = split(/\s+/,$framepolicy);
                   17672:                 if (@policies) {
                   17673:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   17674:                         $uselink = 1;
                   17675:                     } else {
                   17676:                         $uselink = 1;
                   17677:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   17678:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   17679:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   17680:                             undef($uselink);
                   17681:                         }
                   17682:                         if ($uselink) {
                   17683:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   17684:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   17685:                                     undef($uselink);
                   17686:                                 }
                   17687:                             }
                   17688:                         }
                   17689:                         if ($uselink) {
                   17690:                             my @possok;
                   17691:                             if ($ip ne '') {
                   17692:                                 push(@possok,$ip);
                   17693:                             }
                   17694:                             my $hoststr = '';
                   17695:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   17696:                                 if ($hoststr eq '') {
                   17697:                                     $hoststr = $part;
                   17698:                                 } else {
                   17699:                                     $hoststr = "$part.$hoststr";
                   17700:                                 }
                   17701:                                 if ($hoststr eq $hostname) {
                   17702:                                     push(@possok,$hostname);
                   17703:                                 } else {
                   17704:                                     push(@possok,"*.$hoststr");
                   17705:                                 }
                   17706:                             }
                   17707:                             if (@possok) {
                   17708:                                 foreach my $poss (@possok) {
                   17709:                                     last if (!$uselink);
                   17710:                                     foreach my $policy (@policies) {
                   17711:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   17712:                                             undef($uselink);
                   17713:                                             last;
                   17714:                                         }
                   17715:                                     }
                   17716:                                 }
                   17717:                             }
                   17718:                         }
                   17719:                     }
                   17720:                 }
                   17721:             } elsif ($xframeop ne '') {
                   17722:                 $uselink = 1;
                   17723:                 my @policies = split(/\s*,\s*/,$xframeop);
                   17724:                 if (@policies) {
                   17725:                     unless (grep(/^deny$/,@policies)) {
                   17726:                         if ($origin ne '') {
                   17727:                             if (grep(/^sameorigin$/,@policies)) {
                   17728:                                 if ($remotehost eq $origin) {
                   17729:                                     undef($uselink);
                   17730:                                 }
                   17731:                             }
                   17732:                             if ($uselink) {
                   17733:                                 foreach my $policy (@policies) {
                   17734:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   17735:                                         my $allowfrom = $1;
                   17736:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   17737:                                             undef($uselink);
                   17738:                                             last;
                   17739:                                         }
                   17740:                                     }
                   17741:                                 }
                   17742:                             }
                   17743:                         }
                   17744:                     }
                   17745:                 }
                   17746:             }
                   17747:         }
                   17748:     }
                   17749:     if ($nocache) {
                   17750:         if ($cached) {
                   17751:             my $devalidate;
                   17752:             if ($uselink && !$result) {
                   17753:                 $devalidate = 1;
                   17754:             } elsif (!$uselink && $result) {
                   17755:                 $devalidate = 1;
                   17756:             }
                   17757:             if ($devalidate) {
                   17758:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   17759:             }
                   17760:         }
                   17761:     } else {
                   17762:         if ($uselink) {
                   17763:             $result = 1;
                   17764:         } else {
                   17765:             $result = 0;
                   17766:         }
                   17767:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   17768:     }
                   17769:     return $uselink;
                   17770: }
                   17771: 
1.112     bowersj2 17772: 1;
                   17773: __END__;
1.41      ng       17774: 

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