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

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.169! raeburn     4: # $Id: loncommon.pm,v 1.1075.2.168 2024/07/31 22:14:33 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:         }
                   5823:     } else {
1.903     droeschl 5824: 
                   5825:         #    if ($env{'request.state'} eq 'construct') {
                   5826:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   5827:         #    }
                   5828: 
1.1075.2.38  raeburn  5829:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5830:             Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359     albertel 5831: 
1.1075.2.158  raeburn  5832:         my ($left,$right) = Apache::lonmenu::primary_menu($args->{'links_disabled'});
1.1075.2.2  raeburn  5833: 
1.916     droeschl 5834:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.1075.2.22  raeburn  5835:             if ($dc_info) {
1.1075.2.158  raeburn  5836:                 $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
1.1075.2.1  raeburn  5837:             }
1.1075.2.38  raeburn  5838:             $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
1.1075.2.22  raeburn  5839:                            <em>$realm</em> $dc_info</div>|;
1.903     droeschl 5840:             return $bodytag;
                   5841:         }
1.894     droeschl 5842: 
1.927     raeburn  5843:         unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
1.1075.2.38  raeburn  5844:             $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
1.927     raeburn  5845:         }
1.916     droeschl 5846: 
1.1075.2.38  raeburn  5847:         $bodytag .= $right;
1.852     droeschl 5848: 
1.917     raeburn  5849:         if ($dc_info) {
                   5850:             $dc_info = &dc_courseid_toggle($dc_info);
                   5851:         }
                   5852:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 5853: 
1.1075.2.61  raeburn  5854:         #if directed to not display the secondary menu, don't.
                   5855:         if ($args->{'no_secondary_menu'}) {
                   5856:             return $bodytag;
                   5857:         }
1.903     droeschl 5858:         #don't show menus for public users
1.954     raeburn  5859:         if (!$public){
1.1075.2.158  raeburn  5860:             $bodytag .= Apache::lonmenu::secondary_menu($httphost,$args->{'links_disabled'});
1.903     droeschl 5861:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  5862:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   5863:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 5864:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1075.2.133  raeburn  5865:                                 $args->{'bread_crumbs'},'','',$hostname);
1.1075.2.116  raeburn  5866:             } elsif ($forcereg) {
1.1075.2.22  raeburn  5867:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1075.2.116  raeburn  5868:                                                             $args->{'group'},
1.1075.2.161  raeburn  5869:                                                             $args->{'hide_buttons'},
                   5870:                                                             $hostname);
1.1075.2.15  raeburn  5871:             } else {
1.1075.2.21  raeburn  5872:                 my $forbodytag;
                   5873:                 &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   5874:                                                     $forcereg,$args->{'group'},
                   5875:                                                     $args->{'bread_crumbs'},
1.1075.2.133  raeburn  5876:                                                     $advtoolsref,'',$hostname,
                   5877:                                                     \$forbodytag);
1.1075.2.21  raeburn  5878:                 unless (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
                   5879:                     $bodytag .= $forbodytag;
                   5880:                 }
1.920     raeburn  5881:             }
1.903     droeschl 5882:         }else{
                   5883:             # this is to seperate menu from content when there's no secondary
                   5884:             # menu. Especially needed for public accessible ressources.
                   5885:             $bodytag .= '<hr style="clear:both" />';
                   5886:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  5887:         }
1.903     droeschl 5888: 
1.235     raeburn  5889:         return $bodytag;
1.1075.2.12  raeburn  5890:     }
                   5891: 
                   5892: #
                   5893: # Top frame rendering, Remote is up
                   5894: #
                   5895: 
                   5896:     my $imgsrc = $img;
                   5897:     if ($img =~ /^\/adm/) {
                   5898:         $imgsrc = &lonhttpdurl($img);
                   5899:     }
                   5900:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
                   5901: 
1.1075.2.60  raeburn  5902:     my $help=($no_inline_link?''
                   5903:               :&Apache::loncommon::top_nav_help('Help'));
                   5904: 
1.1075.2.12  raeburn  5905:     # Explicit link to get inline menu
                   5906:     my $menu= ($no_inline_link?''
                   5907:                :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
                   5908: 
                   5909:     if ($dc_info) {
                   5910:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   5911:     }
                   5912: 
1.1075.2.38  raeburn  5913:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
                   5914:     unless ($public) {
                   5915:         $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'},
                   5916:                                 undef,'LC_menubuttons_link');
                   5917:     }
                   5918: 
1.1075.2.12  raeburn  5919:     unless ($env{'form.inhibitmenu'}) {
                   5920:         $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.1075.2.38  raeburn  5921:                        <ol class="LC_primary_menu LC_floatright LC_right">
1.1075.2.60  raeburn  5922:                        <li>$help</li>
1.1075.2.12  raeburn  5923:                        <li>$menu</li>
                   5924:                        </ol><div id="LC_realm"> $realm $dc_info</div>|;
                   5925:     }
1.1075.2.21  raeburn  5926:     return $bodytag."\n".$funclist;
1.182     matthew  5927: }
                   5928: 
1.917     raeburn  5929: sub dc_courseid_toggle {
                   5930:     my ($dc_info) = @_;
1.980     raeburn  5931:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5932:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5933:            &mt('(More ...)').'</a></span>'.
                   5934:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5935: }
                   5936: 
1.330     albertel 5937: sub make_attr_string {
                   5938:     my ($register,$attr_ref) = @_;
                   5939: 
                   5940:     if ($attr_ref && !ref($attr_ref)) {
                   5941: 	die("addentries Must be a hash ref ".
                   5942: 	    join(':',caller(1))." ".
                   5943: 	    join(':',caller(0))." ");
                   5944:     }
                   5945: 
                   5946:     if ($register) {
1.339     albertel 5947: 	my ($on_load,$on_unload);
                   5948: 	foreach my $key (keys(%{$attr_ref})) {
                   5949: 	    if      (lc($key) eq 'onload') {
                   5950: 		$on_load.=$attr_ref->{$key}.';';
                   5951: 		delete($attr_ref->{$key});
                   5952: 
                   5953: 	    } elsif (lc($key) eq 'onunload') {
                   5954: 		$on_unload.=$attr_ref->{$key}.';';
                   5955: 		delete($attr_ref->{$key});
                   5956: 	    }
                   5957: 	}
1.1075.2.12  raeburn  5958:         if ($env{'environment.remote'} eq 'on') {
                   5959:             $attr_ref->{'onload'}  =
                   5960:                 &Apache::lonmenu::loadevents().  $on_load;
                   5961:             $attr_ref->{'onunload'}=
                   5962:                 &Apache::lonmenu::unloadevents().$on_unload;
                   5963:         } else {  
                   5964: 	    $attr_ref->{'onload'}  = $on_load;
                   5965: 	    $attr_ref->{'onunload'}= $on_unload;
                   5966:         }
1.330     albertel 5967:     }
1.339     albertel 5968: 
1.330     albertel 5969:     my $attr_string;
1.1075.2.56  raeburn  5970:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 5971: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5972:     }
                   5973:     return $attr_string;
                   5974: }
                   5975: 
                   5976: 
1.182     matthew  5977: ###############################################
1.251     albertel 5978: ###############################################
                   5979: 
                   5980: =pod
                   5981: 
                   5982: =item * &endbodytag()
                   5983: 
                   5984: Returns a uniform footer for LON-CAPA web pages.
                   5985: 
1.635     raeburn  5986: Inputs: 1 - optional reference to an args hash
                   5987: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5988: a 'Continue' link is not displayed if the page contains an
                   5989: internal redirect in the <head></head> section,
                   5990: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 5991: 
                   5992: =cut
                   5993: 
                   5994: sub endbodytag {
1.635     raeburn  5995:     my ($args) = @_;
1.1075.2.6  raeburn  5996:     my $endbodytag;
                   5997:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   5998:         $endbodytag='</body>';
                   5999:     }
1.315     albertel 6000:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  6001:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   6002: 	    $endbodytag=
                   6003: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   6004: 	        &mt('Continue').'</a>'.
                   6005: 	        $endbodytag;
                   6006:         }
1.315     albertel 6007:     }
1.1075.2.165  raeburn  6008:     if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
                   6009:         $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
                   6010:     }
1.251     albertel 6011:     return $endbodytag;
                   6012: }
                   6013: 
1.352     albertel 6014: =pod
                   6015: 
                   6016: =item * &standard_css()
                   6017: 
                   6018: Returns a style sheet
                   6019: 
                   6020: Inputs: (all optional)
                   6021:             domain         -> force to color decorate a page for a specific
                   6022:                                domain
                   6023:             function       -> force usage of a specific rolish color scheme
                   6024:             bgcolor        -> override the default page bgcolor
                   6025: 
                   6026: =cut
                   6027: 
1.343     albertel 6028: sub standard_css {
1.345     albertel 6029:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 6030:     $function  = &get_users_function() if (!$function);
                   6031:     my $img    = &designparm($function.'.img',   $domain);
                   6032:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   6033:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 6034:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 6035: #second colour for later usage
1.345     albertel 6036:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 6037:     my $pgbg_or_bgcolor =
                   6038: 	         $bgcolor ||
1.352     albertel 6039: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 6040:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 6041:     my $alink  = &designparm($function.'.alink', $domain);
                   6042:     my $vlink  = &designparm($function.'.vlink', $domain);
                   6043:     my $link   = &designparm($function.'.link',  $domain);
                   6044: 
1.602     albertel 6045:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 6046:     my $mono                 = 'monospace';
1.850     bisitz   6047:     my $data_table_head      = $sidebg;
                   6048:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   6049:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 6050:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 6051:     my $data_table_highlight = '#FFFF00';
1.352     albertel 6052:     my $mail_new             = '#FFBB77';
                   6053:     my $mail_new_hover       = '#DD9955';
                   6054:     my $mail_read            = '#BBBB77';
                   6055:     my $mail_read_hover      = '#999944';
                   6056:     my $mail_replied         = '#AAAA88';
                   6057:     my $mail_replied_hover   = '#888855';
                   6058:     my $mail_other           = '#99BBBB';
                   6059:     my $mail_other_hover     = '#669999';
1.391     albertel 6060:     my $table_header         = '#DDDDDD';
1.489     raeburn  6061:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   6062:     my $lg_border_color      = '#C8C8C8';
1.952     onken    6063:     my $button_hover         = '#BF2317';
1.392     albertel 6064: 
1.608     albertel 6065:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   6066:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   6067:                                              : '0 3px 0 4px';
1.448     albertel 6068: 
1.523     albertel 6069: 
1.343     albertel 6070:     return <<END;
1.947     droeschl 6071: 
                   6072: /* needed for iframe to allow 100% height in FF */
                   6073: body, html { 
                   6074:     margin: 0;
                   6075:     padding: 0 0.5%;
                   6076:     height: 99%; /* to avoid scrollbars */
                   6077: }
                   6078: 
1.795     www      6079: body {
1.911     bisitz   6080:   font-family: $sans;
                   6081:   line-height:130%;
                   6082:   font-size:0.83em;
                   6083:   color:$font;
1.795     www      6084: }
                   6085: 
1.959     onken    6086: a:focus,
                   6087: a:focus img {
1.795     www      6088:   color: red;
                   6089: }
1.698     harmsja  6090: 
1.911     bisitz   6091: form, .inline {
                   6092:   display: inline;
1.795     www      6093: }
1.721     harmsja  6094: 
1.795     www      6095: .LC_right {
1.911     bisitz   6096:   text-align:right;
1.795     www      6097: }
                   6098: 
                   6099: .LC_middle {
1.911     bisitz   6100:   vertical-align:middle;
1.795     www      6101: }
1.721     harmsja  6102: 
1.1075.2.38  raeburn  6103: .LC_floatleft {
                   6104:   float: left;
                   6105: }
                   6106: 
                   6107: .LC_floatright {
                   6108:   float: right;
                   6109: }
                   6110: 
1.911     bisitz   6111: .LC_400Box {
                   6112:   width:400px;
                   6113: }
1.721     harmsja  6114: 
1.947     droeschl 6115: .LC_iframecontainer {
                   6116:     width: 98%;
                   6117:     margin: 0;
                   6118:     position: fixed;
                   6119:     top: 8.5em;
                   6120:     bottom: 0;
                   6121: }
                   6122: 
                   6123: .LC_iframecontainer iframe{
                   6124:     border: none;
                   6125:     width: 100%;
                   6126:     height: 100%;
                   6127: }
                   6128: 
1.778     bisitz   6129: .LC_filename {
                   6130:   font-family: $mono;
                   6131:   white-space:pre;
1.921     bisitz   6132:   font-size: 120%;
1.778     bisitz   6133: }
                   6134: 
                   6135: .LC_fileicon {
                   6136:   border: none;
                   6137:   height: 1.3em;
                   6138:   vertical-align: text-bottom;
                   6139:   margin-right: 0.3em;
                   6140:   text-decoration:none;
                   6141: }
                   6142: 
1.1008    www      6143: .LC_setting {
                   6144:   text-decoration:underline;
                   6145: }
                   6146: 
1.350     albertel 6147: .LC_error {
                   6148:   color: red;
                   6149: }
1.795     www      6150: 
1.1075.2.15  raeburn  6151: .LC_warning {
                   6152:   color: darkorange;
                   6153: }
                   6154: 
1.457     albertel 6155: .LC_diff_removed {
1.733     bisitz   6156:   color: red;
1.394     albertel 6157: }
1.532     albertel 6158: 
                   6159: .LC_info,
1.457     albertel 6160: .LC_success,
                   6161: .LC_diff_added {
1.350     albertel 6162:   color: green;
                   6163: }
1.795     www      6164: 
1.802     bisitz   6165: div.LC_confirm_box {
                   6166:   background-color: #FAFAFA;
                   6167:   border: 1px solid $lg_border_color;
                   6168:   margin-right: 0;
                   6169:   padding: 5px;
                   6170: }
                   6171: 
                   6172: div.LC_confirm_box .LC_error img,
                   6173: div.LC_confirm_box .LC_success img {
                   6174:   vertical-align: middle;
                   6175: }
                   6176: 
1.1075.2.108  raeburn  6177: .LC_maxwidth {
                   6178:   max-width: 100%;
                   6179:   height: auto;
                   6180: }
                   6181: 
                   6182: .LC_textsize_mobile {
                   6183:   \@media only screen and (max-device-width: 480px) {
                   6184:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   6185:   }
                   6186: }
                   6187: 
1.440     albertel 6188: .LC_icon {
1.771     droeschl 6189:   border: none;
1.790     droeschl 6190:   vertical-align: middle;
1.771     droeschl 6191: }
                   6192: 
1.543     albertel 6193: .LC_docs_spacer {
                   6194:   width: 25px;
                   6195:   height: 1px;
1.771     droeschl 6196:   border: none;
1.543     albertel 6197: }
1.346     albertel 6198: 
1.532     albertel 6199: .LC_internal_info {
1.735     bisitz   6200:   color: #999999;
1.532     albertel 6201: }
                   6202: 
1.794     www      6203: .LC_discussion {
1.1050    www      6204:   background: $data_table_dark;
1.911     bisitz   6205:   border: 1px solid black;
                   6206:   margin: 2px;
1.794     www      6207: }
                   6208: 
                   6209: .LC_disc_action_left {
1.1050    www      6210:   background: $sidebg;
1.911     bisitz   6211:   text-align: left;
1.1050    www      6212:   padding: 4px;
                   6213:   margin: 2px;
1.794     www      6214: }
                   6215: 
                   6216: .LC_disc_action_right {
1.1050    www      6217:   background: $sidebg;
1.911     bisitz   6218:   text-align: right;
1.1050    www      6219:   padding: 4px;
                   6220:   margin: 2px;
1.794     www      6221: }
                   6222: 
                   6223: .LC_disc_new_item {
1.911     bisitz   6224:   background: white;
                   6225:   border: 2px solid red;
1.1050    www      6226:   margin: 4px;
                   6227:   padding: 4px;
1.794     www      6228: }
                   6229: 
                   6230: .LC_disc_old_item {
1.911     bisitz   6231:   background: white;
1.1050    www      6232:   margin: 4px;
                   6233:   padding: 4px;
1.794     www      6234: }
                   6235: 
1.458     albertel 6236: table.LC_pastsubmission {
                   6237:   border: 1px solid black;
                   6238:   margin: 2px;
                   6239: }
                   6240: 
1.924     bisitz   6241: table#LC_menubuttons {
1.345     albertel 6242:   width: 100%;
                   6243:   background: $pgbg;
1.392     albertel 6244:   border: 2px;
1.402     albertel 6245:   border-collapse: separate;
1.803     bisitz   6246:   padding: 0;
1.345     albertel 6247: }
1.392     albertel 6248: 
1.801     tempelho 6249: table#LC_title_bar a {
                   6250:   color: $fontmenu;
                   6251: }
1.836     bisitz   6252: 
1.807     droeschl 6253: table#LC_title_bar {
1.819     tempelho 6254:   clear: both;
1.836     bisitz   6255:   display: none;
1.807     droeschl 6256: }
                   6257: 
1.795     www      6258: table#LC_title_bar,
1.933     droeschl 6259: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 6260: table#LC_title_bar.LC_with_remote {
1.359     albertel 6261:   width: 100%;
1.392     albertel 6262:   border-color: $pgbg;
                   6263:   border-style: solid;
                   6264:   border-width: $border;
1.379     albertel 6265:   background: $pgbg;
1.801     tempelho 6266:   color: $fontmenu;
1.392     albertel 6267:   border-collapse: collapse;
1.803     bisitz   6268:   padding: 0;
1.819     tempelho 6269:   margin: 0;
1.359     albertel 6270: }
1.795     www      6271: 
1.933     droeschl 6272: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 6273:     margin: 0;
                   6274:     padding: 0;
1.933     droeschl 6275:     position: relative;
                   6276:     list-style: none;
1.913     droeschl 6277: }
1.933     droeschl 6278: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 6279:     display: inline;
                   6280: }
1.933     droeschl 6281: 
                   6282: .LC_breadcrumb_tools_navigation {
1.913     droeschl 6283:     padding: 0;
1.933     droeschl 6284:     margin: 0;
                   6285:     float: left;
1.913     droeschl 6286: }
1.933     droeschl 6287: .LC_breadcrumb_tools_tools {
                   6288:     padding: 0;
                   6289:     margin: 0;
1.913     droeschl 6290:     float: right;
                   6291: }
                   6292: 
1.359     albertel 6293: table#LC_title_bar td {
                   6294:   background: $tabbg;
                   6295: }
1.795     www      6296: 
1.911     bisitz   6297: table#LC_menubuttons img {
1.803     bisitz   6298:   border: none;
1.346     albertel 6299: }
1.795     www      6300: 
1.842     droeschl 6301: .LC_breadcrumbs_component {
1.911     bisitz   6302:   float: right;
                   6303:   margin: 0 1em;
1.357     albertel 6304: }
1.842     droeschl 6305: .LC_breadcrumbs_component img {
1.911     bisitz   6306:   vertical-align: middle;
1.777     tempelho 6307: }
1.795     www      6308: 
1.1075.2.108  raeburn  6309: .LC_breadcrumbs_hoverable {
                   6310:   background: $sidebg;
                   6311: }
                   6312: 
1.383     albertel 6313: td.LC_table_cell_checkbox {
                   6314:   text-align: center;
                   6315: }
1.795     www      6316: 
                   6317: .LC_fontsize_small {
1.911     bisitz   6318:   font-size: 70%;
1.705     tempelho 6319: }
                   6320: 
1.844     bisitz   6321: #LC_breadcrumbs {
1.911     bisitz   6322:   clear:both;
                   6323:   background: $sidebg;
                   6324:   border-bottom: 1px solid $lg_border_color;
                   6325:   line-height: 2.5em;
1.933     droeschl 6326:   overflow: hidden;
1.911     bisitz   6327:   margin: 0;
                   6328:   padding: 0;
1.995     raeburn  6329:   text-align: left;
1.819     tempelho 6330: }
1.862     bisitz   6331: 
1.1075.2.16  raeburn  6332: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   6333:   clear:both;
                   6334:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 6335:   border: 1px solid $sidebg;
1.1075.2.16  raeburn  6336:   margin: 0 0 10px 0;
1.966     bisitz   6337:   padding: 3px;
1.995     raeburn  6338:   text-align: left;
1.822     bisitz   6339: }
                   6340: 
1.795     www      6341: .LC_fontsize_medium {
1.911     bisitz   6342:   font-size: 85%;
1.705     tempelho 6343: }
                   6344: 
1.795     www      6345: .LC_fontsize_large {
1.911     bisitz   6346:   font-size: 120%;
1.705     tempelho 6347: }
                   6348: 
1.346     albertel 6349: .LC_menubuttons_inline_text {
                   6350:   color: $font;
1.698     harmsja  6351:   font-size: 90%;
1.701     harmsja  6352:   padding-left:3px;
1.346     albertel 6353: }
                   6354: 
1.934     droeschl 6355: .LC_menubuttons_inline_text img{
                   6356:   vertical-align: middle;
                   6357: }
                   6358: 
1.1051    www      6359: li.LC_menubuttons_inline_text img {
1.951     onken    6360:   cursor:pointer;
1.1002    droeschl 6361:   text-decoration: none;
1.951     onken    6362: }
                   6363: 
1.526     www      6364: .LC_menubuttons_link {
                   6365:   text-decoration: none;
                   6366: }
1.795     www      6367: 
1.522     albertel 6368: .LC_menubuttons_category {
1.521     www      6369:   color: $font;
1.526     www      6370:   background: $pgbg;
1.521     www      6371:   font-size: larger;
                   6372:   font-weight: bold;
                   6373: }
                   6374: 
1.346     albertel 6375: td.LC_menubuttons_text {
1.911     bisitz   6376:   color: $font;
1.346     albertel 6377: }
1.706     harmsja  6378: 
1.346     albertel 6379: .LC_current_location {
                   6380:   background: $tabbg;
                   6381: }
1.795     www      6382: 
1.1075.2.134  raeburn  6383: td.LC_zero_height {
                   6384:   line-height: 0;
                   6385:   cellpadding: 0;
                   6386: }
                   6387: 
1.938     bisitz   6388: table.LC_data_table {
1.347     albertel 6389:   border: 1px solid #000000;
1.402     albertel 6390:   border-collapse: separate;
1.426     albertel 6391:   border-spacing: 1px;
1.610     albertel 6392:   background: $pgbg;
1.347     albertel 6393: }
1.795     www      6394: 
1.422     albertel 6395: .LC_data_table_dense {
                   6396:   font-size: small;
                   6397: }
1.795     www      6398: 
1.507     raeburn  6399: table.LC_nested_outer {
                   6400:   border: 1px solid #000000;
1.589     raeburn  6401:   border-collapse: collapse;
1.803     bisitz   6402:   border-spacing: 0;
1.507     raeburn  6403:   width: 100%;
                   6404: }
1.795     www      6405: 
1.879     raeburn  6406: table.LC_innerpickbox,
1.507     raeburn  6407: table.LC_nested {
1.803     bisitz   6408:   border: none;
1.589     raeburn  6409:   border-collapse: collapse;
1.803     bisitz   6410:   border-spacing: 0;
1.507     raeburn  6411:   width: 100%;
                   6412: }
1.795     www      6413: 
1.911     bisitz   6414: table.LC_data_table tr th,
                   6415: table.LC_calendar tr th,
1.879     raeburn  6416: table.LC_prior_tries tr th,
                   6417: table.LC_innerpickbox tr th {
1.349     albertel 6418:   font-weight: bold;
                   6419:   background-color: $data_table_head;
1.801     tempelho 6420:   color:$fontmenu;
1.701     harmsja  6421:   font-size:90%;
1.347     albertel 6422: }
1.795     www      6423: 
1.879     raeburn  6424: table.LC_innerpickbox tr th,
                   6425: table.LC_innerpickbox tr td {
                   6426:   vertical-align: top;
                   6427: }
                   6428: 
1.711     raeburn  6429: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6430:   background-color: #CCCCCC;
1.711     raeburn  6431:   font-weight: bold;
                   6432:   text-align: left;
                   6433: }
1.795     www      6434: 
1.912     bisitz   6435: table.LC_data_table tr.LC_odd_row > td {
                   6436:   background-color: $data_table_light;
                   6437:   padding: 2px;
                   6438:   vertical-align: top;
                   6439: }
                   6440: 
1.809     bisitz   6441: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6442:   background-color: $data_table_light;
1.912     bisitz   6443:   vertical-align: top;
                   6444: }
                   6445: 
                   6446: table.LC_data_table tr.LC_even_row > td {
                   6447:   background-color: $data_table_dark;
1.425     albertel 6448:   padding: 2px;
1.900     bisitz   6449:   vertical-align: top;
1.347     albertel 6450: }
1.795     www      6451: 
1.809     bisitz   6452: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6453:   background-color: $data_table_dark;
1.900     bisitz   6454:   vertical-align: top;
1.347     albertel 6455: }
1.795     www      6456: 
1.425     albertel 6457: table.LC_data_table tr.LC_data_table_highlight td {
                   6458:   background-color: $data_table_darker;
                   6459: }
1.795     www      6460: 
1.639     raeburn  6461: table.LC_data_table tr td.LC_leftcol_header {
                   6462:   background-color: $data_table_head;
                   6463:   font-weight: bold;
                   6464: }
1.795     www      6465: 
1.451     albertel 6466: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6467: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6468:   font-weight: bold;
                   6469:   font-style: italic;
                   6470:   text-align: center;
                   6471:   padding: 8px;
1.347     albertel 6472: }
1.795     www      6473: 
1.1075.2.30  raeburn  6474: table.LC_data_table tr.LC_empty_row td,
                   6475: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6476:   background-color: $sidebg;
                   6477: }
                   6478: 
                   6479: table.LC_nested tr.LC_empty_row td {
                   6480:   background-color: #FFFFFF;
                   6481: }
                   6482: 
1.890     droeschl 6483: table.LC_caption {
                   6484: }
                   6485: 
1.507     raeburn  6486: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6487:   padding: 4ex
                   6488: }
1.795     www      6489: 
1.507     raeburn  6490: table.LC_nested_outer tr th {
                   6491:   font-weight: bold;
1.801     tempelho 6492:   color:$fontmenu;
1.507     raeburn  6493:   background-color: $data_table_head;
1.701     harmsja  6494:   font-size: small;
1.507     raeburn  6495:   border-bottom: 1px solid #000000;
                   6496: }
1.795     www      6497: 
1.507     raeburn  6498: table.LC_nested_outer tr td.LC_subheader {
                   6499:   background-color: $data_table_head;
                   6500:   font-weight: bold;
                   6501:   font-size: small;
                   6502:   border-bottom: 1px solid #000000;
                   6503:   text-align: right;
1.451     albertel 6504: }
1.795     www      6505: 
1.507     raeburn  6506: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6507:   background-color: #CCCCCC;
1.451     albertel 6508:   font-weight: bold;
                   6509:   font-size: small;
1.507     raeburn  6510:   text-align: center;
                   6511: }
1.795     www      6512: 
1.589     raeburn  6513: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6514: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6515:   text-align: left;
1.451     albertel 6516: }
1.795     www      6517: 
1.507     raeburn  6518: table.LC_nested td {
1.735     bisitz   6519:   background-color: #FFFFFF;
1.451     albertel 6520:   font-size: small;
1.507     raeburn  6521: }
1.795     www      6522: 
1.507     raeburn  6523: table.LC_nested_outer tr th.LC_right_item,
                   6524: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6525: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6526: table.LC_nested tr td.LC_right_item {
1.451     albertel 6527:   text-align: right;
                   6528: }
                   6529: 
1.507     raeburn  6530: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6531:   background-color: #EEEEEE;
1.451     albertel 6532: }
                   6533: 
1.473     raeburn  6534: table.LC_createuser {
                   6535: }
                   6536: 
                   6537: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6538:   font-size: small;
1.473     raeburn  6539: }
                   6540: 
                   6541: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6542:   background-color: #CCCCCC;
1.473     raeburn  6543:   font-weight: bold;
                   6544:   text-align: center;
                   6545: }
                   6546: 
1.349     albertel 6547: table.LC_calendar {
                   6548:   border: 1px solid #000000;
                   6549:   border-collapse: collapse;
1.917     raeburn  6550:   width: 98%;
1.349     albertel 6551: }
1.795     www      6552: 
1.349     albertel 6553: table.LC_calendar_pickdate {
                   6554:   font-size: xx-small;
                   6555: }
1.795     www      6556: 
1.349     albertel 6557: table.LC_calendar tr td {
                   6558:   border: 1px solid #000000;
                   6559:   vertical-align: top;
1.917     raeburn  6560:   width: 14%;
1.349     albertel 6561: }
1.795     www      6562: 
1.349     albertel 6563: table.LC_calendar tr td.LC_calendar_day_empty {
                   6564:   background-color: $data_table_dark;
                   6565: }
1.795     www      6566: 
1.779     bisitz   6567: table.LC_calendar tr td.LC_calendar_day_current {
                   6568:   background-color: $data_table_highlight;
1.777     tempelho 6569: }
1.795     www      6570: 
1.938     bisitz   6571: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6572:   background-color: $mail_new;
                   6573: }
1.795     www      6574: 
1.938     bisitz   6575: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6576:   background-color: $mail_new_hover;
                   6577: }
1.795     www      6578: 
1.938     bisitz   6579: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6580:   background-color: $mail_read;
                   6581: }
1.795     www      6582: 
1.938     bisitz   6583: /*
                   6584: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6585:   background-color: $mail_read_hover;
                   6586: }
1.938     bisitz   6587: */
1.795     www      6588: 
1.938     bisitz   6589: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6590:   background-color: $mail_replied;
                   6591: }
1.795     www      6592: 
1.938     bisitz   6593: /*
                   6594: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6595:   background-color: $mail_replied_hover;
                   6596: }
1.938     bisitz   6597: */
1.795     www      6598: 
1.938     bisitz   6599: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6600:   background-color: $mail_other;
                   6601: }
1.795     www      6602: 
1.938     bisitz   6603: /*
                   6604: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6605:   background-color: $mail_other_hover;
                   6606: }
1.938     bisitz   6607: */
1.494     raeburn  6608: 
1.777     tempelho 6609: table.LC_data_table tr > td.LC_browser_file,
                   6610: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6611:   background: #AAEE77;
1.389     albertel 6612: }
1.795     www      6613: 
1.777     tempelho 6614: table.LC_data_table tr > td.LC_browser_file_locked,
                   6615: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6616:   background: #FFAA99;
1.387     albertel 6617: }
1.795     www      6618: 
1.777     tempelho 6619: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6620:   background: #888888;
1.779     bisitz   6621: }
1.795     www      6622: 
1.777     tempelho 6623: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6624: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6625:   background: #F8F866;
1.777     tempelho 6626: }
1.795     www      6627: 
1.696     bisitz   6628: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6629:   background: #E0E8FF;
1.387     albertel 6630: }
1.696     bisitz   6631: 
1.707     bisitz   6632: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6633:   /* background: #77FF77; */
1.707     bisitz   6634: }
1.795     www      6635: 
1.707     bisitz   6636: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6637:   border-right: 8px solid #FFFF77;
1.707     bisitz   6638: }
1.795     www      6639: 
1.707     bisitz   6640: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6641:   border-right: 8px solid #FFAA77;
1.707     bisitz   6642: }
1.795     www      6643: 
1.707     bisitz   6644: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6645:   border-right: 8px solid #FF7777;
1.707     bisitz   6646: }
1.795     www      6647: 
1.707     bisitz   6648: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6649:   border-right: 8px solid #AAFF77;
1.707     bisitz   6650: }
1.795     www      6651: 
1.707     bisitz   6652: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6653:   border-right: 8px solid #11CC55;
1.707     bisitz   6654: }
                   6655: 
1.388     albertel 6656: span.LC_current_location {
1.701     harmsja  6657:   font-size:larger;
1.388     albertel 6658:   background: $pgbg;
                   6659: }
1.387     albertel 6660: 
1.1029    www      6661: span.LC_current_nav_location {
                   6662:   font-weight:bold;
                   6663:   background: $sidebg;
                   6664: }
                   6665: 
1.395     albertel 6666: span.LC_parm_menu_item {
                   6667:   font-size: larger;
                   6668: }
1.795     www      6669: 
1.395     albertel 6670: span.LC_parm_scope_all {
                   6671:   color: red;
                   6672: }
1.795     www      6673: 
1.395     albertel 6674: span.LC_parm_scope_folder {
                   6675:   color: green;
                   6676: }
1.795     www      6677: 
1.395     albertel 6678: span.LC_parm_scope_resource {
                   6679:   color: orange;
                   6680: }
1.795     www      6681: 
1.395     albertel 6682: span.LC_parm_part {
                   6683:   color: blue;
                   6684: }
1.795     www      6685: 
1.911     bisitz   6686: span.LC_parm_folder,
                   6687: span.LC_parm_symb {
1.395     albertel 6688:   font-size: x-small;
                   6689:   font-family: $mono;
                   6690:   color: #AAAAAA;
                   6691: }
                   6692: 
1.977     bisitz   6693: ul.LC_parm_parmlist li {
                   6694:   display: inline-block;
                   6695:   padding: 0.3em 0.8em;
                   6696:   vertical-align: top;
                   6697:   width: 150px;
                   6698:   border-top:1px solid $lg_border_color;
                   6699: }
                   6700: 
1.795     www      6701: td.LC_parm_overview_level_menu,
                   6702: td.LC_parm_overview_map_menu,
                   6703: td.LC_parm_overview_parm_selectors,
                   6704: td.LC_parm_overview_restrictions  {
1.396     albertel 6705:   border: 1px solid black;
                   6706:   border-collapse: collapse;
                   6707: }
1.795     www      6708: 
1.396     albertel 6709: table.LC_parm_overview_restrictions td {
                   6710:   border-width: 1px 4px 1px 4px;
                   6711:   border-style: solid;
                   6712:   border-color: $pgbg;
                   6713:   text-align: center;
                   6714: }
1.795     www      6715: 
1.396     albertel 6716: table.LC_parm_overview_restrictions th {
                   6717:   background: $tabbg;
                   6718:   border-width: 1px 4px 1px 4px;
                   6719:   border-style: solid;
                   6720:   border-color: $pgbg;
                   6721: }
1.795     www      6722: 
1.398     albertel 6723: table#LC_helpmenu {
1.803     bisitz   6724:   border: none;
1.398     albertel 6725:   height: 55px;
1.803     bisitz   6726:   border-spacing: 0;
1.398     albertel 6727: }
                   6728: 
                   6729: table#LC_helpmenu fieldset legend {
                   6730:   font-size: larger;
                   6731: }
1.795     www      6732: 
1.397     albertel 6733: table#LC_helpmenu_links {
                   6734:   width: 100%;
                   6735:   border: 1px solid black;
                   6736:   background: $pgbg;
1.803     bisitz   6737:   padding: 0;
1.397     albertel 6738:   border-spacing: 1px;
                   6739: }
1.795     www      6740: 
1.397     albertel 6741: table#LC_helpmenu_links tr td {
                   6742:   padding: 1px;
                   6743:   background: $tabbg;
1.399     albertel 6744:   text-align: center;
                   6745:   font-weight: bold;
1.397     albertel 6746: }
1.396     albertel 6747: 
1.795     www      6748: table#LC_helpmenu_links a:link,
                   6749: table#LC_helpmenu_links a:visited,
1.397     albertel 6750: table#LC_helpmenu_links a:active {
                   6751:   text-decoration: none;
                   6752:   color: $font;
                   6753: }
1.795     www      6754: 
1.397     albertel 6755: table#LC_helpmenu_links a:hover {
                   6756:   text-decoration: underline;
                   6757:   color: $vlink;
                   6758: }
1.396     albertel 6759: 
1.417     albertel 6760: .LC_chrt_popup_exists {
                   6761:   border: 1px solid #339933;
                   6762:   margin: -1px;
                   6763: }
1.795     www      6764: 
1.417     albertel 6765: .LC_chrt_popup_up {
                   6766:   border: 1px solid yellow;
                   6767:   margin: -1px;
                   6768: }
1.795     www      6769: 
1.417     albertel 6770: .LC_chrt_popup {
                   6771:   border: 1px solid #8888FF;
                   6772:   background: #CCCCFF;
                   6773: }
1.795     www      6774: 
1.421     albertel 6775: table.LC_pick_box {
                   6776:   border-collapse: separate;
                   6777:   background: white;
                   6778:   border: 1px solid black;
                   6779:   border-spacing: 1px;
                   6780: }
1.795     www      6781: 
1.421     albertel 6782: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6783:   background: $sidebg;
1.421     albertel 6784:   font-weight: bold;
1.900     bisitz   6785:   text-align: left;
1.740     bisitz   6786:   vertical-align: top;
1.421     albertel 6787:   width: 184px;
                   6788:   padding: 8px;
                   6789: }
1.795     www      6790: 
1.579     raeburn  6791: table.LC_pick_box td.LC_pick_box_value {
                   6792:   text-align: left;
                   6793:   padding: 8px;
                   6794: }
1.795     www      6795: 
1.579     raeburn  6796: table.LC_pick_box td.LC_pick_box_select {
                   6797:   text-align: left;
                   6798:   padding: 8px;
                   6799: }
1.795     www      6800: 
1.424     albertel 6801: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6802:   padding: 0;
1.421     albertel 6803:   height: 1px;
                   6804:   background: black;
                   6805: }
1.795     www      6806: 
1.421     albertel 6807: table.LC_pick_box td.LC_pick_box_submit {
                   6808:   text-align: right;
                   6809: }
1.795     www      6810: 
1.579     raeburn  6811: table.LC_pick_box td.LC_evenrow_value {
                   6812:   text-align: left;
                   6813:   padding: 8px;
                   6814:   background-color: $data_table_light;
                   6815: }
1.795     www      6816: 
1.579     raeburn  6817: table.LC_pick_box td.LC_oddrow_value {
                   6818:   text-align: left;
                   6819:   padding: 8px;
                   6820:   background-color: $data_table_light;
                   6821: }
1.795     www      6822: 
1.579     raeburn  6823: span.LC_helpform_receipt_cat {
                   6824:   font-weight: bold;
                   6825: }
1.795     www      6826: 
1.424     albertel 6827: table.LC_group_priv_box {
                   6828:   background: white;
                   6829:   border: 1px solid black;
                   6830:   border-spacing: 1px;
                   6831: }
1.795     www      6832: 
1.424     albertel 6833: table.LC_group_priv_box td.LC_pick_box_title {
                   6834:   background: $tabbg;
                   6835:   font-weight: bold;
                   6836:   text-align: right;
                   6837:   width: 184px;
                   6838: }
1.795     www      6839: 
1.424     albertel 6840: table.LC_group_priv_box td.LC_groups_fixed {
                   6841:   background: $data_table_light;
                   6842:   text-align: center;
                   6843: }
1.795     www      6844: 
1.424     albertel 6845: table.LC_group_priv_box td.LC_groups_optional {
                   6846:   background: $data_table_dark;
                   6847:   text-align: center;
                   6848: }
1.795     www      6849: 
1.424     albertel 6850: table.LC_group_priv_box td.LC_groups_functionality {
                   6851:   background: $data_table_darker;
                   6852:   text-align: center;
                   6853:   font-weight: bold;
                   6854: }
1.795     www      6855: 
1.424     albertel 6856: table.LC_group_priv td {
                   6857:   text-align: left;
1.803     bisitz   6858:   padding: 0;
1.424     albertel 6859: }
                   6860: 
                   6861: .LC_navbuttons {
                   6862:   margin: 2ex 0ex 2ex 0ex;
                   6863: }
1.795     www      6864: 
1.423     albertel 6865: .LC_topic_bar {
                   6866:   font-weight: bold;
                   6867:   background: $tabbg;
1.918     wenzelju 6868:   margin: 1em 0em 1em 2em;
1.805     bisitz   6869:   padding: 3px;
1.918     wenzelju 6870:   font-size: 1.2em;
1.423     albertel 6871: }
1.795     www      6872: 
1.423     albertel 6873: .LC_topic_bar span {
1.918     wenzelju 6874:   left: 0.5em;
                   6875:   position: absolute;
1.423     albertel 6876:   vertical-align: middle;
1.918     wenzelju 6877:   font-size: 1.2em;
1.423     albertel 6878: }
1.795     www      6879: 
1.423     albertel 6880: table.LC_course_group_status {
                   6881:   margin: 20px;
                   6882: }
1.795     www      6883: 
1.423     albertel 6884: table.LC_status_selector td {
                   6885:   vertical-align: top;
                   6886:   text-align: center;
1.424     albertel 6887:   padding: 4px;
                   6888: }
1.795     www      6889: 
1.599     albertel 6890: div.LC_feedback_link {
1.616     albertel 6891:   clear: both;
1.829     kalberla 6892:   background: $sidebg;
1.779     bisitz   6893:   width: 100%;
1.829     kalberla 6894:   padding-bottom: 10px;
                   6895:   border: 1px $tabbg solid;
1.833     kalberla 6896:   height: 22px;
                   6897:   line-height: 22px;
                   6898:   padding-top: 5px;
                   6899: }
                   6900: 
                   6901: div.LC_feedback_link img {
                   6902:   height: 22px;
1.867     kalberla 6903:   vertical-align:middle;
1.829     kalberla 6904: }
                   6905: 
1.911     bisitz   6906: div.LC_feedback_link a {
1.829     kalberla 6907:   text-decoration: none;
1.489     raeburn  6908: }
1.795     www      6909: 
1.867     kalberla 6910: div.LC_comblock {
1.911     bisitz   6911:   display:inline;
1.867     kalberla 6912:   color:$font;
                   6913:   font-size:90%;
                   6914: }
                   6915: 
                   6916: div.LC_feedback_link div.LC_comblock {
                   6917:   padding-left:5px;
                   6918: }
                   6919: 
                   6920: div.LC_feedback_link div.LC_comblock a {
                   6921:   color:$font;
                   6922: }
                   6923: 
1.489     raeburn  6924: span.LC_feedback_link {
1.858     bisitz   6925:   /* background: $feedback_link_bg; */
1.599     albertel 6926:   font-size: larger;
                   6927: }
1.795     www      6928: 
1.599     albertel 6929: span.LC_message_link {
1.858     bisitz   6930:   /* background: $feedback_link_bg; */
1.599     albertel 6931:   font-size: larger;
                   6932:   position: absolute;
                   6933:   right: 1em;
1.489     raeburn  6934: }
1.421     albertel 6935: 
1.515     albertel 6936: table.LC_prior_tries {
1.524     albertel 6937:   border: 1px solid #000000;
                   6938:   border-collapse: separate;
                   6939:   border-spacing: 1px;
1.515     albertel 6940: }
1.523     albertel 6941: 
1.515     albertel 6942: table.LC_prior_tries td {
1.524     albertel 6943:   padding: 2px;
1.515     albertel 6944: }
1.523     albertel 6945: 
                   6946: .LC_answer_correct {
1.795     www      6947:   background: lightgreen;
                   6948:   color: darkgreen;
                   6949:   padding: 6px;
1.523     albertel 6950: }
1.795     www      6951: 
1.523     albertel 6952: .LC_answer_charged_try {
1.797     www      6953:   background: #FFAAAA;
1.795     www      6954:   color: darkred;
                   6955:   padding: 6px;
1.523     albertel 6956: }
1.795     www      6957: 
1.779     bisitz   6958: .LC_answer_not_charged_try,
1.523     albertel 6959: .LC_answer_no_grade,
                   6960: .LC_answer_late {
1.795     www      6961:   background: lightyellow;
1.523     albertel 6962:   color: black;
1.795     www      6963:   padding: 6px;
1.523     albertel 6964: }
1.795     www      6965: 
1.523     albertel 6966: .LC_answer_previous {
1.795     www      6967:   background: lightblue;
                   6968:   color: darkblue;
                   6969:   padding: 6px;
1.523     albertel 6970: }
1.795     www      6971: 
1.779     bisitz   6972: .LC_answer_no_message {
1.777     tempelho 6973:   background: #FFFFFF;
                   6974:   color: black;
1.795     www      6975:   padding: 6px;
1.779     bisitz   6976: }
1.795     www      6977: 
1.1075.2.140  raeburn  6978: .LC_answer_unknown,
                   6979: .LC_answer_warning {
1.779     bisitz   6980:   background: orange;
                   6981:   color: black;
1.795     www      6982:   padding: 6px;
1.777     tempelho 6983: }
1.795     www      6984: 
1.529     albertel 6985: span.LC_prior_numerical,
                   6986: span.LC_prior_string,
                   6987: span.LC_prior_custom,
                   6988: span.LC_prior_reaction,
                   6989: span.LC_prior_math {
1.925     bisitz   6990:   font-family: $mono;
1.523     albertel 6991:   white-space: pre;
                   6992: }
                   6993: 
1.525     albertel 6994: span.LC_prior_string {
1.925     bisitz   6995:   font-family: $mono;
1.525     albertel 6996:   white-space: pre;
                   6997: }
                   6998: 
1.523     albertel 6999: table.LC_prior_option {
                   7000:   width: 100%;
                   7001:   border-collapse: collapse;
                   7002: }
1.795     www      7003: 
1.911     bisitz   7004: table.LC_prior_rank,
1.795     www      7005: table.LC_prior_match {
1.528     albertel 7006:   border-collapse: collapse;
                   7007: }
1.795     www      7008: 
1.528     albertel 7009: table.LC_prior_option tr td,
                   7010: table.LC_prior_rank tr td,
                   7011: table.LC_prior_match tr td {
1.524     albertel 7012:   border: 1px solid #000000;
1.515     albertel 7013: }
                   7014: 
1.855     bisitz   7015: .LC_nobreak {
1.544     albertel 7016:   white-space: nowrap;
1.519     raeburn  7017: }
                   7018: 
1.576     raeburn  7019: span.LC_cusr_emph {
                   7020:   font-style: italic;
                   7021: }
                   7022: 
1.633     raeburn  7023: span.LC_cusr_subheading {
                   7024:   font-weight: normal;
                   7025:   font-size: 85%;
                   7026: }
                   7027: 
1.861     bisitz   7028: div.LC_docs_entry_move {
1.859     bisitz   7029:   border: 1px solid #BBBBBB;
1.545     albertel 7030:   background: #DDDDDD;
1.861     bisitz   7031:   width: 22px;
1.859     bisitz   7032:   padding: 1px;
                   7033:   margin: 0;
1.545     albertel 7034: }
                   7035: 
1.861     bisitz   7036: table.LC_data_table tr > td.LC_docs_entry_commands,
                   7037: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 7038:   font-size: x-small;
                   7039: }
1.795     www      7040: 
1.861     bisitz   7041: .LC_docs_entry_parameter {
                   7042:   white-space: nowrap;
                   7043: }
                   7044: 
1.544     albertel 7045: .LC_docs_copy {
1.545     albertel 7046:   color: #000099;
1.544     albertel 7047: }
1.795     www      7048: 
1.544     albertel 7049: .LC_docs_cut {
1.545     albertel 7050:   color: #550044;
1.544     albertel 7051: }
1.795     www      7052: 
1.544     albertel 7053: .LC_docs_rename {
1.545     albertel 7054:   color: #009900;
1.544     albertel 7055: }
1.795     www      7056: 
1.544     albertel 7057: .LC_docs_remove {
1.545     albertel 7058:   color: #990000;
                   7059: }
                   7060: 
1.1075.2.134  raeburn  7061: .LC_domprefs_email,
1.547     albertel 7062: .LC_docs_reinit_warn,
                   7063: .LC_docs_ext_edit {
                   7064:   font-size: x-small;
                   7065: }
                   7066: 
1.545     albertel 7067: table.LC_docs_adddocs td,
                   7068: table.LC_docs_adddocs th {
                   7069:   border: 1px solid #BBBBBB;
                   7070:   padding: 4px;
                   7071:   background: #DDDDDD;
1.543     albertel 7072: }
                   7073: 
1.584     albertel 7074: table.LC_sty_begin {
                   7075:   background: #BBFFBB;
                   7076: }
1.795     www      7077: 
1.584     albertel 7078: table.LC_sty_end {
                   7079:   background: #FFBBBB;
                   7080: }
                   7081: 
1.589     raeburn  7082: table.LC_double_column {
1.803     bisitz   7083:   border-width: 0;
1.589     raeburn  7084:   border-collapse: collapse;
                   7085:   width: 100%;
                   7086:   padding: 2px;
                   7087: }
                   7088: 
                   7089: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  7090:   top: 2px;
1.589     raeburn  7091:   left: 2px;
                   7092:   width: 47%;
                   7093:   vertical-align: top;
                   7094: }
                   7095: 
                   7096: table.LC_double_column tr td.LC_right_col {
                   7097:   top: 2px;
1.779     bisitz   7098:   right: 2px;
1.589     raeburn  7099:   width: 47%;
                   7100:   vertical-align: top;
                   7101: }
                   7102: 
1.591     raeburn  7103: div.LC_left_float {
                   7104:   float: left;
                   7105:   padding-right: 5%;
1.597     albertel 7106:   padding-bottom: 4px;
1.591     raeburn  7107: }
                   7108: 
                   7109: div.LC_clear_float_header {
1.597     albertel 7110:   padding-bottom: 2px;
1.591     raeburn  7111: }
                   7112: 
                   7113: div.LC_clear_float_footer {
1.597     albertel 7114:   padding-top: 10px;
1.591     raeburn  7115:   clear: both;
                   7116: }
                   7117: 
1.597     albertel 7118: div.LC_grade_show_user {
1.941     bisitz   7119: /*  border-left: 5px solid $sidebg; */
                   7120:   border-top: 5px solid #000000;
                   7121:   margin: 50px 0 0 0;
1.936     bisitz   7122:   padding: 15px 0 5px 10px;
1.597     albertel 7123: }
1.795     www      7124: 
1.936     bisitz   7125: div.LC_grade_show_user_odd_row {
1.941     bisitz   7126: /*  border-left: 5px solid #000000; */
                   7127: }
                   7128: 
                   7129: div.LC_grade_show_user div.LC_Box {
                   7130:   margin-right: 50px;
1.597     albertel 7131: }
                   7132: 
                   7133: div.LC_grade_submissions,
                   7134: div.LC_grade_message_center,
1.936     bisitz   7135: div.LC_grade_info_links {
1.597     albertel 7136:   margin: 5px;
                   7137:   width: 99%;
                   7138:   background: #FFFFFF;
                   7139: }
1.795     www      7140: 
1.597     albertel 7141: div.LC_grade_submissions_header,
1.936     bisitz   7142: div.LC_grade_message_center_header {
1.705     tempelho 7143:   font-weight: bold;
                   7144:   font-size: large;
1.597     albertel 7145: }
1.795     www      7146: 
1.597     albertel 7147: div.LC_grade_submissions_body,
1.936     bisitz   7148: div.LC_grade_message_center_body {
1.597     albertel 7149:   border: 1px solid black;
                   7150:   width: 99%;
                   7151:   background: #FFFFFF;
                   7152: }
1.795     www      7153: 
1.613     albertel 7154: table.LC_scantron_action {
                   7155:   width: 100%;
                   7156: }
1.795     www      7157: 
1.613     albertel 7158: table.LC_scantron_action tr th {
1.698     harmsja  7159:   font-weight:bold;
                   7160:   font-style:normal;
1.613     albertel 7161: }
1.795     www      7162: 
1.779     bisitz   7163: .LC_edit_problem_header,
1.614     albertel 7164: div.LC_edit_problem_footer {
1.705     tempelho 7165:   font-weight: normal;
                   7166:   font-size:  medium;
1.602     albertel 7167:   margin: 2px;
1.1060    bisitz   7168:   background-color: $sidebg;
1.600     albertel 7169: }
1.795     www      7170: 
1.600     albertel 7171: div.LC_edit_problem_header,
1.602     albertel 7172: div.LC_edit_problem_header div,
1.614     albertel 7173: div.LC_edit_problem_footer,
                   7174: div.LC_edit_problem_footer div,
1.602     albertel 7175: div.LC_edit_problem_editxml_header,
                   7176: div.LC_edit_problem_editxml_header div {
1.1075.2.112  raeburn  7177:   z-index: 100;
1.600     albertel 7178: }
1.795     www      7179: 
1.600     albertel 7180: div.LC_edit_problem_header_title {
1.705     tempelho 7181:   font-weight: bold;
                   7182:   font-size: larger;
1.602     albertel 7183:   background: $tabbg;
                   7184:   padding: 3px;
1.1060    bisitz   7185:   margin: 0 0 5px 0;
1.602     albertel 7186: }
1.795     www      7187: 
1.602     albertel 7188: table.LC_edit_problem_header_title {
                   7189:   width: 100%;
1.600     albertel 7190:   background: $tabbg;
1.602     albertel 7191: }
                   7192: 
1.1075.2.112  raeburn  7193: div.LC_edit_actionbar {
                   7194:     background-color: $sidebg;
                   7195:     margin: 0;
                   7196:     padding: 0;
                   7197:     line-height: 200%;
1.602     albertel 7198: }
1.795     www      7199: 
1.1075.2.112  raeburn  7200: div.LC_edit_actionbar div{
                   7201:     padding: 0;
                   7202:     margin: 0;
                   7203:     display: inline-block;
1.600     albertel 7204: }
1.795     www      7205: 
1.1075.2.34  raeburn  7206: .LC_edit_opt {
                   7207:   padding-left: 1em;
                   7208:   white-space: nowrap;
                   7209: }
                   7210: 
1.1075.2.57  raeburn  7211: .LC_edit_problem_latexhelper{
                   7212:     text-align: right;
                   7213: }
                   7214: 
                   7215: #LC_edit_problem_colorful div{
                   7216:     margin-left: 40px;
                   7217: }
                   7218: 
1.1075.2.112  raeburn  7219: #LC_edit_problem_codemirror div{
                   7220:     margin-left: 0px;
                   7221: }
                   7222: 
1.911     bisitz   7223: img.stift {
1.803     bisitz   7224:   border-width: 0;
                   7225:   vertical-align: middle;
1.677     riegler  7226: }
1.680     riegler  7227: 
1.923     bisitz   7228: table td.LC_mainmenu_col_fieldset {
1.680     riegler  7229:   vertical-align: top;
1.777     tempelho 7230: }
1.795     www      7231: 
1.716     raeburn  7232: div.LC_createcourse {
1.911     bisitz   7233:   margin: 10px 10px 10px 10px;
1.716     raeburn  7234: }
                   7235: 
1.917     raeburn  7236: .LC_dccid {
1.1075.2.38  raeburn  7237:   float: right;
1.917     raeburn  7238:   margin: 0.2em 0 0 0;
                   7239:   padding: 0;
                   7240:   font-size: 90%;
                   7241:   display:none;
                   7242: }
                   7243: 
1.897     wenzelju 7244: ol.LC_primary_menu a:hover,
1.721     harmsja  7245: ol#LC_MenuBreadcrumbs a:hover,
                   7246: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 7247: ul#LC_secondary_menu a:hover,
1.721     harmsja  7248: .LC_FormSectionClearButton input:hover
1.795     www      7249: ul.LC_TabContent   li:hover a {
1.952     onken    7250:   color:$button_hover;
1.911     bisitz   7251:   text-decoration:none;
1.693     droeschl 7252: }
                   7253: 
1.779     bisitz   7254: h1 {
1.911     bisitz   7255:   padding: 0;
                   7256:   line-height:130%;
1.693     droeschl 7257: }
1.698     harmsja  7258: 
1.911     bisitz   7259: h2,
                   7260: h3,
                   7261: h4,
                   7262: h5,
                   7263: h6 {
                   7264:   margin: 5px 0 5px 0;
                   7265:   padding: 0;
                   7266:   line-height:130%;
1.693     droeschl 7267: }
1.795     www      7268: 
                   7269: .LC_hcell {
1.911     bisitz   7270:   padding:3px 15px 3px 15px;
                   7271:   margin: 0;
                   7272:   background-color:$tabbg;
                   7273:   color:$fontmenu;
                   7274:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 7275: }
1.795     www      7276: 
1.840     bisitz   7277: .LC_Box > .LC_hcell {
1.911     bisitz   7278:   margin: 0 -10px 10px -10px;
1.835     bisitz   7279: }
                   7280: 
1.721     harmsja  7281: .LC_noBorder {
1.911     bisitz   7282:   border: 0;
1.698     harmsja  7283: }
1.693     droeschl 7284: 
1.721     harmsja  7285: .LC_FormSectionClearButton input {
1.911     bisitz   7286:   background-color:transparent;
                   7287:   border: none;
                   7288:   cursor:pointer;
                   7289:   text-decoration:underline;
1.693     droeschl 7290: }
1.763     bisitz   7291: 
                   7292: .LC_help_open_topic {
1.911     bisitz   7293:   color: #FFFFFF;
                   7294:   background-color: #EEEEFF;
                   7295:   margin: 1px;
                   7296:   padding: 4px;
                   7297:   border: 1px solid #000033;
                   7298:   white-space: nowrap;
                   7299:   /* vertical-align: middle; */
1.759     neumanie 7300: }
1.693     droeschl 7301: 
1.911     bisitz   7302: dl,
                   7303: ul,
                   7304: div,
                   7305: fieldset {
                   7306:   margin: 10px 10px 10px 0;
                   7307:   /* overflow: hidden; */
1.693     droeschl 7308: }
1.795     www      7309: 
1.1075.2.90  raeburn  7310: article.geogebraweb div {
                   7311:     margin: 0;
                   7312: }
                   7313: 
1.838     bisitz   7314: fieldset > legend {
1.911     bisitz   7315:   font-weight: bold;
                   7316:   padding: 0 5px 0 5px;
1.838     bisitz   7317: }
                   7318: 
1.813     bisitz   7319: #LC_nav_bar {
1.911     bisitz   7320:   float: left;
1.995     raeburn  7321:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   7322:   margin: 0 0 2px 0;
1.807     droeschl 7323: }
                   7324: 
1.916     droeschl 7325: #LC_realm {
                   7326:   margin: 0.2em 0 0 0;
                   7327:   padding: 0;
                   7328:   font-weight: bold;
                   7329:   text-align: center;
1.995     raeburn  7330:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 7331: }
                   7332: 
1.911     bisitz   7333: #LC_nav_bar em {
                   7334:   font-weight: bold;
                   7335:   font-style: normal;
1.807     droeschl 7336: }
                   7337: 
1.897     wenzelju 7338: ol.LC_primary_menu {
1.934     droeschl 7339:   margin: 0;
1.1075.2.2  raeburn  7340:   padding: 0;
1.807     droeschl 7341: }
                   7342: 
1.852     droeschl 7343: ol#LC_PathBreadcrumbs {
1.911     bisitz   7344:   margin: 0;
1.693     droeschl 7345: }
                   7346: 
1.897     wenzelju 7347: ol.LC_primary_menu li {
1.1075.2.2  raeburn  7348:   color: RGB(80, 80, 80);
                   7349:   vertical-align: middle;
                   7350:   text-align: left;
                   7351:   list-style: none;
1.1075.2.112  raeburn  7352:   position: relative;
1.1075.2.2  raeburn  7353:   float: left;
1.1075.2.112  raeburn  7354:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   7355:   line-height: 1.5em;
1.1075.2.2  raeburn  7356: }
                   7357: 
1.1075.2.113  raeburn  7358: ol.LC_primary_menu li a, 
1.1075.2.112  raeburn  7359: ol.LC_primary_menu li p {
1.1075.2.2  raeburn  7360:   display: block;
                   7361:   margin: 0;
                   7362:   padding: 0 5px 0 10px;
                   7363:   text-decoration: none;
                   7364: }
                   7365: 
1.1075.2.112  raeburn  7366: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   7367:   display: inline-block;
                   7368:   width: 95%;
                   7369:   text-align: left;
                   7370: }
                   7371: 
                   7372: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   7373:   display: inline-block;
                   7374:   width: 5%;
                   7375:   float: right;
                   7376:   text-align: right;
                   7377:   font-size: 70%;
                   7378: }
                   7379: 
                   7380: ol.LC_primary_menu ul {
1.1075.2.2  raeburn  7381:   display: none;
1.1075.2.112  raeburn  7382:   width: 15em;
1.1075.2.2  raeburn  7383:   background-color: $data_table_light;
1.1075.2.112  raeburn  7384:   position: absolute;
                   7385:   top: 100%;
                   7386: }
                   7387: 
                   7388: ol.LC_primary_menu ul ul {
                   7389:   left: 100%;
                   7390:   top: 0;
1.1075.2.2  raeburn  7391: }
                   7392: 
1.1075.2.112  raeburn  7393: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2  raeburn  7394:   display: block;
                   7395:   position: absolute;
                   7396:   margin: 0;
                   7397:   padding: 0;
1.1075.2.5  raeburn  7398:   z-index: 2;
1.1075.2.2  raeburn  7399: }
                   7400: 
                   7401: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112  raeburn  7402: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2  raeburn  7403:   font-size: 90%;
1.911     bisitz   7404:   vertical-align: top;
1.1075.2.2  raeburn  7405:   float: none;
1.1075.2.5  raeburn  7406:   border-left: 1px solid black;
                   7407:   border-right: 1px solid black;
1.1075.2.112  raeburn  7408: /* A dark bottom border to visualize different menu options;
                   7409: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7410:   border-bottom: 1px solid $data_table_dark;
1.1075.2.2  raeburn  7411: }
                   7412: 
1.1075.2.112  raeburn  7413: ol.LC_primary_menu li li p:hover {
                   7414:   color:$button_hover;
                   7415:   text-decoration:none;
                   7416:   background-color:$data_table_dark;
1.1075.2.2  raeburn  7417: }
                   7418: 
                   7419: ol.LC_primary_menu li li a:hover {
                   7420:    color:$button_hover;
                   7421:    background-color:$data_table_dark;
1.693     droeschl 7422: }
                   7423: 
1.1075.2.112  raeburn  7424: /* Font-size equal to the size of the predecessors*/
                   7425: ol.LC_primary_menu li:hover li li {
                   7426:   font-size: 100%;
                   7427: }
                   7428: 
1.897     wenzelju 7429: ol.LC_primary_menu li img {
1.911     bisitz   7430:   vertical-align: bottom;
1.934     droeschl 7431:   height: 1.1em;
1.1075.2.3  raeburn  7432:   margin: 0.2em 0 0 0;
1.693     droeschl 7433: }
                   7434: 
1.897     wenzelju 7435: ol.LC_primary_menu a {
1.911     bisitz   7436:   color: RGB(80, 80, 80);
                   7437:   text-decoration: none;
1.693     droeschl 7438: }
1.795     www      7439: 
1.949     droeschl 7440: ol.LC_primary_menu a.LC_new_message {
                   7441:   font-weight:bold;
                   7442:   color: darkred;
                   7443: }
                   7444: 
1.975     raeburn  7445: ol.LC_docs_parameters {
                   7446:   margin-left: 0;
                   7447:   padding: 0;
                   7448:   list-style: none;
                   7449: }
                   7450: 
                   7451: ol.LC_docs_parameters li {
                   7452:   margin: 0;
                   7453:   padding-right: 20px;
                   7454:   display: inline;
                   7455: }
                   7456: 
1.976     raeburn  7457: ol.LC_docs_parameters li:before {
                   7458:   content: "\\002022 \\0020";
                   7459: }
                   7460: 
                   7461: li.LC_docs_parameters_title {
                   7462:   font-weight: bold;
                   7463: }
                   7464: 
                   7465: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7466:   content: "";
                   7467: }
                   7468: 
1.897     wenzelju 7469: ul#LC_secondary_menu {
1.1075.2.23  raeburn  7470:   clear: right;
1.911     bisitz   7471:   color: $fontmenu;
                   7472:   background: $tabbg;
                   7473:   list-style: none;
                   7474:   padding: 0;
                   7475:   margin: 0;
                   7476:   width: 100%;
1.995     raeburn  7477:   text-align: left;
1.1075.2.4  raeburn  7478:   float: left;
1.808     droeschl 7479: }
                   7480: 
1.897     wenzelju 7481: ul#LC_secondary_menu li {
1.911     bisitz   7482:   font-weight: bold;
                   7483:   line-height: 1.8em;
                   7484:   border-right: 1px solid black;
1.1075.2.4  raeburn  7485:   float: left;
                   7486: }
                   7487: 
                   7488: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7489:   background-color: $data_table_light;
                   7490: }
                   7491: 
                   7492: ul#LC_secondary_menu li a {
                   7493:   padding: 0 0.8em;
                   7494: }
                   7495: 
                   7496: ul#LC_secondary_menu li ul {
                   7497:   display: none;
                   7498: }
                   7499: 
                   7500: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7501:   display: block;
                   7502:   position: absolute;
                   7503:   margin: 0;
                   7504:   padding: 0;
                   7505:   list-style:none;
                   7506:   float: none;
                   7507:   background-color: $data_table_light;
1.1075.2.5  raeburn  7508:   z-index: 2;
1.1075.2.10  raeburn  7509:   margin-left: -1px;
1.1075.2.4  raeburn  7510: }
                   7511: 
                   7512: ul#LC_secondary_menu li ul li {
                   7513:   font-size: 90%;
                   7514:   vertical-align: top;
                   7515:   border-left: 1px solid black;
                   7516:   border-right: 1px solid black;
1.1075.2.33  raeburn  7517:   background-color: $data_table_light;
1.1075.2.4  raeburn  7518:   list-style:none;
                   7519:   float: none;
                   7520: }
                   7521: 
                   7522: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7523:   background-color: $data_table_dark;
1.807     droeschl 7524: }
                   7525: 
1.847     tempelho 7526: ul.LC_TabContent {
1.911     bisitz   7527:   display:block;
                   7528:   background: $sidebg;
                   7529:   border-bottom: solid 1px $lg_border_color;
                   7530:   list-style:none;
1.1020    raeburn  7531:   margin: -1px -10px 0 -10px;
1.911     bisitz   7532:   padding: 0;
1.693     droeschl 7533: }
                   7534: 
1.795     www      7535: ul.LC_TabContent li,
                   7536: ul.LC_TabContentBigger li {
1.911     bisitz   7537:   float:left;
1.741     harmsja  7538: }
1.795     www      7539: 
1.897     wenzelju 7540: ul#LC_secondary_menu li a {
1.911     bisitz   7541:   color: $fontmenu;
                   7542:   text-decoration: none;
1.693     droeschl 7543: }
1.795     www      7544: 
1.721     harmsja  7545: ul.LC_TabContent {
1.952     onken    7546:   min-height:20px;
1.721     harmsja  7547: }
1.795     www      7548: 
                   7549: ul.LC_TabContent li {
1.911     bisitz   7550:   vertical-align:middle;
1.959     onken    7551:   padding: 0 16px 0 10px;
1.911     bisitz   7552:   background-color:$tabbg;
                   7553:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7554:   border-left: solid 1px $font;
1.721     harmsja  7555: }
1.795     www      7556: 
1.847     tempelho 7557: ul.LC_TabContent .right {
1.911     bisitz   7558:   float:right;
1.847     tempelho 7559: }
                   7560: 
1.911     bisitz   7561: ul.LC_TabContent li a,
                   7562: ul.LC_TabContent li {
                   7563:   color:rgb(47,47,47);
                   7564:   text-decoration:none;
                   7565:   font-size:95%;
                   7566:   font-weight:bold;
1.952     onken    7567:   min-height:20px;
                   7568: }
                   7569: 
1.959     onken    7570: ul.LC_TabContent li a:hover,
                   7571: ul.LC_TabContent li a:focus {
1.952     onken    7572:   color: $button_hover;
1.959     onken    7573:   background:none;
                   7574:   outline:none;
1.952     onken    7575: }
                   7576: 
                   7577: ul.LC_TabContent li:hover {
                   7578:   color: $button_hover;
                   7579:   cursor:pointer;
1.721     harmsja  7580: }
1.795     www      7581: 
1.911     bisitz   7582: ul.LC_TabContent li.active {
1.952     onken    7583:   color: $font;
1.911     bisitz   7584:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7585:   border-bottom:solid 1px #FFFFFF;
                   7586:   cursor: default;
1.744     ehlerst  7587: }
1.795     www      7588: 
1.959     onken    7589: ul.LC_TabContent li.active a {
                   7590:   color:$font;
                   7591:   background:#FFFFFF;
                   7592:   outline: none;
                   7593: }
1.1047    raeburn  7594: 
                   7595: ul.LC_TabContent li.goback {
                   7596:   float: left;
                   7597:   border-left: none;
                   7598: }
                   7599: 
1.870     tempelho 7600: #maincoursedoc {
1.911     bisitz   7601:   clear:both;
1.870     tempelho 7602: }
                   7603: 
                   7604: ul.LC_TabContentBigger {
1.911     bisitz   7605:   display:block;
                   7606:   list-style:none;
                   7607:   padding: 0;
1.870     tempelho 7608: }
                   7609: 
1.795     www      7610: ul.LC_TabContentBigger li {
1.911     bisitz   7611:   vertical-align:bottom;
                   7612:   height: 30px;
                   7613:   font-size:110%;
                   7614:   font-weight:bold;
                   7615:   color: #737373;
1.841     tempelho 7616: }
                   7617: 
1.957     onken    7618: ul.LC_TabContentBigger li.active {
                   7619:   position: relative;
                   7620:   top: 1px;
                   7621: }
                   7622: 
1.870     tempelho 7623: ul.LC_TabContentBigger li a {
1.911     bisitz   7624:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7625:   height: 30px;
                   7626:   line-height: 30px;
                   7627:   text-align: center;
                   7628:   display: block;
                   7629:   text-decoration: none;
1.958     onken    7630:   outline: none;  
1.741     harmsja  7631: }
1.795     www      7632: 
1.870     tempelho 7633: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7634:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7635:   color:$font;
1.744     ehlerst  7636: }
1.795     www      7637: 
1.870     tempelho 7638: ul.LC_TabContentBigger li b {
1.911     bisitz   7639:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7640:   display: block;
                   7641:   float: left;
                   7642:   padding: 0 30px;
1.957     onken    7643:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7644: }
                   7645: 
1.956     onken    7646: ul.LC_TabContentBigger li:hover b {
                   7647:   color:$button_hover;
                   7648: }
                   7649: 
1.870     tempelho 7650: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7651:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7652:   color:$font;
1.957     onken    7653:   border: 0;
1.741     harmsja  7654: }
1.693     droeschl 7655: 
1.870     tempelho 7656: 
1.862     bisitz   7657: ul.LC_CourseBreadcrumbs {
                   7658:   background: $sidebg;
1.1020    raeburn  7659:   height: 2em;
1.862     bisitz   7660:   padding-left: 10px;
1.1020    raeburn  7661:   margin: 0;
1.862     bisitz   7662:   list-style-position: inside;
                   7663: }
                   7664: 
1.911     bisitz   7665: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7666: ol#LC_PathBreadcrumbs {
1.911     bisitz   7667:   padding-left: 10px;
                   7668:   margin: 0;
1.933     droeschl 7669:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7670: }
                   7671: 
1.911     bisitz   7672: ol#LC_MenuBreadcrumbs li,
                   7673: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7674: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7675:   display: inline;
1.933     droeschl 7676:   white-space: normal;  
1.693     droeschl 7677: }
                   7678: 
1.823     bisitz   7679: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7680: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7681:   text-decoration: none;
                   7682:   font-size:90%;
1.693     droeschl 7683: }
1.795     www      7684: 
1.969     droeschl 7685: ol#LC_MenuBreadcrumbs h1 {
                   7686:   display: inline;
                   7687:   font-size: 90%;
                   7688:   line-height: 2.5em;
                   7689:   margin: 0;
                   7690:   padding: 0;
                   7691: }
                   7692: 
1.795     www      7693: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7694:   text-decoration:none;
                   7695:   font-size:100%;
                   7696:   font-weight:bold;
1.693     droeschl 7697: }
1.795     www      7698: 
1.840     bisitz   7699: .LC_Box {
1.911     bisitz   7700:   border: solid 1px $lg_border_color;
                   7701:   padding: 0 10px 10px 10px;
1.746     neumanie 7702: }
1.795     www      7703: 
1.1020    raeburn  7704: .LC_DocsBox {
                   7705:   border: solid 1px $lg_border_color;
                   7706:   padding: 0 0 10px 10px;
                   7707: }
                   7708: 
1.795     www      7709: .LC_AboutMe_Image {
1.911     bisitz   7710:   float:left;
                   7711:   margin-right:10px;
1.747     neumanie 7712: }
1.795     www      7713: 
                   7714: .LC_Clear_AboutMe_Image {
1.911     bisitz   7715:   clear:left;
1.747     neumanie 7716: }
1.795     www      7717: 
1.721     harmsja  7718: dl.LC_ListStyleClean dt {
1.911     bisitz   7719:   padding-right: 5px;
                   7720:   display: table-header-group;
1.693     droeschl 7721: }
                   7722: 
1.721     harmsja  7723: dl.LC_ListStyleClean dd {
1.911     bisitz   7724:   display: table-row;
1.693     droeschl 7725: }
                   7726: 
1.721     harmsja  7727: .LC_ListStyleClean,
                   7728: .LC_ListStyleSimple,
                   7729: .LC_ListStyleNormal,
1.795     www      7730: .LC_ListStyleSpecial {
1.911     bisitz   7731:   /* display:block; */
                   7732:   list-style-position: inside;
                   7733:   list-style-type: none;
                   7734:   overflow: hidden;
                   7735:   padding: 0;
1.693     droeschl 7736: }
                   7737: 
1.721     harmsja  7738: .LC_ListStyleSimple li,
                   7739: .LC_ListStyleSimple dd,
                   7740: .LC_ListStyleNormal li,
                   7741: .LC_ListStyleNormal dd,
                   7742: .LC_ListStyleSpecial li,
1.795     www      7743: .LC_ListStyleSpecial dd {
1.911     bisitz   7744:   margin: 0;
                   7745:   padding: 5px 5px 5px 10px;
                   7746:   clear: both;
1.693     droeschl 7747: }
                   7748: 
1.721     harmsja  7749: .LC_ListStyleClean li,
                   7750: .LC_ListStyleClean dd {
1.911     bisitz   7751:   padding-top: 0;
                   7752:   padding-bottom: 0;
1.693     droeschl 7753: }
                   7754: 
1.721     harmsja  7755: .LC_ListStyleSimple dd,
1.795     www      7756: .LC_ListStyleSimple li {
1.911     bisitz   7757:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 7758: }
                   7759: 
1.721     harmsja  7760: .LC_ListStyleSpecial li,
                   7761: .LC_ListStyleSpecial dd {
1.911     bisitz   7762:   list-style-type: none;
                   7763:   background-color: RGB(220, 220, 220);
                   7764:   margin-bottom: 4px;
1.693     droeschl 7765: }
                   7766: 
1.721     harmsja  7767: table.LC_SimpleTable {
1.911     bisitz   7768:   margin:5px;
                   7769:   border:solid 1px $lg_border_color;
1.795     www      7770: }
1.693     droeschl 7771: 
1.721     harmsja  7772: table.LC_SimpleTable tr {
1.911     bisitz   7773:   padding: 0;
                   7774:   border:solid 1px $lg_border_color;
1.693     droeschl 7775: }
1.795     www      7776: 
                   7777: table.LC_SimpleTable thead {
1.911     bisitz   7778:   background:rgb(220,220,220);
1.693     droeschl 7779: }
                   7780: 
1.721     harmsja  7781: div.LC_columnSection {
1.911     bisitz   7782:   display: block;
                   7783:   clear: both;
                   7784:   overflow: hidden;
                   7785:   margin: 0;
1.693     droeschl 7786: }
                   7787: 
1.721     harmsja  7788: div.LC_columnSection>* {
1.911     bisitz   7789:   float: left;
                   7790:   margin: 10px 20px 10px 0;
                   7791:   overflow:hidden;
1.693     droeschl 7792: }
1.721     harmsja  7793: 
1.795     www      7794: table em {
1.911     bisitz   7795:   font-weight: bold;
                   7796:   font-style: normal;
1.748     schulted 7797: }
1.795     www      7798: 
1.779     bisitz   7799: table.LC_tableBrowseRes,
1.795     www      7800: table.LC_tableOfContent {
1.911     bisitz   7801:   border:none;
                   7802:   border-spacing: 1px;
                   7803:   padding: 3px;
                   7804:   background-color: #FFFFFF;
                   7805:   font-size: 90%;
1.753     droeschl 7806: }
1.789     droeschl 7807: 
1.911     bisitz   7808: table.LC_tableOfContent {
                   7809:   border-collapse: collapse;
1.789     droeschl 7810: }
                   7811: 
1.771     droeschl 7812: table.LC_tableBrowseRes a,
1.768     schulted 7813: table.LC_tableOfContent a {
1.911     bisitz   7814:   background-color: transparent;
                   7815:   text-decoration: none;
1.753     droeschl 7816: }
                   7817: 
1.795     www      7818: table.LC_tableOfContent img {
1.911     bisitz   7819:   border: none;
                   7820:   height: 1.3em;
                   7821:   vertical-align: text-bottom;
                   7822:   margin-right: 0.3em;
1.753     droeschl 7823: }
1.757     schulted 7824: 
1.795     www      7825: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7826:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7827: }
                   7828: 
1.795     www      7829: a#LC_content_toolbar_everything {
1.911     bisitz   7830:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7831: }
                   7832: 
1.795     www      7833: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7834:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7835: }
                   7836: 
1.795     www      7837: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7838:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7839: }
                   7840: 
1.795     www      7841: a#LC_content_toolbar_changefolder {
1.911     bisitz   7842:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7843: }
                   7844: 
1.795     www      7845: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7846:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7847: }
                   7848: 
1.1043    raeburn  7849: a#LC_content_toolbar_edittoplevel {
                   7850:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7851: }
                   7852: 
1.795     www      7853: ul#LC_toolbar li a:hover {
1.911     bisitz   7854:   background-position: bottom center;
1.757     schulted 7855: }
                   7856: 
1.795     www      7857: ul#LC_toolbar {
1.911     bisitz   7858:   padding: 0;
                   7859:   margin: 2px;
                   7860:   list-style:none;
                   7861:   position:relative;
                   7862:   background-color:white;
1.1075.2.9  raeburn  7863:   overflow: auto;
1.757     schulted 7864: }
                   7865: 
1.795     www      7866: ul#LC_toolbar li {
1.911     bisitz   7867:   border:1px solid white;
                   7868:   padding: 0;
                   7869:   margin: 0;
                   7870:   float: left;
                   7871:   display:inline;
                   7872:   vertical-align:middle;
1.1075.2.9  raeburn  7873:   white-space: nowrap;
1.911     bisitz   7874: }
1.757     schulted 7875: 
1.783     amueller 7876: 
1.795     www      7877: a.LC_toolbarItem {
1.911     bisitz   7878:   display:block;
                   7879:   padding: 0;
                   7880:   margin: 0;
                   7881:   height: 32px;
                   7882:   width: 32px;
                   7883:   color:white;
                   7884:   border: none;
                   7885:   background-repeat:no-repeat;
                   7886:   background-color:transparent;
1.757     schulted 7887: }
                   7888: 
1.915     droeschl 7889: ul.LC_funclist {
                   7890:     margin: 0;
                   7891:     padding: 0.5em 1em 0.5em 0;
                   7892: }
                   7893: 
1.933     droeschl 7894: ul.LC_funclist > li:first-child {
                   7895:     font-weight:bold; 
                   7896:     margin-left:0.8em;
                   7897: }
                   7898: 
1.915     droeschl 7899: ul.LC_funclist + ul.LC_funclist {
                   7900:     /* 
                   7901:        left border as a seperator if we have more than
                   7902:        one list 
                   7903:     */
                   7904:     border-left: 1px solid $sidebg;
                   7905:     /* 
                   7906:        this hides the left border behind the border of the 
                   7907:        outer box if element is wrapped to the next 'line' 
                   7908:     */
                   7909:     margin-left: -1px;
                   7910: }
                   7911: 
1.843     bisitz   7912: ul.LC_funclist li {
1.915     droeschl 7913:   display: inline;
1.782     bisitz   7914:   white-space: nowrap;
1.915     droeschl 7915:   margin: 0 0 0 25px;
                   7916:   line-height: 150%;
1.782     bisitz   7917: }
                   7918: 
1.974     wenzelju 7919: .LC_hidden {
                   7920:   display: none;
                   7921: }
                   7922: 
1.1030    www      7923: .LCmodal-overlay {
                   7924: 		position:fixed;
                   7925: 		top:0;
                   7926: 		right:0;
                   7927: 		bottom:0;
                   7928: 		left:0;
                   7929: 		height:100%;
                   7930: 		width:100%;
                   7931: 		margin:0;
                   7932: 		padding:0;
                   7933: 		background:#999;
                   7934: 		opacity:.75;
                   7935: 		filter: alpha(opacity=75);
                   7936: 		-moz-opacity: 0.75;
                   7937: 		z-index:101;
                   7938: }
                   7939: 
                   7940: * html .LCmodal-overlay {   
                   7941: 		position: absolute;
                   7942: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7943: }
                   7944: 
                   7945: .LCmodal-window {
                   7946: 		position:fixed;
                   7947: 		top:50%;
                   7948: 		left:50%;
                   7949: 		margin:0;
                   7950: 		padding:0;
                   7951: 		z-index:102;
                   7952: 	}
                   7953: 
                   7954: * html .LCmodal-window {
                   7955: 		position:absolute;
                   7956: }
                   7957: 
                   7958: .LCclose-window {
                   7959: 		position:absolute;
                   7960: 		width:32px;
                   7961: 		height:32px;
                   7962: 		right:8px;
                   7963: 		top:8px;
                   7964: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   7965: 		text-indent:-99999px;
                   7966: 		overflow:hidden;
                   7967: 		cursor:pointer;
                   7968: }
                   7969: 
1.1075.2.158  raeburn  7970: .LCisDisabled {
                   7971:   cursor: not-allowed;
                   7972:   opacity: 0.5;
                   7973: }
                   7974: 
                   7975: a[aria-disabled="true"] {
                   7976:   color: currentColor;
                   7977:   display: inline-block;  /* For IE11/ MS Edge bug */
                   7978:   pointer-events: none;
                   7979:   text-decoration: none;
                   7980: }
                   7981: 
1.1075.2.141  raeburn  7982: pre.LC_wordwrap {
                   7983:   white-space: pre-wrap;
                   7984:   white-space: -moz-pre-wrap;
                   7985:   white-space: -pre-wrap;
                   7986:   white-space: -o-pre-wrap;
                   7987:   word-wrap: break-word;
                   7988: }
                   7989: 
1.1075.2.17  raeburn  7990: /*
                   7991:   styles used by TTH when "Default set of options to pass to tth/m
                   7992:   when converting TeX" in course settings has been set
                   7993: 
                   7994:   option passed: -t
                   7995: 
                   7996: */
                   7997: 
                   7998: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   7999: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   8000: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   8001: td div.norm {line-height:normal;}
                   8002: 
                   8003: /*
                   8004:   option passed -y3
                   8005: */
                   8006: 
                   8007: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   8008: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   8009: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   8010: 
1.1075.2.121  raeburn  8011: #LC_minitab_header {
                   8012:   float:left;
                   8013:   width:100%;
                   8014:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   8015:   font-size:93%;
                   8016:   line-height:normal;
                   8017:   margin: 0.5em 0 0.5em 0;
                   8018: }
                   8019: #LC_minitab_header ul {
                   8020:   margin:0;
                   8021:   padding:10px 10px 0;
                   8022:   list-style:none;
                   8023: }
                   8024: #LC_minitab_header li {
                   8025:   float:left;
                   8026:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   8027:   margin:0;
                   8028:   padding:0 0 0 9px;
                   8029: }
                   8030: #LC_minitab_header a {
                   8031:   display:block;
                   8032:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   8033:   padding:5px 15px 4px 6px;
                   8034: }
                   8035: #LC_minitab_header #LC_current_minitab {
                   8036:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   8037: }
                   8038: #LC_minitab_header #LC_current_minitab a {
                   8039:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   8040:   padding-bottom:5px;
                   8041: }
                   8042: 
                   8043: 
1.343     albertel 8044: END
                   8045: }
                   8046: 
1.306     albertel 8047: =pod
                   8048: 
                   8049: =item * &headtag()
                   8050: 
                   8051: Returns a uniform footer for LON-CAPA web pages.
                   8052: 
1.307     albertel 8053: Inputs: $title - optional title for the head
                   8054:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 8055:         $args - optional arguments
1.319     albertel 8056:             force_register - if is true call registerurl so the remote is 
                   8057:                              informed
1.415     albertel 8058:             redirect       -> array ref of
                   8059:                                    1- seconds before redirect occurs
                   8060:                                    2- url to redirect to
                   8061:                                    3- whether the side effect should occur
1.315     albertel 8062:                            (side effect of setting 
                   8063:                                $env{'internal.head.redirect'} to the url 
                   8064:                                redirected too)
1.1075.2.166  raeburn  8065:                                    4- whether encrypt check should be skipped
1.352     albertel 8066:             domain         -> force to color decorate a page for a specific
                   8067:                                domain
                   8068:             function       -> force usage of a specific rolish color scheme
                   8069:             bgcolor        -> override the default page bgcolor
1.460     albertel 8070:             no_auto_mt_title
                   8071:                            -> prevent &mt()ing the title arg
1.464     albertel 8072: 
1.306     albertel 8073: =cut
                   8074: 
                   8075: sub headtag {
1.313     albertel 8076:     my ($title,$head_extra,$args) = @_;
1.306     albertel 8077:     
1.363     albertel 8078:     my $function = $args->{'function'} || &get_users_function();
                   8079:     my $domain   = $args->{'domain'}   || &determinedomain();
                   8080:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1075.2.52  raeburn  8081:     my $httphost = $args->{'use_absolute'};
1.418     albertel 8082:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 8083: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 8084: 		   #time(),
1.418     albertel 8085: 		   $env{'environment.color.timestamp'},
1.363     albertel 8086: 		   $function,$domain,$bgcolor);
                   8087: 
1.369     www      8088:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 8089: 
1.308     albertel 8090:     my $result =
                   8091: 	'<head>'.
1.1075.2.56  raeburn  8092: 	&font_settings($args);
1.319     albertel 8093: 
1.1075.2.72  raeburn  8094:     my $inhibitprint;
                   8095:     if ($args->{'print_suppress'}) {
                   8096:         $inhibitprint = &print_suppression();
                   8097:     }
1.1064    raeburn  8098: 
1.461     albertel 8099:     if (!$args->{'frameset'}) {
                   8100: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   8101:     }
1.1075.2.12  raeburn  8102:     if ($args->{'force_register'}) {
                   8103:         $result .= &Apache::lonmenu::registerurl(1);
1.319     albertel 8104:     }
1.436     albertel 8105:     if (!$args->{'no_nav_bar'} 
                   8106: 	&& !$args->{'only_body'}
                   8107: 	&& !$args->{'frameset'}) {
1.1075.2.52  raeburn  8108: 	$result .= &help_menu_js($httphost);
1.1032    www      8109:         $result.=&modal_window();
1.1038    www      8110:         $result.=&togglebox_script();
1.1034    www      8111:         $result.=&wishlist_window();
1.1041    www      8112:         $result.=&LCprogressbarUpdate_script();
1.1034    www      8113:     } else {
                   8114:         if ($args->{'add_modal'}) {
                   8115:            $result.=&modal_window();
                   8116:         }
                   8117:         if ($args->{'add_wishlist'}) {
                   8118:            $result.=&wishlist_window();
                   8119:         }
1.1038    www      8120:         if ($args->{'add_togglebox'}) {
                   8121:            $result.=&togglebox_script();
                   8122:         }
1.1041    www      8123:         if ($args->{'add_progressbar'}) {
                   8124:            $result.=&LCprogressbarUpdate_script();
                   8125:         }
1.436     albertel 8126:     }
1.314     albertel 8127:     if (ref($args->{'redirect'})) {
1.1075.2.166  raeburn  8128: 	my ($time,$url,$inhibit_continue,$skip_enc_check) = @{$args->{'redirect'}};
                   8129:         if (!$skip_enc_check) {
                   8130:             $url = &Apache::lonenc::check_encrypt($url);
                   8131:         }
1.414     albertel 8132: 	if (!$inhibit_continue) {
                   8133: 	    $env{'internal.head.redirect'} = $url;
                   8134: 	}
1.313     albertel 8135: 	$result.=<<ADDMETA
                   8136: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 8137: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 8138: ADDMETA
1.1075.2.89  raeburn  8139:     } else {
                   8140:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   8141:             my $requrl = $env{'request.uri'};
                   8142:             if ($requrl eq '') {
                   8143:                 $requrl = $ENV{'REQUEST_URI'};
                   8144:                 $requrl =~ s/\?.+$//;
                   8145:             }
                   8146:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   8147:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   8148:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   8149:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   8150:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   8151:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1075.2.145  raeburn  8152:                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1075.2.151  raeburn  8153:                     my ($offload,$offloadoth);
1.1075.2.89  raeburn  8154:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   8155:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1075.2.145  raeburn  8156:                             $offload = 1;
1.1075.2.151  raeburn  8157:                             if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8158:                                 (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8159:                                 unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8160:                                     $offloadoth = 1;
                   8161:                                     $dom_in_use = $env{'user.domain'};
                   8162:                                 }
                   8163:                             }
1.1075.2.145  raeburn  8164:                         }
                   8165:                     }
                   8166:                     unless ($offload) {
                   8167:                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   8168:                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   8169:                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8170:                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8171:                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8172:                                         $offload = 1;
1.1075.2.151  raeburn  8173:                                         $offloadoth = 1;
1.1075.2.145  raeburn  8174:                                         $dom_in_use = $env{'user.domain'};
                   8175:                                     }
1.1075.2.89  raeburn  8176:                                 }
1.1075.2.145  raeburn  8177:                             }
                   8178:                         }
                   8179:                     }
                   8180:                     if ($offload) {
1.1075.2.158  raeburn  8181:                         my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1075.2.151  raeburn  8182:                         if (($newserver eq '') && ($offloadoth)) {
                   8183:                             my @domains = &Apache::lonnet::current_machine_domains();
                   8184:                             if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) { 
                   8185:                                 ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
                   8186:                             }
                   8187:                         }
1.1075.2.145  raeburn  8188:                         if (($newserver) && ($newserver ne $lonhost)) {
                   8189:                             my $numsec = 5;
                   8190:                             my $timeout = $numsec * 1000;
                   8191:                             my ($newurl,$locknum,%locks,$msg);
                   8192:                             if ($env{'request.role.adv'}) {
                   8193:                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   8194:                             }
                   8195:                             my $disable_submit = 0;
                   8196:                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   8197:                                 $disable_submit = 1;
                   8198:                             }
                   8199:                             if ($locknum) {
                   8200:                                 my @lockinfo = sort(values(%locks));
1.1075.2.153  raeburn  8201:                                 $msg = &mt('Once the following tasks are complete:')." \n".
1.1075.2.145  raeburn  8202:                                        join(", ",sort(values(%locks)))."\n";
                   8203:                                 if (&show_course()) {
                   8204:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
1.1075.2.89  raeburn  8205:                                 } else {
1.1075.2.145  raeburn  8206:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
                   8207:                                 }
                   8208:                             } else {
                   8209:                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   8210:                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   8211:                                 }
                   8212:                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   8213:                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   8214:                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   8215:                                     $newurl .= '&role='.$env{'request.role'};
                   8216:                                 }
                   8217:                                 if ($env{'request.symb'}) {
                   8218:                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   8219:                                     if ($shownsymb =~ m{^/enc/}) {
                   8220:                                         my $reqdmajor = 2;
                   8221:                                         my $reqdminor = 11;
                   8222:                                         my $reqdsubminor = 3;
                   8223:                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   8224:                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   8225:                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   8226:                                         if (($major eq '' && $minor eq '') ||
                   8227:                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   8228:                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   8229:                                              ($reqdsubminor > $subminor))))) {
                   8230:                                             undef($shownsymb);
                   8231:                                         }
1.1075.2.89  raeburn  8232:                                     }
1.1075.2.145  raeburn  8233:                                     if ($shownsymb) {
                   8234:                                         &js_escape(\$shownsymb);
                   8235:                                         $newurl .= '&symb='.$shownsymb;
1.1075.2.89  raeburn  8236:                                     }
1.1075.2.145  raeburn  8237:                                 } else {
                   8238:                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   8239:                                     &js_escape(\$shownurl);
                   8240:                                     $newurl .= '&origurl='.$shownurl;
1.1075.2.89  raeburn  8241:                                 }
1.1075.2.145  raeburn  8242:                             }
                   8243:                             &js_escape(\$msg);
                   8244:                             $result.=<<OFFLOAD
1.1075.2.89  raeburn  8245: <meta http-equiv="pragma" content="no-cache" />
                   8246: <script type="text/javascript">
1.1075.2.92  raeburn  8247: // <![CDATA[
1.1075.2.89  raeburn  8248: function LC_Offload_Now() {
                   8249:     var dest = "$newurl";
                   8250:     if (dest != '') {
                   8251:         window.location.href="$newurl";
                   8252:     }
                   8253: }
1.1075.2.92  raeburn  8254: \$(document).ready(function () {
                   8255:     window.alert('$msg');
                   8256:     if ($disable_submit) {
1.1075.2.89  raeburn  8257:         \$(".LC_hwk_submit").prop("disabled", true);
                   8258:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92  raeburn  8259:     }
                   8260:     setTimeout('LC_Offload_Now()', $timeout);
                   8261: });
                   8262: // ]]>
1.1075.2.89  raeburn  8263: </script>
                   8264: OFFLOAD
                   8265:                         }
                   8266:                     }
                   8267:                 }
                   8268:             }
                   8269:         }
1.313     albertel 8270:     }
1.306     albertel 8271:     if (!defined($title)) {
                   8272: 	$title = 'The LearningOnline Network with CAPA';
                   8273:     }
1.460     albertel 8274:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1075.2.168  raeburn  8275:     if ($title =~ /^LON-CAPA\s+/) {
                   8276:         $result .= '<title> '.$title.'</title>';
                   8277:     } else {
                   8278:         $result .= '<title> LON-CAPA '.$title.'</title>';
                   8279:     }
                   8280:     $result .= "\n".'<link rel="stylesheet" type="text/css" href="'.$url.'"';
1.1075.2.61  raeburn  8281:     if (!$args->{'frameset'}) {
                   8282:         $result .= ' /';
                   8283:     }
                   8284:     $result .= '>'
1.1064    raeburn  8285:         .$inhibitprint
1.414     albertel 8286: 	.$head_extra;
1.1075.2.108  raeburn  8287:     my $clientmobile;
                   8288:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   8289:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   8290:     } else {
                   8291:         $clientmobile = $env{'browser.mobile'};
                   8292:     }
                   8293:     if ($clientmobile) {
1.1075.2.42  raeburn  8294:         $result .= '
                   8295: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   8296: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   8297:     }
1.1075.2.126  raeburn  8298:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 8299:     return $result.'</head>';
1.306     albertel 8300: }
                   8301: 
                   8302: =pod
                   8303: 
1.340     albertel 8304: =item * &font_settings()
                   8305: 
                   8306: Returns neccessary <meta> to set the proper encoding
                   8307: 
1.1075.2.56  raeburn  8308: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 8309: 
                   8310: =cut
                   8311: 
                   8312: sub font_settings {
1.1075.2.56  raeburn  8313:     my ($args) = @_;
1.340     albertel 8314:     my $headerstring='';
1.1075.2.56  raeburn  8315:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   8316:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340     albertel 8317: 	$headerstring.=
1.1075.2.61  raeburn  8318: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   8319:         if (!$args->{'frameset'}) {
                   8320:             $headerstring.= ' /';
                   8321:         }
                   8322:         $headerstring .= '>'."\n";
1.340     albertel 8323:     }
                   8324:     return $headerstring;
                   8325: }
                   8326: 
1.341     albertel 8327: =pod
                   8328: 
1.1064    raeburn  8329: =item * &print_suppression()
                   8330: 
                   8331: In course context returns css which causes the body to be blank when media="print",
                   8332: if printout generation is unavailable for the current resource.
                   8333: 
                   8334: This could be because:
                   8335: 
                   8336: (a) printstartdate is in the future
                   8337: 
                   8338: (b) printenddate is in the past
                   8339: 
                   8340: (c) there is an active exam block with "printout"
                   8341: functionality blocked
                   8342: 
                   8343: Users with pav, pfo or evb privileges are exempt.
                   8344: 
                   8345: Inputs: none
                   8346: 
                   8347: =cut
                   8348: 
                   8349: 
                   8350: sub print_suppression {
                   8351:     my $noprint;
                   8352:     if ($env{'request.course.id'}) {
                   8353:         my $scope = $env{'request.course.id'};
                   8354:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8355:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   8356:             return;
                   8357:         }
                   8358:         if ($env{'request.course.sec'} ne '') {
                   8359:             $scope .= "/$env{'request.course.sec'}";
                   8360:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8361:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  8362:                 return;
1.1064    raeburn  8363:             }
                   8364:         }
                   8365:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8366:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.158  raeburn  8367:         my $clientip = &Apache::lonnet::get_requestor_ip();
                   8368:         my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064    raeburn  8369:         if ($blocked) {
                   8370:             my $checkrole = "cm./$cdom/$cnum";
                   8371:             if ($env{'request.course.sec'} ne '') {
                   8372:                 $checkrole .= "/$env{'request.course.sec'}";
                   8373:             }
                   8374:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   8375:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   8376:                 $noprint = 1;
                   8377:             }
                   8378:         }
                   8379:         unless ($noprint) {
                   8380:             my $symb = &Apache::lonnet::symbread();
                   8381:             if ($symb ne '') {
                   8382:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   8383:                 if (ref($navmap)) {
                   8384:                     my $res = $navmap->getBySymb($symb);
                   8385:                     if (ref($res)) {
                   8386:                         if (!$res->resprintable()) {
                   8387:                             $noprint = 1;
                   8388:                         }
                   8389:                     }
                   8390:                 }
                   8391:             }
                   8392:         }
                   8393:         if ($noprint) {
                   8394:             return <<"ENDSTYLE";
                   8395: <style type="text/css" media="print">
                   8396:     body { display:none }
                   8397: </style>
                   8398: ENDSTYLE
                   8399:         }
                   8400:     }
                   8401:     return;
                   8402: }
                   8403: 
                   8404: =pod
                   8405: 
1.341     albertel 8406: =item * &xml_begin()
                   8407: 
                   8408: Returns the needed doctype and <html>
                   8409: 
                   8410: Inputs: none
                   8411: 
                   8412: =cut
                   8413: 
                   8414: sub xml_begin {
1.1075.2.61  raeburn  8415:     my ($is_frameset) = @_;
1.341     albertel 8416:     my $output='';
                   8417: 
                   8418:     if ($env{'browser.mathml'}) {
                   8419: 	$output='<?xml version="1.0"?>'
                   8420:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   8421: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   8422:             
                   8423: #	    .'<!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">] >'
                   8424: 	    .'<!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">'
                   8425:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   8426: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61  raeburn  8427:     } elsif ($is_frameset) {
                   8428:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   8429:                 '<html>'."\n";
1.341     albertel 8430:     } else {
1.1075.2.61  raeburn  8431: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   8432:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 8433:     }
                   8434:     return $output;
                   8435: }
1.340     albertel 8436: 
                   8437: =pod
                   8438: 
1.306     albertel 8439: =item * &start_page()
                   8440: 
                   8441: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   8442: 
1.648     raeburn  8443: Inputs:
                   8444: 
                   8445: =over 4
                   8446: 
                   8447: $title - optional title for the page
                   8448: 
                   8449: $head_extra - optional extra HTML to incude inside the <head>
                   8450: 
                   8451: $args - additional optional args supported are:
                   8452: 
                   8453: =over 8
                   8454: 
                   8455:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 8456:                                     arg on
1.814     bisitz   8457:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  8458:              add_entries    -> additional attributes to add to the  <body>
                   8459:              domain         -> force to color decorate a page for a 
1.317     albertel 8460:                                     specific domain
1.648     raeburn  8461:              function       -> force usage of a specific rolish color
1.317     albertel 8462:                                     scheme
1.648     raeburn  8463:              redirect       -> see &headtag()
                   8464:              bgcolor        -> override the default page bg color
                   8465:              js_ready       -> return a string ready for being used in 
1.317     albertel 8466:                                     a javascript writeln
1.648     raeburn  8467:              html_encode    -> return a string ready for being used in 
1.320     albertel 8468:                                     a html attribute
1.648     raeburn  8469:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 8470:                                     $forcereg arg
1.648     raeburn  8471:              frameset       -> if true will start with a <frameset>
1.330     albertel 8472:                                     rather than <body>
1.648     raeburn  8473:              skip_phases    -> hash ref of 
1.338     albertel 8474:                                     head -> skip the <html><head> generation
                   8475:                                     body -> skip all <body> generation
1.1075.2.12  raeburn  8476:              no_inline_link -> if true and in remote mode, don't show the
                   8477:                                     'Switch To Inline Menu' link
1.648     raeburn  8478:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 8479:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  8480:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1075.2.123  raeburn  8481:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   8482:                                     to lonhtmlcommon::breadcrumbs
1.1075.2.15  raeburn  8483:              group          -> includes the current group, if page is for a
                   8484:                                specific group
1.1075.2.133  raeburn  8485:              use_absolute   -> for request for external resource or syllabus, this
                   8486:                                will contain https://<hostname> if server uses
                   8487:                                https (as per hosts.tab), but request is for http
                   8488:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.1075.2.158  raeburn  8489:              links_disabled -> Links in primary and secondary menus are disabled
                   8490:                                (Can enable them once page has loaded - see lonroles.pm
                   8491:                                for an example).
1.361     albertel 8492: 
1.648     raeburn  8493: =back
1.460     albertel 8494: 
1.648     raeburn  8495: =back
1.562     albertel 8496: 
1.306     albertel 8497: =cut
                   8498: 
                   8499: sub start_page {
1.309     albertel 8500:     my ($title,$head_extra,$args) = @_;
1.318     albertel 8501:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 8502: 
1.315     albertel 8503:     $env{'internal.start_page'}++;
1.1075.2.15  raeburn  8504:     my ($result,@advtools);
1.964     droeschl 8505: 
1.338     albertel 8506:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62  raeburn  8507:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 8508:     }
                   8509:     
                   8510:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   8511: 	if ($args->{'frameset'}) {
                   8512: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   8513: 						$args->{'add_entries'});
                   8514: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8515:         } else {
                   8516:             $result .=
                   8517:                 &bodytag($title, 
                   8518:                          $args->{'function'},       $args->{'add_entries'},
                   8519:                          $args->{'only_body'},      $args->{'domain'},
                   8520:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12  raeburn  8521:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
1.1075.2.15  raeburn  8522:                          $args,                     \@advtools);
1.831     bisitz   8523:         }
1.330     albertel 8524:     }
1.338     albertel 8525: 
1.315     albertel 8526:     if ($args->{'js_ready'}) {
1.713     kaisler  8527: 		$result = &js_ready($result);
1.315     albertel 8528:     }
1.320     albertel 8529:     if ($args->{'html_encode'}) {
1.713     kaisler  8530: 		$result = &html_encode($result);
                   8531:     }
                   8532: 
1.813     bisitz   8533:     # Preparation for new and consistent functionlist at top of screen
                   8534:     # if ($args->{'functionlist'}) {
                   8535:     #            $result .= &build_functionlist();
                   8536:     #}
                   8537: 
1.964     droeschl 8538:     # Don't add anything more if only_body wanted or in const space
                   8539:     return $result if    $args->{'only_body'} 
                   8540:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8541: 
                   8542:     #Breadcrumbs
1.758     kaisler  8543:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   8544: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8545: 		#if any br links exists, add them to the breadcrumbs
                   8546: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8547: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8548: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8549: 			}
                   8550: 		}
1.1075.2.19  raeburn  8551:                 # if @advtools array contains items add then to the breadcrumbs
                   8552:                 if (@advtools > 0) {
                   8553:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8554:                 }
1.1075.2.123  raeburn  8555:                 my $menulink;
                   8556:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   8557:                 if (exists($args->{'bread_crumbs_nomenu'})) {
                   8558:                     $menulink = 0;
                   8559:                 } else {
                   8560:                     undef($menulink);
                   8561:                 }
1.758     kaisler  8562: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8563: 		if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123  raeburn  8564: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.758     kaisler  8565: 		}else{
1.1075.2.123  raeburn  8566: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  8567: 		}
1.1075.2.24  raeburn  8568:     } elsif (($env{'environment.remote'} eq 'on') &&
                   8569:              ($env{'form.inhibitmenu'} ne 'yes') &&
                   8570:              ($env{'request.noversionuri'} =~ m{^/res/}) &&
                   8571:              ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21  raeburn  8572:         $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320     albertel 8573:     }
1.315     albertel 8574:     return $result;
1.306     albertel 8575: }
                   8576: 
                   8577: sub end_page {
1.315     albertel 8578:     my ($args) = @_;
                   8579:     $env{'internal.end_page'}++;
1.330     albertel 8580:     my $result;
1.335     albertel 8581:     if ($args->{'discussion'}) {
                   8582: 	my ($target,$parser);
                   8583: 	if (ref($args->{'discussion'})) {
                   8584: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8585: 				$args->{'discussion'}{'parser'});
                   8586: 	}
                   8587: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8588:     }
1.330     albertel 8589:     if ($args->{'frameset'}) {
                   8590: 	$result .= '</frameset>';
                   8591:     } else {
1.635     raeburn  8592: 	$result .= &endbodytag($args);
1.330     albertel 8593:     }
1.1075.2.6  raeburn  8594:     unless ($args->{'notbody'}) {
                   8595:         $result .= "\n</html>";
                   8596:     }
1.330     albertel 8597: 
1.315     albertel 8598:     if ($args->{'js_ready'}) {
1.317     albertel 8599: 	$result = &js_ready($result);
1.315     albertel 8600:     }
1.335     albertel 8601: 
1.320     albertel 8602:     if ($args->{'html_encode'}) {
                   8603: 	$result = &html_encode($result);
                   8604:     }
1.335     albertel 8605: 
1.315     albertel 8606:     return $result;
                   8607: }
                   8608: 
1.1034    www      8609: sub wishlist_window {
                   8610:     return(<<'ENDWISHLIST');
1.1046    raeburn  8611: <script type="text/javascript">
1.1034    www      8612: // <![CDATA[
                   8613: // <!-- BEGIN LON-CAPA Internal
                   8614: function set_wishlistlink(title, path) {
                   8615:     if (!title) {
                   8616:         title = document.title;
                   8617:         title = title.replace(/^LON-CAPA /,'');
                   8618:     }
1.1075.2.65  raeburn  8619:     title = encodeURIComponent(title);
1.1075.2.83  raeburn  8620:     title = title.replace("'","\\\'");
1.1034    www      8621:     if (!path) {
                   8622:         path = location.pathname;
                   8623:     }
1.1075.2.65  raeburn  8624:     path = encodeURIComponent(path);
1.1075.2.83  raeburn  8625:     path = path.replace("'","\\\'");
1.1034    www      8626:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   8627:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   8628: }
                   8629: // END LON-CAPA Internal -->
                   8630: // ]]>
                   8631: </script>
                   8632: ENDWISHLIST
                   8633: }
                   8634: 
1.1030    www      8635: sub modal_window {
                   8636:     return(<<'ENDMODAL');
1.1046    raeburn  8637: <script type="text/javascript">
1.1030    www      8638: // <![CDATA[
                   8639: // <!-- BEGIN LON-CAPA Internal
                   8640: var modalWindow = {
                   8641: 	parent:"body",
                   8642: 	windowId:null,
                   8643: 	content:null,
                   8644: 	width:null,
                   8645: 	height:null,
                   8646: 	close:function()
                   8647: 	{
                   8648: 	        $(".LCmodal-window").remove();
                   8649: 	        $(".LCmodal-overlay").remove();
                   8650: 	},
                   8651: 	open:function()
                   8652: 	{
                   8653: 		var modal = "";
                   8654: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   8655: 		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;\">";
                   8656: 		modal += this.content;
                   8657: 		modal += "</div>";	
                   8658: 
                   8659: 		$(this.parent).append(modal);
                   8660: 
                   8661: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   8662: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   8663: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   8664: 	}
                   8665: };
1.1075.2.42  raeburn  8666: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      8667: 	{
1.1075.2.119  raeburn  8668:                 source = source.replace(/'/g,"&#39;");
1.1030    www      8669: 		modalWindow.windowId = "myModal";
                   8670: 		modalWindow.width = width;
                   8671: 		modalWindow.height = height;
1.1075.2.80  raeburn  8672: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      8673: 		modalWindow.open();
1.1075.2.87  raeburn  8674: 	};
1.1030    www      8675: // END LON-CAPA Internal -->
                   8676: // ]]>
                   8677: </script>
                   8678: ENDMODAL
                   8679: }
                   8680: 
                   8681: sub modal_link {
1.1075.2.42  raeburn  8682:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      8683:     unless ($width) { $width=480; }
                   8684:     unless ($height) { $height=400; }
1.1031    www      8685:     unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42  raeburn  8686:     unless ($transparency) { $transparency='true'; }
                   8687: 
1.1074    raeburn  8688:     my $target_attr;
                   8689:     if (defined($target)) {
                   8690:         $target_attr = 'target="'.$target.'"';
                   8691:     }
                   8692:     return <<"ENDLINK";
1.1075.2.143  raeburn  8693: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  8694: ENDLINK
1.1030    www      8695: }
                   8696: 
1.1032    www      8697: sub modal_adhoc_script {
1.1075.2.155  raeburn  8698:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
                   8699:     my $mathjax;
                   8700:     if ($possmathjax) {
                   8701:         $mathjax = <<'ENDJAX';
                   8702:                if (typeof MathJax == 'object') {
                   8703:                    MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
                   8704:                }
                   8705: ENDJAX
                   8706:     }
1.1032    www      8707:     return (<<ENDADHOC);
1.1046    raeburn  8708: <script type="text/javascript">
1.1032    www      8709: // <![CDATA[
                   8710:         var $funcname = function()
                   8711:         {
                   8712:                 modalWindow.windowId = "myModal";
                   8713:                 modalWindow.width = $width;
                   8714:                 modalWindow.height = $height;
                   8715:                 modalWindow.content = '$content';
                   8716:                 modalWindow.open();
1.1075.2.155  raeburn  8717:                 $mathjax
1.1032    www      8718:         };  
                   8719: // ]]>
                   8720: </script>
                   8721: ENDADHOC
                   8722: }
                   8723: 
1.1041    www      8724: sub modal_adhoc_inner {
1.1075.2.155  raeburn  8725:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041    www      8726:     my $innerwidth=$width-20;
                   8727:     $content=&js_ready(
1.1042    www      8728:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  8729:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8730:                  $content.
1.1041    www      8731:                  &end_scrollbox().
1.1075.2.42  raeburn  8732:                  &end_page()
1.1041    www      8733:              );
1.1075.2.155  raeburn  8734:     return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041    www      8735: }
                   8736: 
                   8737: sub modal_adhoc_window {
1.1075.2.155  raeburn  8738:     my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
                   8739:     return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041    www      8740:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8741: }
                   8742: 
                   8743: sub modal_adhoc_launch {
                   8744:     my ($funcname,$width,$height,$content)=@_;
                   8745:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8746: <script type="text/javascript">
                   8747: // <![CDATA[
                   8748: $funcname();
                   8749: // ]]>
                   8750: </script>
                   8751: ENDLAUNCH
                   8752: }
                   8753: 
                   8754: sub modal_adhoc_close {
                   8755:     return (<<ENDCLOSE);
                   8756: <script type="text/javascript">
                   8757: // <![CDATA[
                   8758: modalWindow.close();
                   8759: // ]]>
                   8760: </script>
                   8761: ENDCLOSE
                   8762: }
                   8763: 
1.1038    www      8764: sub togglebox_script {
                   8765:    return(<<ENDTOGGLE);
                   8766: <script type="text/javascript"> 
                   8767: // <![CDATA[
                   8768: function LCtoggleDisplay(id,hidetext,showtext) {
                   8769:    link = document.getElementById(id + "link").childNodes[0];
                   8770:    with (document.getElementById(id).style) {
                   8771:       if (display == "none" ) {
                   8772:           display = "inline";
                   8773:           link.nodeValue = hidetext;
                   8774:         } else {
                   8775:           display = "none";
                   8776:           link.nodeValue = showtext;
                   8777:        }
                   8778:    }
                   8779: }
                   8780: // ]]>
                   8781: </script>
                   8782: ENDTOGGLE
                   8783: }
                   8784: 
1.1039    www      8785: sub start_togglebox {
                   8786:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   8787:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   8788:     unless ($showtext) { $showtext=&mt('show'); }
                   8789:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   8790:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   8791:     return &start_data_table().
                   8792:            &start_data_table_header_row().
                   8793:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   8794:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   8795:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   8796:            &end_data_table_header_row().
                   8797:            '<tr id="'.$id.'" style="display:none""><td>';
                   8798: }
                   8799: 
                   8800: sub end_togglebox {
                   8801:     return '</td></tr>'.&end_data_table();
                   8802: }
                   8803: 
1.1041    www      8804: sub LCprogressbar_script {
1.1075.2.130  raeburn  8805:    my ($id,$number_to_do)=@_;
                   8806:    if ($number_to_do) {
                   8807:        return(<<ENDPROGRESS);
1.1041    www      8808: <script type="text/javascript">
                   8809: // <![CDATA[
1.1045    www      8810: \$('#progressbar$id').progressbar({
1.1041    www      8811:   value: 0,
                   8812:   change: function(event, ui) {
                   8813:     var newVal = \$(this).progressbar('option', 'value');
                   8814:     \$('.pblabel', this).text(LCprogressTxt);
                   8815:   }
                   8816: });
                   8817: // ]]>
                   8818: </script>
                   8819: ENDPROGRESS
1.1075.2.130  raeburn  8820:    } else {
                   8821:        return(<<ENDPROGRESS);
                   8822: <script type="text/javascript">
                   8823: // <![CDATA[
                   8824: \$('#progressbar$id').progressbar({
                   8825:   value: false,
                   8826:   create: function(event, ui) {
                   8827:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   8828:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   8829:   }
                   8830: });
                   8831: // ]]>
                   8832: </script>
                   8833: ENDPROGRESS
                   8834:    }
1.1041    www      8835: }
                   8836: 
                   8837: sub LCprogressbarUpdate_script {
                   8838:    return(<<ENDPROGRESSUPDATE);
                   8839: <style type="text/css">
                   8840: .ui-progressbar { position:relative; }
1.1075.2.130  raeburn  8841: .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      8842: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   8843: </style>
                   8844: <script type="text/javascript">
                   8845: // <![CDATA[
1.1045    www      8846: var LCprogressTxt='---';
                   8847: 
1.1075.2.130  raeburn  8848: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      8849:    LCprogressTxt=progresstext;
1.1075.2.130  raeburn  8850:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   8851:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   8852:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
                   8853:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   8854:    } else {
                   8855:        \$('#progressbar'+id).progressbar('value',percent);
                   8856:    }
1.1041    www      8857: }
                   8858: // ]]>
                   8859: </script>
                   8860: ENDPROGRESSUPDATE
                   8861: }
                   8862: 
1.1042    www      8863: my $LClastpercent;
1.1045    www      8864: my $LCidcnt;
                   8865: my $LCcurrentid;
1.1042    www      8866: 
1.1041    www      8867: sub LCprogressbar {
1.1075.2.130  raeburn  8868:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      8869:     $LClastpercent=0;
1.1045    www      8870:     $LCidcnt++;
                   8871:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130  raeburn  8872:     my ($starting,$content);
                   8873:     if ($number_to_do) {
                   8874:         $starting=&mt('Starting');
                   8875:         $content=(<<ENDPROGBAR);
                   8876: $preamble
1.1045    www      8877:   <div id="progressbar$LCcurrentid">
1.1041    www      8878:     <span class="pblabel">$starting</span>
                   8879:   </div>
                   8880: ENDPROGBAR
1.1075.2.130  raeburn  8881:     } else {
                   8882:         $starting=&mt('Loading...');
                   8883:         $LClastpercent='false';
                   8884:         $content=(<<ENDPROGBAR);
                   8885: $preamble
                   8886:   <div id="progressbar$LCcurrentid">
                   8887:       <div class="progress-label">$starting</div>
                   8888:   </div>
                   8889: ENDPROGBAR
                   8890:     }
                   8891:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      8892: }
                   8893: 
                   8894: sub LCprogressbarUpdate {
1.1075.2.130  raeburn  8895:     my ($r,$val,$text,$number_to_do)=@_;
                   8896:     if ($number_to_do) {
                   8897:         unless ($val) { 
                   8898:             if ($LClastpercent) {
                   8899:                 $val=$LClastpercent;
                   8900:             } else {
                   8901:                 $val=0;
                   8902:             }
                   8903:         }
                   8904:         if ($val<0) { $val=0; }
                   8905:         if ($val>100) { $val=0; }
                   8906:         $LClastpercent=$val;
                   8907:         unless ($text) { $text=$val.'%'; }
                   8908:     } else {
                   8909:         $val = 'false';
1.1042    www      8910:     }
1.1041    www      8911:     $text=&js_ready($text);
1.1044    www      8912:     &r_print($r,<<ENDUPDATE);
1.1041    www      8913: <script type="text/javascript">
                   8914: // <![CDATA[
1.1075.2.130  raeburn  8915: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      8916: // ]]>
                   8917: </script>
                   8918: ENDUPDATE
1.1035    www      8919: }
                   8920: 
1.1042    www      8921: sub LCprogressbarClose {
                   8922:     my ($r)=@_;
                   8923:     $LClastpercent=0;
1.1044    www      8924:     &r_print($r,<<ENDCLOSE);
1.1042    www      8925: <script type="text/javascript">
                   8926: // <![CDATA[
1.1045    www      8927: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      8928: // ]]>
                   8929: </script>
                   8930: ENDCLOSE
1.1044    www      8931: }
                   8932: 
                   8933: sub r_print {
                   8934:     my ($r,$to_print)=@_;
                   8935:     if ($r) {
                   8936:       $r->print($to_print);
                   8937:       $r->rflush();
                   8938:     } else {
                   8939:       print($to_print);
                   8940:     }
1.1042    www      8941: }
                   8942: 
1.320     albertel 8943: sub html_encode {
                   8944:     my ($result) = @_;
                   8945: 
1.322     albertel 8946:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 8947:     
                   8948:     return $result;
                   8949: }
1.1044    www      8950: 
1.317     albertel 8951: sub js_ready {
                   8952:     my ($result) = @_;
                   8953: 
1.323     albertel 8954:     $result =~ s/[\n\r]/ /xmsg;
                   8955:     $result =~ s/\\/\\\\/xmsg;
                   8956:     $result =~ s/'/\\'/xmsg;
1.372     albertel 8957:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 8958:     
                   8959:     return $result;
                   8960: }
                   8961: 
1.315     albertel 8962: sub validate_page {
                   8963:     if (  exists($env{'internal.start_page'})
1.316     albertel 8964: 	  &&     $env{'internal.start_page'} > 1) {
                   8965: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 8966: 				 $env{'internal.start_page'}.' '.
1.316     albertel 8967: 				 $ENV{'request.filename'});
1.315     albertel 8968:     }
                   8969:     if (  exists($env{'internal.end_page'})
1.316     albertel 8970: 	  &&     $env{'internal.end_page'} > 1) {
                   8971: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 8972: 				 $env{'internal.end_page'}.' '.
1.316     albertel 8973: 				 $env{'request.filename'});
1.315     albertel 8974:     }
                   8975:     if (     exists($env{'internal.start_page'})
                   8976: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 8977: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   8978: 				 $env{'request.filename'});
1.315     albertel 8979:     }
                   8980:     if (   ! exists($env{'internal.start_page'})
                   8981: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 8982: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   8983: 				 $env{'request.filename'});
1.315     albertel 8984:     }
1.306     albertel 8985: }
1.315     albertel 8986: 
1.996     www      8987: 
                   8988: sub start_scrollbox {
1.1075.2.56  raeburn  8989:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  8990:     unless ($outerwidth) { $outerwidth='520px'; }
                   8991:     unless ($width) { $width='500px'; }
                   8992:     unless ($height) { $height='200px'; }
1.1075    raeburn  8993:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  8994:     if ($id ne '') {
1.1075.2.42  raeburn  8995:         $table_id = ' id="table_'.$id.'"';
                   8996:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  8997:     }
1.1075    raeburn  8998:     if ($bgcolor ne '') {
                   8999:         $tdcol = "background-color: $bgcolor;";
                   9000:     }
1.1075.2.42  raeburn  9001:     my $nicescroll_js;
                   9002:     if ($env{'browser.mobile'}) {
                   9003:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   9004:     }
1.1075    raeburn  9005:     return <<"END";
1.1075.2.42  raeburn  9006: $nicescroll_js
                   9007: 
                   9008: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  9009: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  9010: END
1.996     www      9011: }
                   9012: 
                   9013: sub end_scrollbox {
1.1036    www      9014:     return '</div></td></tr></table>';
1.996     www      9015: }
                   9016: 
1.1075.2.42  raeburn  9017: sub nicescroll_javascript {
                   9018:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   9019:     my %options;
                   9020:     if (ref($cursor) eq 'HASH') {
                   9021:         %options = %{$cursor};
                   9022:     }
                   9023:     unless ($options{'railalign'} =~ /^left|right$/) {
                   9024:         $options{'railalign'} = 'left';
                   9025:     }
                   9026:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9027:         my $function  = &get_users_function();
                   9028:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   9029:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9030:             $options{'cursorcolor'} = '#00F';
                   9031:         }
                   9032:     }
                   9033:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   9034:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   9035:             $options{'cursoropacity'}='1.0';
                   9036:         }
                   9037:     } else {
                   9038:         $options{'cursoropacity'}='1.0';
                   9039:     }
                   9040:     if ($options{'cursorfixedheight'} eq 'none') {
                   9041:         delete($options{'cursorfixedheight'});
                   9042:     } else {
                   9043:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   9044:     }
                   9045:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   9046:         delete($options{'railoffset'});
                   9047:     }
                   9048:     my @niceoptions;
                   9049:     while (my($key,$value) = each(%options)) {
                   9050:         if ($value =~ /^\{.+\}$/) {
                   9051:             push(@niceoptions,$key.':'.$value);
                   9052:         } else {
                   9053:             push(@niceoptions,$key.':"'.$value.'"');
                   9054:         }
                   9055:     }
                   9056:     my $nicescroll_js = '
                   9057: $(document).ready(
                   9058:       function() {
                   9059:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   9060:       }
                   9061: );
                   9062: ';
                   9063:     if ($framecheck) {
                   9064:         $nicescroll_js .= '
                   9065: function expand_div(caller) {
                   9066:     if (top === self) {
                   9067:         document.getElementById("'.$id.'").style.width = "auto";
                   9068:         document.getElementById("'.$id.'").style.height = "auto";
                   9069:     } else {
                   9070:         try {
                   9071:             if (parent.frames) {
                   9072:                 if (parent.frames.length > 1) {
                   9073:                     var framesrc = parent.frames[1].location.href;
                   9074:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   9075:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   9076:                         document.getElementById("'.$id.'").style.width = "auto";
                   9077:                         document.getElementById("'.$id.'").style.height = "auto";
                   9078:                     }
                   9079:                 }
                   9080:             }
                   9081:         } catch (e) {
                   9082:             return;
                   9083:         }
                   9084:     }
                   9085:     return;
                   9086: }
                   9087: ';
                   9088:     }
                   9089:     if ($needjsready) {
                   9090:         $nicescroll_js = '
                   9091: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   9092:     } else {
                   9093:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   9094:     }
                   9095:     return $nicescroll_js;
                   9096: }
                   9097: 
1.318     albertel 9098: sub simple_error_page {
1.1075.2.49  raeburn  9099:     my ($r,$title,$msg,$args) = @_;
                   9100:     if (ref($args) eq 'HASH') {
                   9101:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   9102:     } else {
                   9103:         $msg = &mt($msg);
                   9104:     }
                   9105: 
1.318     albertel 9106:     my $page =
                   9107: 	&Apache::loncommon::start_page($title).
1.1075.2.49  raeburn  9108: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 9109: 	&Apache::loncommon::end_page();
                   9110:     if (ref($r)) {
                   9111: 	$r->print($page);
1.327     albertel 9112: 	return;
1.318     albertel 9113:     }
                   9114:     return $page;
                   9115: }
1.347     albertel 9116: 
                   9117: {
1.610     albertel 9118:     my @row_count;
1.961     onken    9119: 
                   9120:     sub start_data_table_count {
                   9121:         unshift(@row_count, 0);
                   9122:         return;
                   9123:     }
                   9124: 
                   9125:     sub end_data_table_count {
                   9126:         shift(@row_count);
                   9127:         return;
                   9128:     }
                   9129: 
1.347     albertel 9130:     sub start_data_table {
1.1018    raeburn  9131: 	my ($add_class,$id) = @_;
1.422     albertel 9132: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  9133:         my $table_id;
                   9134:         if (defined($id)) {
                   9135:             $table_id = ' id="'.$id.'"';
                   9136:         }
1.961     onken    9137: 	&start_data_table_count();
1.1018    raeburn  9138: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 9139:     }
                   9140: 
                   9141:     sub end_data_table {
1.961     onken    9142: 	&end_data_table_count();
1.389     albertel 9143: 	return '</table>'."\n";;
1.347     albertel 9144:     }
                   9145: 
                   9146:     sub start_data_table_row {
1.974     wenzelju 9147: 	my ($add_class, $id) = @_;
1.610     albertel 9148: 	$row_count[0]++;
                   9149: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   9150: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 9151:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9152:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 9153:     }
1.471     banghart 9154:     
                   9155:     sub continue_data_table_row {
1.974     wenzelju 9156: 	my ($add_class, $id) = @_;
1.610     albertel 9157: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 9158: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   9159:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9160:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 9161:     }
1.347     albertel 9162: 
                   9163:     sub end_data_table_row {
1.389     albertel 9164: 	return '</tr>'."\n";;
1.347     albertel 9165:     }
1.367     www      9166: 
1.421     albertel 9167:     sub start_data_table_empty_row {
1.707     bisitz   9168: #	$row_count[0]++;
1.421     albertel 9169: 	return  '<tr class="LC_empty_row" >'."\n";;
                   9170:     }
                   9171: 
                   9172:     sub end_data_table_empty_row {
                   9173: 	return '</tr>'."\n";;
                   9174:     }
                   9175: 
1.367     www      9176:     sub start_data_table_header_row {
1.389     albertel 9177: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      9178:     }
                   9179: 
                   9180:     sub end_data_table_header_row {
1.389     albertel 9181: 	return '</tr>'."\n";;
1.367     www      9182:     }
1.890     droeschl 9183: 
                   9184:     sub data_table_caption {
                   9185:         my $caption = shift;
                   9186:         return "<caption class=\"LC_caption\">$caption</caption>";
                   9187:     }
1.347     albertel 9188: }
                   9189: 
1.548     albertel 9190: =pod
                   9191: 
                   9192: =item * &inhibit_menu_check($arg)
                   9193: 
                   9194: Checks for a inhibitmenu state and generates output to preserve it
                   9195: 
                   9196: Inputs:         $arg - can be any of
                   9197:                      - undef - in which case the return value is a string 
                   9198:                                to add  into arguments list of a uri
                   9199:                      - 'input' - in which case the return value is a HTML
                   9200:                                  <form> <input> field of type hidden to
                   9201:                                  preserve the value
                   9202:                      - a url - in which case the return value is the url with
                   9203:                                the neccesary cgi args added to preserve the
                   9204:                                inhibitmenu state
                   9205:                      - a ref to a url - no return value, but the string is
                   9206:                                         updated to include the neccessary cgi
                   9207:                                         args to preserve the inhibitmenu state
                   9208: 
                   9209: =cut
                   9210: 
                   9211: sub inhibit_menu_check {
                   9212:     my ($arg) = @_;
                   9213:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   9214:     if ($arg eq 'input') {
                   9215: 	if ($env{'form.inhibitmenu'}) {
                   9216: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   9217: 	} else {
                   9218: 	    return
                   9219: 	}
                   9220:     }
                   9221:     if ($env{'form.inhibitmenu'}) {
                   9222: 	if (ref($arg)) {
                   9223: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9224: 	} elsif ($arg eq '') {
                   9225: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   9226: 	} else {
                   9227: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9228: 	}
                   9229:     }
                   9230:     if (!ref($arg)) {
                   9231: 	return $arg;
                   9232:     }
                   9233: }
                   9234: 
1.251     albertel 9235: ###############################################
1.182     matthew  9236: 
                   9237: =pod
                   9238: 
1.549     albertel 9239: =back
                   9240: 
                   9241: =head1 User Information Routines
                   9242: 
                   9243: =over 4
                   9244: 
1.405     albertel 9245: =item * &get_users_function()
1.182     matthew  9246: 
                   9247: Used by &bodytag to determine the current users primary role.
                   9248: Returns either 'student','coordinator','admin', or 'author'.
                   9249: 
                   9250: =cut
                   9251: 
                   9252: ###############################################
                   9253: sub get_users_function {
1.815     tempelho 9254:     my $function = 'norole';
1.818     tempelho 9255:     if ($env{'request.role'}=~/^(st)/) {
                   9256:         $function='student';
                   9257:     }
1.907     raeburn  9258:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  9259:         $function='coordinator';
                   9260:     }
1.258     albertel 9261:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  9262:         $function='admin';
                   9263:     }
1.826     bisitz   9264:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  9265:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  9266:         $function='author';
                   9267:     }
                   9268:     return $function;
1.54      www      9269: }
1.99      www      9270: 
                   9271: ###############################################
                   9272: 
1.233     raeburn  9273: =pod
                   9274: 
1.821     raeburn  9275: =item * &show_course()
                   9276: 
                   9277: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   9278: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   9279: 
                   9280: Inputs:
                   9281: None
                   9282: 
                   9283: Outputs:
                   9284: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   9285: 
                   9286: =cut
                   9287: 
                   9288: ###############################################
                   9289: sub show_course {
                   9290:     my $course = !$env{'user.adv'};
                   9291:     if (!$env{'user.adv'}) {
                   9292:         foreach my $env (keys(%env)) {
                   9293:             next if ($env !~ m/^user\.priv\./);
                   9294:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   9295:                 $course = 0;
                   9296:                 last;
                   9297:             }
                   9298:         }
                   9299:     }
                   9300:     return $course;
                   9301: }
                   9302: 
                   9303: ###############################################
                   9304: 
                   9305: =pod
                   9306: 
1.542     raeburn  9307: =item * &check_user_status()
1.274     raeburn  9308: 
                   9309: Determines current status of supplied role for a
                   9310: specific user. Roles can be active, previous or future.
                   9311: 
                   9312: Inputs: 
                   9313: user's domain, user's username, course's domain,
1.375     raeburn  9314: course's number, optional section ID.
1.274     raeburn  9315: 
                   9316: Outputs:
                   9317: role status: active, previous or future. 
                   9318: 
                   9319: =cut
                   9320: 
                   9321: sub check_user_status {
1.412     raeburn  9322:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  9323:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  9324:     my @uroles = keys(%userinfo);
1.274     raeburn  9325:     my $srchstr;
                   9326:     my $active_chk = 'none';
1.412     raeburn  9327:     my $now = time;
1.274     raeburn  9328:     if (@uroles > 0) {
1.908     raeburn  9329:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  9330:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   9331:         } else {
1.412     raeburn  9332:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   9333:         }
                   9334:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  9335:             my $role_end = 0;
                   9336:             my $role_start = 0;
                   9337:             $active_chk = 'active';
1.412     raeburn  9338:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   9339:                 $role_end = $1;
                   9340:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   9341:                     $role_start = $1;
1.274     raeburn  9342:                 }
                   9343:             }
                   9344:             if ($role_start > 0) {
1.412     raeburn  9345:                 if ($now < $role_start) {
1.274     raeburn  9346:                     $active_chk = 'future';
                   9347:                 }
                   9348:             }
                   9349:             if ($role_end > 0) {
1.412     raeburn  9350:                 if ($now > $role_end) {
1.274     raeburn  9351:                     $active_chk = 'previous';
                   9352:                 }
                   9353:             }
                   9354:         }
                   9355:     }
                   9356:     return $active_chk;
                   9357: }
                   9358: 
                   9359: ###############################################
                   9360: 
                   9361: =pod
                   9362: 
1.405     albertel 9363: =item * &get_sections()
1.233     raeburn  9364: 
                   9365: Determines all the sections for a course including
                   9366: sections with students and sections containing other roles.
1.419     raeburn  9367: Incoming parameters: 
                   9368: 
                   9369: 1. domain
                   9370: 2. course number 
                   9371: 3. reference to array containing roles for which sections should 
                   9372: be gathered (optional).
                   9373: 4. reference to array containing status types for which sections 
                   9374: should be gathered (optional).
                   9375: 
                   9376: If the third argument is undefined, sections are gathered for any role. 
                   9377: If the fourth argument is undefined, sections are gathered for any status.
                   9378: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  9379:  
1.374     raeburn  9380: Returns section hash (keys are section IDs, values are
                   9381: number of users in each section), subject to the
1.419     raeburn  9382: optional roles filter, optional status filter 
1.233     raeburn  9383: 
                   9384: =cut
                   9385: 
                   9386: ###############################################
                   9387: sub get_sections {
1.419     raeburn  9388:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 9389:     if (!defined($cdom) || !defined($cnum)) {
                   9390:         my $cid =  $env{'request.course.id'};
                   9391: 
                   9392: 	return if (!defined($cid));
                   9393: 
                   9394:         $cdom = $env{'course.'.$cid.'.domain'};
                   9395:         $cnum = $env{'course.'.$cid.'.num'};
                   9396:     }
                   9397: 
                   9398:     my %sectioncount;
1.419     raeburn  9399:     my $now = time;
1.240     albertel 9400: 
1.1075.2.33  raeburn  9401:     my $check_students = 1;
                   9402:     my $only_students = 0;
                   9403:     if (ref($possible_roles) eq 'ARRAY') {
                   9404:         if (grep(/^st$/,@{$possible_roles})) {
                   9405:             if (@{$possible_roles} == 1) {
                   9406:                 $only_students = 1;
                   9407:             }
                   9408:         } else {
                   9409:             $check_students = 0;
                   9410:         }
                   9411:     }
                   9412: 
                   9413:     if ($check_students) {
1.276     albertel 9414: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 9415: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   9416: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  9417:         my $start_index = &Apache::loncoursedata::CL_START();
                   9418:         my $end_index = &Apache::loncoursedata::CL_END();
                   9419:         my $status;
1.366     albertel 9420: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  9421: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   9422: 				                     $data->[$status_index],
                   9423:                                                      $data->[$start_index],
                   9424:                                                      $data->[$end_index]);
                   9425:             if ($stu_status eq 'Active') {
                   9426:                 $status = 'active';
                   9427:             } elsif ($end < $now) {
                   9428:                 $status = 'previous';
                   9429:             } elsif ($start > $now) {
                   9430:                 $status = 'future';
                   9431:             } 
                   9432: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   9433:                 if ((!defined($possible_status)) || (($status ne '') && 
                   9434:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   9435: 		    $sectioncount{$section}++;
                   9436:                 }
1.240     albertel 9437: 	    }
                   9438: 	}
                   9439:     }
1.1075.2.33  raeburn  9440:     if ($only_students) {
                   9441:         return %sectioncount;
                   9442:     }
1.240     albertel 9443:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9444:     foreach my $user (sort(keys(%courseroles))) {
                   9445: 	if ($user !~ /^(\w{2})/) { next; }
                   9446: 	my ($role) = ($user =~ /^(\w{2})/);
                   9447: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9448: 	my ($section,$status);
1.240     albertel 9449: 	if ($role eq 'cr' &&
                   9450: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9451: 	    $section=$1;
                   9452: 	}
                   9453: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9454: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9455:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9456:         if ($end == -1 && $start == -1) {
                   9457:             next; #deleted role
                   9458:         }
                   9459:         if (!defined($possible_status)) { 
                   9460:             $sectioncount{$section}++;
                   9461:         } else {
                   9462:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9463:                 $status = 'active';
                   9464:             } elsif ($end < $now) {
                   9465:                 $status = 'future';
                   9466:             } elsif ($start > $now) {
                   9467:                 $status = 'previous';
                   9468:             }
                   9469:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9470:                 $sectioncount{$section}++;
                   9471:             }
                   9472:         }
1.233     raeburn  9473:     }
1.366     albertel 9474:     return %sectioncount;
1.233     raeburn  9475: }
                   9476: 
1.274     raeburn  9477: ###############################################
1.294     raeburn  9478: 
                   9479: =pod
1.405     albertel 9480: 
                   9481: =item * &get_course_users()
                   9482: 
1.275     raeburn  9483: Retrieves usernames:domains for users in the specified course
                   9484: with specific role(s), and access status. 
                   9485: 
                   9486: Incoming parameters:
1.277     albertel 9487: 1. course domain
                   9488: 2. course number
                   9489: 3. access status: users must have - either active, 
1.275     raeburn  9490: previous, future, or all.
1.277     albertel 9491: 4. reference to array of permissible roles
1.288     raeburn  9492: 5. reference to array of section restrictions (optional)
                   9493: 6. reference to results object (hash of hashes).
                   9494: 7. reference to optional userdata hash
1.609     raeburn  9495: 8. reference to optional statushash
1.630     raeburn  9496: 9. flag if privileged users (except those set to unhide in
                   9497:    course settings) should be excluded    
1.609     raeburn  9498: Keys of top level results hash are roles.
1.275     raeburn  9499: Keys of inner hashes are username:domain, with 
                   9500: values set to access type.
1.288     raeburn  9501: Optional userdata hash returns an array with arguments in the 
                   9502: same order as loncoursedata::get_classlist() for student data.
                   9503: 
1.609     raeburn  9504: Optional statushash returns
                   9505: 
1.288     raeburn  9506: Entries for end, start, section and status are blank because
                   9507: of the possibility of multiple values for non-student roles.
                   9508: 
1.275     raeburn  9509: =cut
1.405     albertel 9510: 
1.275     raeburn  9511: ###############################################
1.405     albertel 9512: 
1.275     raeburn  9513: sub get_course_users {
1.630     raeburn  9514:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  9515:     my %idx = ();
1.419     raeburn  9516:     my %seclists;
1.288     raeburn  9517: 
                   9518:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   9519:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   9520:     $idx{end} = &Apache::loncoursedata::CL_END();
                   9521:     $idx{start} = &Apache::loncoursedata::CL_START();
                   9522:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   9523:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   9524:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   9525:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   9526: 
1.290     albertel 9527:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 9528:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  9529:         my $now = time;
1.277     albertel 9530:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  9531:             my $match = 0;
1.412     raeburn  9532:             my $secmatch = 0;
1.419     raeburn  9533:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  9534:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  9535:             if ($section eq '') {
                   9536:                 $section = 'none';
                   9537:             }
1.291     albertel 9538:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9539:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9540:                     $secmatch = 1;
                   9541:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 9542:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9543:                         $secmatch = 1;
                   9544:                     }
                   9545:                 } else {  
1.419     raeburn  9546: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  9547: 		        $secmatch = 1;
                   9548:                     }
1.290     albertel 9549: 		}
1.412     raeburn  9550:                 if (!$secmatch) {
                   9551:                     next;
                   9552:                 }
1.419     raeburn  9553:             }
1.275     raeburn  9554:             if (defined($$types{'active'})) {
1.288     raeburn  9555:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  9556:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  9557:                     $match = 1;
1.275     raeburn  9558:                 }
                   9559:             }
                   9560:             if (defined($$types{'previous'})) {
1.609     raeburn  9561:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  9562:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  9563:                     $match = 1;
1.275     raeburn  9564:                 }
                   9565:             }
                   9566:             if (defined($$types{'future'})) {
1.609     raeburn  9567:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  9568:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  9569:                     $match = 1;
1.275     raeburn  9570:                 }
                   9571:             }
1.609     raeburn  9572:             if ($match) {
                   9573:                 push(@{$seclists{$student}},$section);
                   9574:                 if (ref($userdata) eq 'HASH') {
                   9575:                     $$userdata{$student} = $$classlist{$student};
                   9576:                 }
                   9577:                 if (ref($statushash) eq 'HASH') {
                   9578:                     $statushash->{$student}{'st'}{$section} = $status;
                   9579:                 }
1.288     raeburn  9580:             }
1.275     raeburn  9581:         }
                   9582:     }
1.412     raeburn  9583:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9584:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9585:         my $now = time;
1.609     raeburn  9586:         my %displaystatus = ( previous => 'Expired',
                   9587:                               active   => 'Active',
                   9588:                               future   => 'Future',
                   9589:                             );
1.1075.2.36  raeburn  9590:         my (%nothide,@possdoms);
1.630     raeburn  9591:         if ($hidepriv) {
                   9592:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9593:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9594:                 if ($user !~ /:/) {
                   9595:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9596:                 } else {
                   9597:                     $nothide{$user} = 1;
                   9598:                 }
                   9599:             }
1.1075.2.36  raeburn  9600:             my @possdoms = ($cdom);
                   9601:             if ($coursehash{'checkforpriv'}) {
                   9602:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9603:             }
1.630     raeburn  9604:         }
1.439     raeburn  9605:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9606:             my $match = 0;
1.412     raeburn  9607:             my $secmatch = 0;
1.439     raeburn  9608:             my $status;
1.412     raeburn  9609:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9610:             $user =~ s/:$//;
1.439     raeburn  9611:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9612:             if ($end == -1 || $start == -1) {
                   9613:                 next;
                   9614:             }
                   9615:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9616:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9617:                 my ($uname,$udom) = split(/:/,$user);
                   9618:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9619:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9620:                         $secmatch = 1;
                   9621:                     } elsif ($usec eq '') {
1.420     albertel 9622:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9623:                             $secmatch = 1;
                   9624:                         }
                   9625:                     } else {
                   9626:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9627:                             $secmatch = 1;
                   9628:                         }
                   9629:                     }
                   9630:                     if (!$secmatch) {
                   9631:                         next;
                   9632:                     }
1.288     raeburn  9633:                 }
1.419     raeburn  9634:                 if ($usec eq '') {
                   9635:                     $usec = 'none';
                   9636:                 }
1.275     raeburn  9637:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9638:                     if ($hidepriv) {
1.1075.2.36  raeburn  9639:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9640:                             (!$nothide{$uname.':'.$udom})) {
                   9641:                             next;
                   9642:                         }
                   9643:                     }
1.503     raeburn  9644:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9645:                         $status = 'previous';
                   9646:                     } elsif ($start > $now) {
                   9647:                         $status = 'future';
                   9648:                     } else {
                   9649:                         $status = 'active';
                   9650:                     }
1.277     albertel 9651:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9652:                         if ($status eq $type) {
1.420     albertel 9653:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9654:                                 push(@{$$users{$role}{$user}},$type);
                   9655:                             }
1.288     raeburn  9656:                             $match = 1;
                   9657:                         }
                   9658:                     }
1.419     raeburn  9659:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9660:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9661: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9662:                         }
1.420     albertel 9663:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9664:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9665:                         }
1.609     raeburn  9666:                         if (ref($statushash) eq 'HASH') {
                   9667:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9668:                         }
1.275     raeburn  9669:                     }
                   9670:                 }
                   9671:             }
                   9672:         }
1.290     albertel 9673:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9674:             if ((defined($cdom)) && (defined($cnum))) {
                   9675:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9676:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9677:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9678:                     next if ($owner eq '');
                   9679:                     my ($ownername,$ownerdom);
                   9680:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9681:                         $ownername = $1;
                   9682:                         $ownerdom = $2;
                   9683:                     } else {
                   9684:                         $ownername = $owner;
                   9685:                         $ownerdom = $cdom;
                   9686:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9687:                     }
                   9688:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9689:                     if (defined($userdata) && 
1.609     raeburn  9690: 			!exists($$userdata{$owner})) {
                   9691: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9692:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9693:                             push(@{$seclists{$owner}},'none');
                   9694:                         }
                   9695:                         if (ref($statushash) eq 'HASH') {
                   9696:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9697:                         }
1.290     albertel 9698: 		    }
1.279     raeburn  9699:                 }
                   9700:             }
                   9701:         }
1.419     raeburn  9702:         foreach my $user (keys(%seclists)) {
                   9703:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9704:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9705:         }
1.275     raeburn  9706:     }
                   9707:     return;
                   9708: }
                   9709: 
1.288     raeburn  9710: sub get_user_info {
                   9711:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9712:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9713: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9714:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9715:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9716:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9717:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9718:     return;
                   9719: }
1.275     raeburn  9720: 
1.472     raeburn  9721: ###############################################
                   9722: 
                   9723: =pod
                   9724: 
                   9725: =item * &get_user_quota()
                   9726: 
1.1075.2.41  raeburn  9727: Retrieves quota assigned for storage of user files.
                   9728: Default is to report quota for portfolio files.
1.472     raeburn  9729: 
                   9730: Incoming parameters:
                   9731: 1. user's username
                   9732: 2. user's domain
1.1075.2.41  raeburn  9733: 3. quota name - portfolio, author, or course
                   9734:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  9735: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  9736:    course
1.472     raeburn  9737: 
                   9738: Returns:
1.1075.2.58  raeburn  9739: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9740: 2. (Optional) Type of setting: custom or default
                   9741:    (individually assigned or default for user's 
                   9742:    institutional status).
                   9743: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9744:    or student - types as defined in localenroll::inst_usertypes 
                   9745:    for user's domain, which determines default quota for user.
                   9746: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9747: 
                   9748: If a value has been stored in the user's environment, 
1.536     raeburn  9749: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  9750: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9751: 
                   9752: =cut
                   9753: 
                   9754: ###############################################
                   9755: 
                   9756: 
                   9757: sub get_user_quota {
1.1075.2.42  raeburn  9758:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9759:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9760:     if (!defined($udom)) {
                   9761:         $udom = $env{'user.domain'};
                   9762:     }
                   9763:     if (!defined($uname)) {
                   9764:         $uname = $env{'user.name'};
                   9765:     }
                   9766:     if (($udom eq '' || $uname eq '') ||
                   9767:         ($udom eq 'public') && ($uname eq 'public')) {
                   9768:         $quota = 0;
1.536     raeburn  9769:         $quotatype = 'default';
                   9770:         $defquota = 0; 
1.472     raeburn  9771:     } else {
1.536     raeburn  9772:         my $inststatus;
1.1075.2.41  raeburn  9773:         if ($quotaname eq 'course') {
                   9774:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9775:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9776:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9777:             } else {
                   9778:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9779:                 $quota = $cenv{'internal.uploadquota'};
                   9780:             }
1.536     raeburn  9781:         } else {
1.1075.2.41  raeburn  9782:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   9783:                 if ($quotaname eq 'author') {
                   9784:                     $quota = $env{'environment.authorquota'};
                   9785:                 } else {
                   9786:                     $quota = $env{'environment.portfolioquota'};
                   9787:                 }
                   9788:                 $inststatus = $env{'environment.inststatus'};
                   9789:             } else {
                   9790:                 my %userenv = 
                   9791:                     &Apache::lonnet::get('environment',['portfolioquota',
                   9792:                                          'authorquota','inststatus'],$udom,$uname);
                   9793:                 my ($tmp) = keys(%userenv);
                   9794:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9795:                     if ($quotaname eq 'author') {
                   9796:                         $quota = $userenv{'authorquota'};
                   9797:                     } else {
                   9798:                         $quota = $userenv{'portfolioquota'};
                   9799:                     }
                   9800:                     $inststatus = $userenv{'inststatus'};
                   9801:                 } else {
                   9802:                     undef(%userenv);
                   9803:                 }
                   9804:             }
                   9805:         }
                   9806:         if ($quota eq '' || wantarray) {
                   9807:             if ($quotaname eq 'course') {
                   9808:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  9809:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   9810:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  9811:                     $defquota = $domdefs{$crstype.'quota'};
                   9812:                 }
                   9813:                 if ($defquota eq '') {
                   9814:                     $defquota = 500;
                   9815:                 }
1.1075.2.41  raeburn  9816:             } else {
                   9817:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   9818:             }
                   9819:             if ($quota eq '') {
                   9820:                 $quota = $defquota;
                   9821:                 $quotatype = 'default';
                   9822:             } else {
                   9823:                 $quotatype = 'custom';
                   9824:             }
1.472     raeburn  9825:         }
                   9826:     }
1.536     raeburn  9827:     if (wantarray) {
                   9828:         return ($quota,$quotatype,$settingstatus,$defquota);
                   9829:     } else {
                   9830:         return $quota;
                   9831:     }
1.472     raeburn  9832: }
                   9833: 
                   9834: ###############################################
                   9835: 
                   9836: =pod
                   9837: 
                   9838: =item * &default_quota()
                   9839: 
1.536     raeburn  9840: Retrieves default quota assigned for storage of user portfolio files,
                   9841: given an (optional) user's institutional status.
1.472     raeburn  9842: 
                   9843: Incoming parameters:
1.1075.2.42  raeburn  9844: 
1.472     raeburn  9845: 1. domain
1.536     raeburn  9846: 2. (Optional) institutional status(es).  This is a : separated list of 
                   9847:    status types (e.g., faculty, staff, student etc.)
                   9848:    which apply to the user for whom the default is being retrieved.
                   9849:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  9850:    default quota will be returned.
                   9851: 3.  quota name - portfolio, author, or course
                   9852:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  9853: 
                   9854: Returns:
1.1075.2.42  raeburn  9855: 
1.1075.2.58  raeburn  9856: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  9857: 2. (Optional) institutional type which determined the value of the
                   9858:    default quota.
1.472     raeburn  9859: 
                   9860: If a value has been stored in the domain's configuration db,
                   9861: it will return that, otherwise it returns 20 (for backwards 
                   9862: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  9863: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  9864: 
1.536     raeburn  9865: If the user's status includes multiple types (e.g., staff and student),
                   9866: the largest default quota which applies to the user determines the
                   9867: default quota returned.
                   9868: 
1.472     raeburn  9869: =cut
                   9870: 
                   9871: ###############################################
                   9872: 
                   9873: 
                   9874: sub default_quota {
1.1075.2.41  raeburn  9875:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  9876:     my ($defquota,$settingstatus);
                   9877:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  9878:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  9879:     my $key = 'defaultquota';
                   9880:     if ($quotaname eq 'author') {
                   9881:         $key = 'authorquota';
                   9882:     }
1.622     raeburn  9883:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  9884:         if ($inststatus ne '') {
1.765     raeburn  9885:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  9886:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  9887:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9888:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  9889:                         if ($defquota eq '') {
1.1075.2.41  raeburn  9890:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9891:                             $settingstatus = $item;
1.1075.2.41  raeburn  9892:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   9893:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9894:                             $settingstatus = $item;
                   9895:                         }
                   9896:                     }
1.1075.2.41  raeburn  9897:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  9898:                     if ($quotahash{'quotas'}{$item} ne '') {
                   9899:                         if ($defquota eq '') {
                   9900:                             $defquota = $quotahash{'quotas'}{$item};
                   9901:                             $settingstatus = $item;
                   9902:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   9903:                             $defquota = $quotahash{'quotas'}{$item};
                   9904:                             $settingstatus = $item;
                   9905:                         }
1.536     raeburn  9906:                     }
                   9907:                 }
                   9908:             }
                   9909:         }
                   9910:         if ($defquota eq '') {
1.1075.2.41  raeburn  9911:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9912:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   9913:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  9914:                 $defquota = $quotahash{'quotas'}{'default'};
                   9915:             }
1.536     raeburn  9916:             $settingstatus = 'default';
1.1075.2.42  raeburn  9917:             if ($defquota eq '') {
                   9918:                 if ($quotaname eq 'author') {
                   9919:                     $defquota = 500;
                   9920:                 }
                   9921:             }
1.536     raeburn  9922:         }
                   9923:     } else {
                   9924:         $settingstatus = 'default';
1.1075.2.41  raeburn  9925:         if ($quotaname eq 'author') {
                   9926:             $defquota = 500;
                   9927:         } else {
                   9928:             $defquota = 20;
                   9929:         }
1.536     raeburn  9930:     }
                   9931:     if (wantarray) {
                   9932:         return ($defquota,$settingstatus);
1.472     raeburn  9933:     } else {
1.536     raeburn  9934:         return $defquota;
1.472     raeburn  9935:     }
                   9936: }
                   9937: 
1.1075.2.41  raeburn  9938: ###############################################
                   9939: 
                   9940: =pod
                   9941: 
1.1075.2.42  raeburn  9942: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  9943: 
                   9944: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  9945: of existing file within authoring space will cause quota for the authoring
                   9946: space to be exceeded.
                   9947: 
                   9948: Same, if upload of a file directly to a course/community via Course Editor
                   9949: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  9950: 
1.1075.2.61  raeburn  9951: Inputs: 7 
1.1075.2.42  raeburn  9952: 1. username or coursenum
1.1075.2.41  raeburn  9953: 2. domain
1.1075.2.42  raeburn  9954: 3. context ('author' or 'course')
1.1075.2.41  raeburn  9955: 4. filename of file for which action is being requested
                   9956: 5. filesize (kB) of file
                   9957: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  9958: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  9959: 
                   9960: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   9961:          otherwise return null.
                   9962: 
1.1075.2.42  raeburn  9963: =back
                   9964: 
1.1075.2.41  raeburn  9965: =cut
                   9966: 
1.1075.2.42  raeburn  9967: sub excess_filesize_warning {
1.1075.2.59  raeburn  9968:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  9969:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  9970:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  9971:     if ($context eq 'author') {
                   9972:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   9973:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   9974:     } else {
                   9975:         foreach my $subdir ('docs','supplemental') {
                   9976:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   9977:         }
                   9978:     }
1.1075.2.41  raeburn  9979:     $disk_quota = int($disk_quota * 1000);
                   9980:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  9981:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  9982:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  9983:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   9984:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  9985:                             $disk_quota,$current_disk_usage).
                   9986:                '</p>';
                   9987:     }
                   9988:     return;
                   9989: }
                   9990: 
                   9991: ###############################################
                   9992: 
                   9993: 
1.384     raeburn  9994: sub get_secgrprole_info {
                   9995:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   9996:     my %sections_count = &get_sections($cdom,$cnum);
                   9997:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   9998:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   9999:     my @groups = sort(keys(%curr_groups));
                   10000:     my $allroles = [];
                   10001:     my $rolehash;
                   10002:     my $accesshash = {
                   10003:                      active => 'Currently has access',
                   10004:                      future => 'Will have future access',
                   10005:                      previous => 'Previously had access',
                   10006:                   };
                   10007:     if ($needroles) {
                   10008:         $rolehash = {'all' => 'all'};
1.385     albertel 10009:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   10010: 	if (&Apache::lonnet::error(%user_roles)) {
                   10011: 	    undef(%user_roles);
                   10012: 	}
                   10013:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  10014:             my ($role)=split(/\:/,$item,2);
                   10015:             if ($role eq 'cr') { next; }
                   10016:             if ($role =~ /^cr/) {
                   10017:                 $$rolehash{$role} = (split('/',$role))[3];
                   10018:             } else {
                   10019:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   10020:             }
                   10021:         }
                   10022:         foreach my $key (sort(keys(%{$rolehash}))) {
                   10023:             push(@{$allroles},$key);
                   10024:         }
                   10025:         push (@{$allroles},'st');
                   10026:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   10027:     }
                   10028:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   10029: }
                   10030: 
1.555     raeburn  10031: sub user_picker {
1.1075.2.127  raeburn  10032:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  10033:     my $currdom = $dom;
1.1075.2.114  raeburn  10034:     my @alldoms = &Apache::lonnet::all_domains();
                   10035:     if (@alldoms == 1) {
                   10036:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   10037:                                                ['directorysrch'],$alldoms[0]);
                   10038:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   10039:         my $showdom = $domdesc;
                   10040:         if ($showdom eq '') {
                   10041:             $showdom = $dom;
                   10042:         }
                   10043:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   10044:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   10045:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   10046:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   10047:             }
                   10048:         }
                   10049:     }
1.555     raeburn  10050:     my %curr_selected = (
                   10051:                         srchin => 'dom',
1.580     raeburn  10052:                         srchby => 'lastname',
1.555     raeburn  10053:                       );
                   10054:     my $srchterm;
1.625     raeburn  10055:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  10056:         if ($srch->{'srchby'} ne '') {
                   10057:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   10058:         }
                   10059:         if ($srch->{'srchin'} ne '') {
                   10060:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   10061:         }
                   10062:         if ($srch->{'srchtype'} ne '') {
                   10063:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   10064:         }
                   10065:         if ($srch->{'srchdomain'} ne '') {
                   10066:             $currdom = $srch->{'srchdomain'};
                   10067:         }
                   10068:         $srchterm = $srch->{'srchterm'};
                   10069:     }
1.1075.2.98  raeburn  10070:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  10071:                     'usr'       => 'Search criteria',
1.563     raeburn  10072:                     'doma'      => 'Domain/institution to search',
1.558     albertel 10073:                     'uname'     => 'username',
                   10074:                     'lastname'  => 'last name',
1.555     raeburn  10075:                     'lastfirst' => 'last name, first name',
1.558     albertel 10076:                     'crs'       => 'in this course',
1.576     raeburn  10077:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 10078:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  10079:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 10080:                     'exact'     => 'is',
                   10081:                     'contains'  => 'contains',
1.569     raeburn  10082:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  10083:                                        );
                   10084:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  10085:                     'youm'      => "You must include some text to search for.",
                   10086:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   10087:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   10088:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   10089:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   10090:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   10091:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   10092:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  10093:                                        );
1.1075.2.98  raeburn  10094:     &html_escape(\%html_lt);
                   10095:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  10096:     my $domform;
1.1075.2.126  raeburn  10097:     my $allow_blank = 1;
1.1075.2.115  raeburn  10098:     if ($fixeddom) {
1.1075.2.126  raeburn  10099:         $allow_blank = 0;
                   10100:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  10101:     } else {
1.1075.2.126  raeburn  10102:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  10103:     }
1.563     raeburn  10104:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  10105: 
                   10106:     my @srchins = ('crs','dom','alc','instd');
                   10107: 
                   10108:     foreach my $option (@srchins) {
                   10109:         # FIXME 'alc' option unavailable until 
                   10110:         #       loncreateuser::print_user_query_page()
                   10111:         #       has been completed.
                   10112:         next if ($option eq 'alc');
1.880     raeburn  10113:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  10114:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  10115:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  10116:         if ($curr_selected{'srchin'} eq $option) {
                   10117:             $srchinsel .= ' 
1.1075.2.98  raeburn  10118:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  10119:         } else {
                   10120:             $srchinsel .= '
1.1075.2.98  raeburn  10121:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  10122:         }
1.555     raeburn  10123:     }
1.563     raeburn  10124:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  10125: 
                   10126:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  10127:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  10128:         if ($curr_selected{'srchby'} eq $option) {
                   10129:             $srchbysel .= '
1.1075.2.98  raeburn  10130:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10131:         } else {
                   10132:             $srchbysel .= '
1.1075.2.98  raeburn  10133:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10134:          }
                   10135:     }
                   10136:     $srchbysel .= "\n  </select>\n";
                   10137: 
                   10138:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  10139:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  10140:         if ($curr_selected{'srchtype'} eq $option) {
                   10141:             $srchtypesel .= '
1.1075.2.98  raeburn  10142:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10143:         } else {
                   10144:             $srchtypesel .= '
1.1075.2.98  raeburn  10145:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10146:         }
                   10147:     }
                   10148:     $srchtypesel .= "\n  </select>\n";
                   10149: 
1.558     albertel 10150:     my ($newuserscript,$new_user_create);
1.994     raeburn  10151:     my $context_dom = $env{'request.role.domain'};
                   10152:     if ($context eq 'requestcrs') {
                   10153:         if ($env{'form.coursedom'} ne '') { 
                   10154:             $context_dom = $env{'form.coursedom'};
                   10155:         }
                   10156:     }
1.556     raeburn  10157:     if ($forcenewuser) {
1.576     raeburn  10158:         if (ref($srch) eq 'HASH') {
1.994     raeburn  10159:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  10160:                 if ($cancreate) {
                   10161:                     $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>';
                   10162:                 } else {
1.799     bisitz   10163:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  10164:                     my %usertypetext = (
                   10165:                         official   => 'institutional',
                   10166:                         unofficial => 'non-institutional',
                   10167:                     );
1.799     bisitz   10168:                     $new_user_create = '<p class="LC_warning">'
                   10169:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   10170:                                       .' '
                   10171:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   10172:                                           ,'<a href="'.$helplink.'">','</a>')
                   10173:                                       .'</p><br />';
1.627     raeburn  10174:                 }
1.576     raeburn  10175:             }
                   10176:         }
                   10177: 
1.556     raeburn  10178:         $newuserscript = <<"ENDSCRIPT";
                   10179: 
1.570     raeburn  10180: function setSearch(createnew,callingForm) {
1.556     raeburn  10181:     if (createnew == 1) {
1.570     raeburn  10182:         for (var i=0; i<callingForm.srchby.length; i++) {
                   10183:             if (callingForm.srchby.options[i].value == 'uname') {
                   10184:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  10185:             }
                   10186:         }
1.570     raeburn  10187:         for (var i=0; i<callingForm.srchin.length; i++) {
                   10188:             if ( callingForm.srchin.options[i].value == 'dom') {
                   10189: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  10190:             }
                   10191:         }
1.570     raeburn  10192:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   10193:             if (callingForm.srchtype.options[i].value == 'exact') {
                   10194:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  10195:             }
                   10196:         }
1.570     raeburn  10197:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  10198:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  10199:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  10200:             }
                   10201:         }
                   10202:     }
                   10203: }
                   10204: ENDSCRIPT
1.558     albertel 10205: 
1.556     raeburn  10206:     }
                   10207: 
1.555     raeburn  10208:     my $output = <<"END_BLOCK";
1.556     raeburn  10209: <script type="text/javascript">
1.824     bisitz   10210: // <![CDATA[
1.570     raeburn  10211: function validateEntry(callingForm) {
1.558     albertel 10212: 
1.556     raeburn  10213:     var checkok = 1;
1.558     albertel 10214:     var srchin;
1.570     raeburn  10215:     for (var i=0; i<callingForm.srchin.length; i++) {
                   10216: 	if ( callingForm.srchin[i].checked ) {
                   10217: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 10218: 	}
                   10219:     }
                   10220: 
1.570     raeburn  10221:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   10222:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   10223:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   10224:     var srchterm =  callingForm.srchterm.value;
                   10225:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  10226:     var msg = "";
                   10227: 
                   10228:     if (srchterm == "") {
                   10229:         checkok = 0;
1.1075.2.98  raeburn  10230:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  10231:     }
                   10232: 
1.569     raeburn  10233:     if (srchtype== 'begins') {
                   10234:         if (srchterm.length < 2) {
                   10235:             checkok = 0;
1.1075.2.98  raeburn  10236:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  10237:         }
                   10238:     }
                   10239: 
1.556     raeburn  10240:     if (srchtype== 'contains') {
                   10241:         if (srchterm.length < 3) {
                   10242:             checkok = 0;
1.1075.2.98  raeburn  10243:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  10244:         }
                   10245:     }
                   10246:     if (srchin == 'instd') {
                   10247:         if (srchdomain == '') {
                   10248:             checkok = 0;
1.1075.2.98  raeburn  10249:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  10250:         }
                   10251:     }
                   10252:     if (srchin == 'dom') {
                   10253:         if (srchdomain == '') {
                   10254:             checkok = 0;
1.1075.2.98  raeburn  10255:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  10256:         }
                   10257:     }
                   10258:     if (srchby == 'lastfirst') {
                   10259:         if (srchterm.indexOf(",") == -1) {
                   10260:             checkok = 0;
1.1075.2.98  raeburn  10261:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  10262:         }
                   10263:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   10264:             checkok = 0;
1.1075.2.98  raeburn  10265:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  10266:         }
                   10267:     }
                   10268:     if (checkok == 0) {
1.1075.2.98  raeburn  10269:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  10270:         return;
                   10271:     }
                   10272:     if (checkok == 1) {
1.570     raeburn  10273:         callingForm.submit();
1.556     raeburn  10274:     }
                   10275: }
                   10276: 
                   10277: $newuserscript
                   10278: 
1.824     bisitz   10279: // ]]>
1.556     raeburn  10280: </script>
1.558     albertel 10281: 
                   10282: $new_user_create
                   10283: 
1.555     raeburn  10284: END_BLOCK
1.558     albertel 10285: 
1.876     raeburn  10286:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  10287:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  10288:                $domform.
                   10289:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  10290:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  10291:                $srchbysel.
                   10292:                $srchtypesel. 
                   10293:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   10294:                $srchinsel.
                   10295:                &Apache::lonhtmlcommon::row_closure(1). 
                   10296:                &Apache::lonhtmlcommon::end_pick_box().
                   10297:                '<br />';
1.1075.2.114  raeburn  10298:     return ($output,1);
1.555     raeburn  10299: }
                   10300: 
1.612     raeburn  10301: sub user_rule_check {
1.615     raeburn  10302:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  10303:     my ($response,%inst_response);
1.612     raeburn  10304:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  10305:         if (keys(%{$usershash}) > 1) {
                   10306:             my (%by_username,%by_id,%userdoms);
                   10307:             my $checkid;
1.612     raeburn  10308:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  10309:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   10310:                     $checkid = 1;
                   10311:                 }
                   10312:             }
                   10313:             foreach my $user (keys(%{$usershash})) {
                   10314:                 my ($uname,$udom) = split(/:/,$user);
                   10315:                 if ($checkid) {
                   10316:                     if (ref($usershash->{$user}) eq 'HASH') {
                   10317:                         if ($usershash->{$user}->{'id'} ne '') {
                   10318:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   10319:                             $userdoms{$udom} = 1;
                   10320:                             if (ref($inst_results) eq 'HASH') {
                   10321:                                 $inst_results->{$uname.':'.$udom} = {};
                   10322:                             }
                   10323:                         }
                   10324:                     }
                   10325:                 } else {
                   10326:                     $by_username{$udom}{$uname} = 1;
                   10327:                     $userdoms{$udom} = 1;
                   10328:                     if (ref($inst_results) eq 'HASH') {
                   10329:                         $inst_results->{$uname.':'.$udom} = {};
                   10330:                     }
                   10331:                 }
                   10332:             }
                   10333:             foreach my $udom (keys(%userdoms)) {
                   10334:                 if (!$got_rules->{$udom}) {
                   10335:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10336:                                                              ['usercreation'],$udom);
                   10337:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10338:                         foreach my $item ('username','id') {
                   10339:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10340:                                 $$curr_rules{$udom}{$item} =
                   10341:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   10342:                             }
                   10343:                         }
                   10344:                     }
                   10345:                     $got_rules->{$udom} = 1;
                   10346:                 }
                   10347:             }
                   10348:             if ($checkid) {
                   10349:                 foreach my $udom (keys(%by_id)) {
                   10350:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   10351:                     if ($outcome eq 'ok') {
                   10352:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   10353:                             my $uname = $by_id{$udom}{$id};
                   10354:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10355:                         }
                   10356:                         if (ref($results) eq 'HASH') {
                   10357:                             foreach my $uname (keys(%{$results})) {
                   10358:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   10359:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   10360:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10361:                                 }
                   10362:                             }
                   10363:                         }
                   10364:                     }
1.612     raeburn  10365:                 }
1.615     raeburn  10366:             } else {
1.1075.2.99  raeburn  10367:                 foreach my $udom (keys(%by_username)) {
                   10368:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   10369:                     if ($outcome eq 'ok') {
                   10370:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   10371:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10372:                         }
                   10373:                         if (ref($results) eq 'HASH') {
                   10374:                             foreach my $uname (keys(%{$results})) {
                   10375:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10376:                             }
                   10377:                         }
                   10378:                     }
                   10379:                 }
1.612     raeburn  10380:             }
1.1075.2.99  raeburn  10381:         } elsif (keys(%{$usershash}) == 1) {
                   10382:             my $user = (keys(%{$usershash}))[0];
                   10383:             my ($uname,$udom) = split(/:/,$user);
                   10384:             if (($udom ne '') && ($uname ne '')) {
                   10385:                 if (ref($usershash->{$user}) eq 'HASH') {
                   10386:                     if (ref($checks) eq 'HASH') {
                   10387:                         if (defined($checks->{'username'})) {
                   10388:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   10389:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   10390:                         } elsif (defined($checks->{'id'})) {
                   10391:                             if ($usershash->{$user}->{'id'} ne '') {
                   10392:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10393:                                     &Apache::lonnet::get_instuser($udom,undef,
                   10394:                                                                   $usershash->{$user}->{'id'});
                   10395:                             } else {
                   10396:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10397:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   10398:                             }
                   10399:                         }
                   10400:                     } else {
                   10401:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   10402:                             &Apache::lonnet::get_instuser($udom,$uname);
                   10403:                        return;
                   10404:                     }
                   10405:                     if (!$got_rules->{$udom}) {
                   10406:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10407:                                                                  ['usercreation'],$udom);
                   10408:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10409:                             foreach my $item ('username','id') {
                   10410:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10411:                                    $$curr_rules{$udom}{$item} =
                   10412:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   10413:                                 }
                   10414:                             }
1.585     raeburn  10415:                         }
1.1075.2.99  raeburn  10416:                         $got_rules->{$udom} = 1;
1.585     raeburn  10417:                     }
                   10418:                 }
1.1075.2.99  raeburn  10419:             } else {
                   10420:                 return;
                   10421:             }
                   10422:         } else {
                   10423:             return;
                   10424:         }
                   10425:         foreach my $user (keys(%{$usershash})) {
                   10426:             my ($uname,$udom) = split(/:/,$user);
                   10427:             next if (($udom eq '') || ($uname eq ''));
                   10428:             my $id;
                   10429:             if (ref($inst_results) eq 'HASH') {
                   10430:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   10431:                     $id = $inst_results->{$user}->{'id'};
                   10432:                 }
                   10433:             }
                   10434:             if ($id eq '') {
                   10435:                 if (ref($usershash->{$user})) {
                   10436:                     $id = $usershash->{$user}->{'id'};
                   10437:                 }
1.585     raeburn  10438:             }
1.612     raeburn  10439:             foreach my $item (keys(%{$checks})) {
                   10440:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   10441:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   10442:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  10443:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   10444:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  10445:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   10446:                                 if ($rule_check{$rule}) {
                   10447:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10448:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10449:                                         if (ref($inst_results) eq 'HASH') {
                   10450:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10451:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10452:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10453:                                                 } elsif ($item eq 'id') {
                   10454:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10455:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10456:                                                     }
1.615     raeburn  10457:                                                 }
1.612     raeburn  10458:                                             }
                   10459:                                         }
1.615     raeburn  10460:                                     }
                   10461:                                     last;
1.585     raeburn  10462:                                 }
                   10463:                             }
                   10464:                         }
                   10465:                     }
                   10466:                 }
                   10467:             }
                   10468:         }
                   10469:     }
1.612     raeburn  10470:     return;
                   10471: }
                   10472: 
                   10473: sub user_rule_formats {
                   10474:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10475:     my %text = ( 
                   10476:                  'username' => 'Usernames',
                   10477:                  'id'       => 'IDs',
                   10478:                );
                   10479:     my $output;
                   10480:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10481:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10482:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10483:             $output = '<br />'.
                   10484:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10485:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10486:                       ' <ul>';
1.612     raeburn  10487:             foreach my $rule (@{$ruleorder}) {
                   10488:                 if (ref($curr_rules) eq 'ARRAY') {
                   10489:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10490:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10491:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10492:                                         $rules->{$rule}{'desc'}.'</li>';
                   10493:                         }
                   10494:                     }
                   10495:                 }
                   10496:             }
                   10497:             $output .= '</ul>';
                   10498:         }
                   10499:     }
                   10500:     return $output;
                   10501: }
                   10502: 
                   10503: sub instrule_disallow_msg {
1.615     raeburn  10504:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  10505:     my $response;
                   10506:     my %text = (
                   10507:                   item   => 'username',
                   10508:                   items  => 'usernames',
                   10509:                   match  => 'matches',
                   10510:                   do     => 'does',
                   10511:                   action => 'a username',
                   10512:                   one    => 'one',
                   10513:                );
                   10514:     if ($count > 1) {
                   10515:         $text{'item'} = 'usernames';
                   10516:         $text{'match'} ='match';
                   10517:         $text{'do'} = 'do';
                   10518:         $text{'action'} = 'usernames',
                   10519:         $text{'one'} = 'ones';
                   10520:     }
                   10521:     if ($checkitem eq 'id') {
                   10522:         $text{'items'} = 'IDs';
                   10523:         $text{'item'} = 'ID';
                   10524:         $text{'action'} = 'an ID';
1.615     raeburn  10525:         if ($count > 1) {
                   10526:             $text{'item'} = 'IDs';
                   10527:             $text{'action'} = 'IDs';
                   10528:         }
1.612     raeburn  10529:     }
1.674     bisitz   10530:     $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  10531:     if ($mode eq 'upload') {
                   10532:         if ($checkitem eq 'username') {
                   10533:             $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'}.");
                   10534:         } elsif ($checkitem eq 'id') {
1.674     bisitz   10535:             $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  10536:         }
1.669     raeburn  10537:     } elsif ($mode eq 'selfcreate') {
                   10538:         if ($checkitem eq 'id') {
                   10539:             $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.");
                   10540:         }
1.615     raeburn  10541:     } else {
                   10542:         if ($checkitem eq 'username') {
                   10543:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   10544:         } elsif ($checkitem eq 'id') {
                   10545:             $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.");
                   10546:         }
1.612     raeburn  10547:     }
                   10548:     return $response;
1.585     raeburn  10549: }
                   10550: 
1.624     raeburn  10551: sub personal_data_fieldtitles {
                   10552:     my %fieldtitles = &Apache::lonlocal::texthash (
                   10553:                         id => 'Student/Employee ID',
                   10554:                         permanentemail => 'E-mail address',
                   10555:                         lastname => 'Last Name',
                   10556:                         firstname => 'First Name',
                   10557:                         middlename => 'Middle Name',
                   10558:                         generation => 'Generation',
                   10559:                         gen => 'Generation',
1.765     raeburn  10560:                         inststatus => 'Affiliation',
1.624     raeburn  10561:                    );
                   10562:     return %fieldtitles;
                   10563: }
                   10564: 
1.642     raeburn  10565: sub sorted_inst_types {
                   10566:     my ($dom) = @_;
1.1075.2.70  raeburn  10567:     my ($usertypes,$order);
                   10568:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   10569:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   10570:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   10571:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   10572:     } else {
                   10573:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   10574:     }
1.642     raeburn  10575:     my $othertitle = &mt('All users');
                   10576:     if ($env{'request.course.id'}) {
1.668     raeburn  10577:         $othertitle  = &mt('Any users');
1.642     raeburn  10578:     }
                   10579:     my @types;
                   10580:     if (ref($order) eq 'ARRAY') {
                   10581:         @types = @{$order};
                   10582:     }
                   10583:     if (@types == 0) {
                   10584:         if (ref($usertypes) eq 'HASH') {
                   10585:             @types = sort(keys(%{$usertypes}));
                   10586:         }
                   10587:     }
                   10588:     if (keys(%{$usertypes}) > 0) {
                   10589:         $othertitle = &mt('Other users');
                   10590:     }
                   10591:     return ($othertitle,$usertypes,\@types);
                   10592: }
                   10593: 
1.645     raeburn  10594: sub get_institutional_codes {
1.1075.2.157  raeburn  10595:     my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645     raeburn  10596: # Get complete list of course sections to update
                   10597:     my @currsections = ();
                   10598:     my @currxlists = ();
1.1075.2.157  raeburn  10599:     my (%unclutteredsec,%unclutteredlcsec);
1.645     raeburn  10600:     my $coursecode = $$settings{'internal.coursecode'};
1.1075.2.157  raeburn  10601:     my $crskey = $crs.':'.$coursecode;
                   10602:     @{$unclutteredsec{$crskey}} = ();
                   10603:     @{$unclutteredlcsec{$crskey}} = ();
1.645     raeburn  10604: 
                   10605:     if ($$settings{'internal.sectionnums'} ne '') {
                   10606:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   10607:     }
                   10608: 
                   10609:     if ($$settings{'internal.crosslistings'} ne '') {
                   10610:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   10611:     }
                   10612: 
                   10613:     if (@currxlists > 0) {
1.1075.2.157  raeburn  10614:         foreach my $xl (@currxlists) {
                   10615:             if ($xl =~ /^([^:]+):(\w*)$/) {
1.645     raeburn  10616:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  10617:                     push(@{$allcourses},$1);
1.645     raeburn  10618:                     $$LC_code{$1} = $2;
                   10619:                 }
                   10620:             }
                   10621:         }
                   10622:     }
1.1075.2.157  raeburn  10623: 
1.645     raeburn  10624:     if (@currsections > 0) {
1.1075.2.157  raeburn  10625:         foreach my $sec (@currsections) {
                   10626:             if ($sec =~ m/^(\w+):(\w*)$/ ) {
                   10627:                 my $instsec = $1;
1.645     raeburn  10628:                 my $lc_sec = $2;
1.1075.2.157  raeburn  10629:                 unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
                   10630:                     push(@{$unclutteredsec{$crskey}},$instsec);
                   10631:                     push(@{$unclutteredlcsec{$crskey}},$lc_sec);
                   10632:                 }
                   10633:             }
                   10634:         }
                   10635:     }
                   10636: 
                   10637:     if (@{$unclutteredsec{$crskey}} > 0) {
                   10638:         my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
                   10639:         if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
                   10640:             for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
                   10641:                 my $sec = $coursecode.$formattedsec{$crskey}[$i];
                   10642:                 unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1075.2.119  raeburn  10643:                     push(@{$allcourses},$sec);
1.1075.2.157  raeburn  10644:                     $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645     raeburn  10645:                 }
                   10646:             }
                   10647:         }
                   10648:     }
                   10649:     return;
                   10650: }
                   10651: 
1.971     raeburn  10652: sub get_standard_codeitems {
                   10653:     return ('Year','Semester','Department','Number','Section');
                   10654: }
                   10655: 
1.112     bowersj2 10656: =pod
                   10657: 
1.780     raeburn  10658: =head1 Slot Helpers
                   10659: 
                   10660: =over 4
                   10661: 
                   10662: =item * sorted_slots()
                   10663: 
1.1040    raeburn  10664: Sorts an array of slot names in order of an optional sort key,
                   10665: default sort is by slot start time (earliest first). 
1.780     raeburn  10666: 
                   10667: Inputs:
                   10668: 
                   10669: =over 4
                   10670: 
                   10671: slotsarr  - Reference to array of unsorted slot names.
                   10672: 
                   10673: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   10674: 
1.1040    raeburn  10675: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   10676: 
1.549     albertel 10677: =back
                   10678: 
1.780     raeburn  10679: Returns:
                   10680: 
                   10681: =over 4
                   10682: 
1.1040    raeburn  10683: sorted   - An array of slot names sorted by a specified sort key 
                   10684:            (default sort key is start time of the slot).
1.780     raeburn  10685: 
                   10686: =back
                   10687: 
                   10688: =cut
                   10689: 
                   10690: 
                   10691: sub sorted_slots {
1.1040    raeburn  10692:     my ($slotsarr,$slots,$sortkey) = @_;
                   10693:     if ($sortkey eq '') {
                   10694:         $sortkey = 'starttime';
                   10695:     }
1.780     raeburn  10696:     my @sorted;
                   10697:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   10698:         @sorted =
                   10699:             sort {
                   10700:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  10701:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  10702:                      }
                   10703:                      if (ref($slots->{$a})) { return -1;}
                   10704:                      if (ref($slots->{$b})) { return 1;}
                   10705:                      return 0;
                   10706:                  } @{$slotsarr};
                   10707:     }
                   10708:     return @sorted;
                   10709: }
                   10710: 
1.1040    raeburn  10711: =pod
                   10712: 
                   10713: =item * get_future_slots()
                   10714: 
                   10715: Inputs:
                   10716: 
                   10717: =over 4
                   10718: 
                   10719: cnum - course number
                   10720: 
                   10721: cdom - course domain
                   10722: 
                   10723: now - current UNIX time
                   10724: 
                   10725: symb - optional symb
                   10726: 
                   10727: =back
                   10728: 
                   10729: Returns:
                   10730: 
                   10731: =over 4
                   10732: 
                   10733: sorted_reservable - ref to array of student_schedulable slots currently 
                   10734:                     reservable, ordered by end date of reservation period.
                   10735: 
                   10736: reservable_now - ref to hash of student_schedulable slots currently
                   10737:                  reservable.
                   10738: 
                   10739:     Keys in inner hash are:
                   10740:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  10741:     (b) endreserve: end date of reservation period.
                   10742:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10743:         selected.
1.1040    raeburn  10744: 
                   10745: sorted_future - ref to array of student_schedulable slots reservable in
                   10746:                 the future, ordered by start date of reservation period.
                   10747: 
                   10748: future_reservable - ref to hash of student_schedulable slots reservable
                   10749:                     in the future.
                   10750: 
                   10751:     Keys in inner hash are:
                   10752:     (a) symb: either blank or symb to which slot use is restricted.
                   10753:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  10754:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10755:         selected.
1.1040    raeburn  10756: 
                   10757: =back
                   10758: 
                   10759: =cut
                   10760: 
                   10761: sub get_future_slots {
                   10762:     my ($cnum,$cdom,$now,$symb) = @_;
                   10763:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10764:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10765:     foreach my $slot (keys(%slots)) {
                   10766:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10767:         if ($symb) {
                   10768:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10769:                      ($slots{$slot}->{'symb'} ne $symb));
                   10770:         }
                   10771:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10772:             ($slots{$slot}->{'endtime'} > $now)) {
                   10773:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10774:                 my $userallowed = 0;
                   10775:                 if ($slots{$slot}->{'allowedsections'}) {
                   10776:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10777:                     if (!defined($env{'request.role.sec'})
                   10778:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10779:                         $userallowed=1;
                   10780:                     } else {
                   10781:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   10782:                             $userallowed=1;
                   10783:                         }
                   10784:                     }
                   10785:                     unless ($userallowed) {
                   10786:                         if (defined($env{'request.course.groups'})) {
                   10787:                             my @groups = split(/:/,$env{'request.course.groups'});
                   10788:                             foreach my $group (@groups) {
                   10789:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   10790:                                     $userallowed=1;
                   10791:                                     last;
                   10792:                                 }
                   10793:                             }
                   10794:                         }
                   10795:                     }
                   10796:                 }
                   10797:                 if ($slots{$slot}->{'allowedusers'}) {
                   10798:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   10799:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   10800:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   10801:                         $userallowed = 1;
                   10802:                     }
                   10803:                 }
                   10804:                 next unless($userallowed);
                   10805:             }
                   10806:             my $startreserve = $slots{$slot}->{'startreserve'};
                   10807:             my $endreserve = $slots{$slot}->{'endreserve'};
                   10808:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  10809:             my $uniqueperiod;
                   10810:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   10811:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   10812:             }
1.1040    raeburn  10813:             if (($startreserve < $now) &&
                   10814:                 (!$endreserve || $endreserve > $now)) {
                   10815:                 my $lastres = $endreserve;
                   10816:                 if (!$lastres) {
                   10817:                     $lastres = $slots{$slot}->{'starttime'};
                   10818:                 }
                   10819:                 $reservable_now{$slot} = {
                   10820:                                            symb       => $symb,
1.1075.2.104  raeburn  10821:                                            endreserve => $lastres,
                   10822:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  10823:                                          };
                   10824:             } elsif (($startreserve > $now) &&
                   10825:                      (!$endreserve || $endreserve > $startreserve)) {
                   10826:                 $future_reservable{$slot} = {
                   10827:                                               symb         => $symb,
1.1075.2.104  raeburn  10828:                                               startreserve => $startreserve,
                   10829:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  10830:                                             };
                   10831:             }
                   10832:         }
                   10833:     }
                   10834:     my @unsorted_reservable = keys(%reservable_now);
                   10835:     if (@unsorted_reservable > 0) {
                   10836:         @sorted_reservable = 
                   10837:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   10838:     }
                   10839:     my @unsorted_future = keys(%future_reservable);
                   10840:     if (@unsorted_future > 0) {
                   10841:         @sorted_future =
                   10842:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   10843:     }
                   10844:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   10845: }
1.780     raeburn  10846: 
                   10847: =pod
                   10848: 
1.1057    foxr     10849: =back
                   10850: 
1.549     albertel 10851: =head1 HTTP Helpers
                   10852: 
                   10853: =over 4
                   10854: 
1.648     raeburn  10855: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 10856: 
1.258     albertel 10857: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 10858: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 10859: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 10860: 
                   10861: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   10862: $possible_names is an ref to an array of form element names.  As an example:
                   10863: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 10864: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 10865: 
                   10866: =cut
1.1       albertel 10867: 
1.6       albertel 10868: sub get_unprocessed_cgi {
1.25      albertel 10869:   my ($query,$possible_names)= @_;
1.26      matthew  10870:   # $Apache::lonxml::debug=1;
1.356     albertel 10871:   foreach my $pair (split(/&/,$query)) {
                   10872:     my ($name, $value) = split(/=/,$pair);
1.369     www      10873:     $name = &unescape($name);
1.25      albertel 10874:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   10875:       $value =~ tr/+/ /;
                   10876:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 10877:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 10878:     }
1.16      harris41 10879:   }
1.6       albertel 10880: }
                   10881: 
1.112     bowersj2 10882: =pod
                   10883: 
1.648     raeburn  10884: =item * &cacheheader() 
1.112     bowersj2 10885: 
                   10886: returns cache-controlling header code
                   10887: 
                   10888: =cut
                   10889: 
1.7       albertel 10890: sub cacheheader {
1.258     albertel 10891:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 10892:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   10893:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 10894:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   10895:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 10896:     return $output;
1.7       albertel 10897: }
                   10898: 
1.112     bowersj2 10899: =pod
                   10900: 
1.648     raeburn  10901: =item * &no_cache($r) 
1.112     bowersj2 10902: 
                   10903: specifies header code to not have cache
                   10904: 
                   10905: =cut
                   10906: 
1.9       albertel 10907: sub no_cache {
1.216     albertel 10908:     my ($r) = @_;
                   10909:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 10910: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 10911:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   10912:     $r->no_cache(1);
                   10913:     $r->header_out("Expires" => $date);
                   10914:     $r->header_out("Pragma" => "no-cache");
1.123     www      10915: }
                   10916: 
                   10917: sub content_type {
1.181     albertel 10918:     my ($r,$type,$charset) = @_;
1.299     foxr     10919:     if ($r) {
                   10920: 	#  Note that printout.pl calls this with undef for $r.
                   10921: 	&no_cache($r);
                   10922:     }
1.258     albertel 10923:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 10924:     unless ($charset) {
                   10925: 	$charset=&Apache::lonlocal::current_encoding;
                   10926:     }
                   10927:     if ($charset) { $type.='; charset='.$charset; }
                   10928:     if ($r) {
                   10929: 	$r->content_type($type);
                   10930:     } else {
                   10931: 	print("Content-type: $type\n\n");
                   10932:     }
1.9       albertel 10933: }
1.25      albertel 10934: 
1.112     bowersj2 10935: =pod
                   10936: 
1.648     raeburn  10937: =item * &add_to_env($name,$value) 
1.112     bowersj2 10938: 
1.258     albertel 10939: adds $name to the %env hash with value
1.112     bowersj2 10940: $value, if $name already exists, the entry is converted to an array
                   10941: reference and $value is added to the array.
                   10942: 
                   10943: =cut
                   10944: 
1.25      albertel 10945: sub add_to_env {
                   10946:   my ($name,$value)=@_;
1.258     albertel 10947:   if (defined($env{$name})) {
                   10948:     if (ref($env{$name})) {
1.25      albertel 10949:       #already have multiple values
1.258     albertel 10950:       push(@{ $env{$name} },$value);
1.25      albertel 10951:     } else {
                   10952:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 10953:       my $first=$env{$name};
                   10954:       undef($env{$name});
                   10955:       push(@{ $env{$name} },$first,$value);
1.25      albertel 10956:     }
                   10957:   } else {
1.258     albertel 10958:     $env{$name}=$value;
1.25      albertel 10959:   }
1.31      albertel 10960: }
1.149     albertel 10961: 
                   10962: =pod
                   10963: 
1.648     raeburn  10964: =item * &get_env_multiple($name) 
1.149     albertel 10965: 
1.258     albertel 10966: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 10967: values may be defined and end up as an array ref.
                   10968: 
                   10969: returns an array of values
                   10970: 
                   10971: =cut
                   10972: 
                   10973: sub get_env_multiple {
                   10974:     my ($name) = @_;
                   10975:     my @values;
1.258     albertel 10976:     if (defined($env{$name})) {
1.149     albertel 10977:         # exists is it an array
1.258     albertel 10978:         if (ref($env{$name})) {
                   10979:             @values=@{ $env{$name} };
1.149     albertel 10980:         } else {
1.258     albertel 10981:             $values[0]=$env{$name};
1.149     albertel 10982:         }
                   10983:     }
                   10984:     return(@values);
                   10985: }
                   10986: 
1.660     raeburn  10987: sub ask_for_embedded_content {
                   10988:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  10989:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  10990:         %currsubfile,%unused,$rem);
1.1071    raeburn  10991:     my $counter = 0;
                   10992:     my $numnew = 0;
1.987     raeburn  10993:     my $numremref = 0;
                   10994:     my $numinvalid = 0;
                   10995:     my $numpathchg = 0;
                   10996:     my $numexisting = 0;
1.1071    raeburn  10997:     my $numunused = 0;
                   10998:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  10999:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  11000:     my $heading = &mt('Upload embedded files');
                   11001:     my $buttontext = &mt('Upload');
                   11002: 
1.1075.2.11  raeburn  11003:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  11004:         if ($actionurl eq '/adm/dependencies') {
                   11005:             $navmap = Apache::lonnavmaps::navmap->new();
                   11006:         }
                   11007:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   11008:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  11009:     }
1.1075.2.35  raeburn  11010:     if (($actionurl eq '/adm/portfolio') ||
                   11011:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  11012:         my $current_path='/';
                   11013:         if ($env{'form.currentpath'}) {
                   11014:             $current_path = $env{'form.currentpath'};
                   11015:         }
                   11016:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  11017:             $udom = $cdom;
                   11018:             $uname = $cnum;
1.984     raeburn  11019:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   11020:         } else {
                   11021:             $udom = $env{'user.domain'};
                   11022:             $uname = $env{'user.name'};
                   11023:             $url = '/userfiles/portfolio';
                   11024:         }
1.987     raeburn  11025:         $toplevel = $url.'/';
1.984     raeburn  11026:         $url .= $current_path;
                   11027:         $getpropath = 1;
1.987     raeburn  11028:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   11029:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      11030:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  11031:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  11032:         $toplevel = $url;
1.984     raeburn  11033:         if ($rest ne '') {
1.987     raeburn  11034:             $url .= $rest;
                   11035:         }
                   11036:     } elsif ($actionurl eq '/adm/coursedocs') {
                   11037:         if (ref($args) eq 'HASH') {
1.1071    raeburn  11038:             $url = $args->{'docs_url'};
                   11039:             $toplevel = $url;
1.1075.2.11  raeburn  11040:             if ($args->{'context'} eq 'paste') {
                   11041:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   11042:                 ($path) =
                   11043:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11044:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11045:                 $fileloc =~ s{^/}{};
                   11046:             }
1.1071    raeburn  11047:         }
                   11048:     } elsif ($actionurl eq '/adm/dependencies') {
                   11049:         if ($env{'request.course.id'} ne '') {
                   11050:             if (ref($args) eq 'HASH') {
                   11051:                 $url = $args->{'docs_url'};
                   11052:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  11053:                 $toplevel = $url;
                   11054:                 unless ($toplevel =~ m{^/}) {
                   11055:                     $toplevel = "/$url";
                   11056:                 }
1.1075.2.11  raeburn  11057:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  11058:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   11059:                     $path = $1;
                   11060:                 } else {
                   11061:                     ($path) =
                   11062:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11063:                 }
1.1075.2.79  raeburn  11064:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   11065:                     $fileloc = $toplevel;
                   11066:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   11067:                     my ($udom,$uname,$fname) =
                   11068:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   11069:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   11070:                 } else {
                   11071:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11072:                 }
1.1071    raeburn  11073:                 $fileloc =~ s{^/}{};
                   11074:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   11075:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   11076:             }
1.987     raeburn  11077:         }
1.1075.2.35  raeburn  11078:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11079:         $udom = $cdom;
                   11080:         $uname = $cnum;
                   11081:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   11082:         $toplevel = $url;
                   11083:         $path = $url;
                   11084:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   11085:         $fileloc =~ s{^/}{};
                   11086:     }
                   11087:     foreach my $file (keys(%{$allfiles})) {
                   11088:         my $embed_file;
                   11089:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   11090:             $embed_file = $1;
                   11091:         } else {
                   11092:             $embed_file = $file;
                   11093:         }
1.1075.2.55  raeburn  11094:         my ($absolutepath,$cleaned_file);
                   11095:         if ($embed_file =~ m{^\w+://}) {
                   11096:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  11097:             $newfiles{$cleaned_file} = 1;
                   11098:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11099:         } else {
1.1075.2.55  raeburn  11100:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  11101:             if ($embed_file =~ m{^/}) {
                   11102:                 $absolutepath = $embed_file;
                   11103:             }
1.1075.2.47  raeburn  11104:             if ($cleaned_file =~ m{/}) {
                   11105:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  11106:                 $path = &check_for_traversal($path,$url,$toplevel);
                   11107:                 my $item = $fname;
                   11108:                 if ($path ne '') {
                   11109:                     $item = $path.'/'.$fname;
                   11110:                     $subdependencies{$path}{$fname} = 1;
                   11111:                 } else {
                   11112:                     $dependencies{$item} = 1;
                   11113:                 }
                   11114:                 if ($absolutepath) {
                   11115:                     $mapping{$item} = $absolutepath;
                   11116:                 } else {
                   11117:                     $mapping{$item} = $embed_file;
                   11118:                 }
                   11119:             } else {
                   11120:                 $dependencies{$embed_file} = 1;
                   11121:                 if ($absolutepath) {
1.1075.2.47  raeburn  11122:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  11123:                 } else {
1.1075.2.47  raeburn  11124:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11125:                 }
                   11126:             }
1.984     raeburn  11127:         }
                   11128:     }
1.1071    raeburn  11129:     my $dirptr = 16384;
1.984     raeburn  11130:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  11131:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  11132:         if (($actionurl eq '/adm/portfolio') ||
                   11133:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  11134:             my ($sublistref,$listerror) =
                   11135:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   11136:             if (ref($sublistref) eq 'ARRAY') {
                   11137:                 foreach my $line (@{$sublistref}) {
                   11138:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  11139:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  11140:                 }
1.984     raeburn  11141:             }
1.987     raeburn  11142:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11143:             if (opendir(my $dir,$url.'/'.$path)) {
                   11144:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  11145:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   11146:             }
1.1075.2.11  raeburn  11147:         } elsif (($actionurl eq '/adm/dependencies') ||
                   11148:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11149:                   ($args->{'context'} eq 'paste')) ||
                   11150:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11151:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  11152:                 my $dir;
                   11153:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11154:                     $dir = $fileloc;
                   11155:                 } else {
                   11156:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11157:                 }
1.1071    raeburn  11158:                 if ($dir ne '') {
                   11159:                     my ($sublistref,$listerror) =
                   11160:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   11161:                     if (ref($sublistref) eq 'ARRAY') {
                   11162:                         foreach my $line (@{$sublistref}) {
                   11163:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   11164:                                 undef,$mtime)=split(/\&/,$line,12);
                   11165:                             unless (($testdir&$dirptr) ||
                   11166:                                     ($file_name =~ /^\.\.?$/)) {
                   11167:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   11168:                             }
                   11169:                         }
                   11170:                     }
                   11171:                 }
1.984     raeburn  11172:             }
                   11173:         }
                   11174:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  11175:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  11176:                 my $item = $path.'/'.$file;
                   11177:                 unless ($mapping{$item} eq $item) {
                   11178:                     $pathchanges{$item} = 1;
                   11179:                 }
                   11180:                 $existing{$item} = 1;
                   11181:                 $numexisting ++;
                   11182:             } else {
                   11183:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  11184:             }
                   11185:         }
1.1071    raeburn  11186:         if ($actionurl eq '/adm/dependencies') {
                   11187:             foreach my $path (keys(%currsubfile)) {
                   11188:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   11189:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   11190:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  11191:                              next if (($rem ne '') &&
                   11192:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   11193:                                        (ref($navmap) &&
                   11194:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   11195:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11196:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  11197:                              $unused{$path.'/'.$file} = 1; 
                   11198:                          }
                   11199:                     }
                   11200:                 }
                   11201:             }
                   11202:         }
1.984     raeburn  11203:     }
1.987     raeburn  11204:     my %currfile;
1.1075.2.35  raeburn  11205:     if (($actionurl eq '/adm/portfolio') ||
                   11206:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  11207:         my ($dirlistref,$listerror) =
                   11208:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   11209:         if (ref($dirlistref) eq 'ARRAY') {
                   11210:             foreach my $line (@{$dirlistref}) {
                   11211:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   11212:                 $currfile{$file_name} = 1;
                   11213:             }
1.984     raeburn  11214:         }
1.987     raeburn  11215:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11216:         if (opendir(my $dir,$url)) {
1.987     raeburn  11217:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  11218:             map {$currfile{$_} = 1;} @dir_list;
                   11219:         }
1.1075.2.11  raeburn  11220:     } elsif (($actionurl eq '/adm/dependencies') ||
                   11221:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11222:               ($args->{'context'} eq 'paste')) ||
                   11223:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11224:         if ($env{'request.course.id'} ne '') {
                   11225:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11226:             if ($dir ne '') {
                   11227:                 my ($dirlistref,$listerror) =
                   11228:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   11229:                 if (ref($dirlistref) eq 'ARRAY') {
                   11230:                     foreach my $line (@{$dirlistref}) {
                   11231:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   11232:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   11233:                         unless (($testdir&$dirptr) ||
                   11234:                                 ($file_name =~ /^\.\.?$/)) {
                   11235:                             $currfile{$file_name} = [$size,$mtime];
                   11236:                         }
                   11237:                     }
                   11238:                 }
                   11239:             }
                   11240:         }
1.984     raeburn  11241:     }
                   11242:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  11243:         if (exists($currfile{$file})) {
1.987     raeburn  11244:             unless ($mapping{$file} eq $file) {
                   11245:                 $pathchanges{$file} = 1;
                   11246:             }
                   11247:             $existing{$file} = 1;
                   11248:             $numexisting ++;
                   11249:         } else {
1.984     raeburn  11250:             $newfiles{$file} = 1;
                   11251:         }
                   11252:     }
1.1071    raeburn  11253:     foreach my $file (keys(%currfile)) {
                   11254:         unless (($file eq $filename) ||
                   11255:                 ($file eq $filename.'.bak') ||
                   11256:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  11257:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  11258:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   11259:                     next if (($rem ne '') &&
                   11260:                              (($env{"httpref.$rem".$file} ne '') ||
                   11261:                               (ref($navmap) &&
                   11262:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   11263:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11264:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   11265:                 }
1.1075.2.11  raeburn  11266:             }
1.1071    raeburn  11267:             $unused{$file} = 1;
                   11268:         }
                   11269:     }
1.1075.2.11  raeburn  11270:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   11271:         ($args->{'context'} eq 'paste')) {
                   11272:         $counter = scalar(keys(%existing));
                   11273:         $numpathchg = scalar(keys(%pathchanges));
                   11274:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  11275:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   11276:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   11277:         $counter = scalar(keys(%existing));
                   11278:         $numpathchg = scalar(keys(%pathchanges));
                   11279:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  11280:     }
1.984     raeburn  11281:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  11282:         if ($actionurl eq '/adm/dependencies') {
                   11283:             next if ($embed_file =~ m{^\w+://});
                   11284:         }
1.660     raeburn  11285:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11286:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  11287:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  11288:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  11289:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   11290:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  11291:         }
1.1075.2.35  raeburn  11292:         $upload_output .= '</td>';
1.1071    raeburn  11293:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  11294:             $upload_output.='<td align="right">'.
                   11295:                             '<span class="LC_info LC_fontsize_medium">'.
                   11296:                             &mt("URL points to web address").'</span>';
1.987     raeburn  11297:             $numremref++;
1.660     raeburn  11298:         } elsif ($args->{'error_on_invalid_names'}
                   11299:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  11300:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   11301:                             &mt('Invalid characters').'</span>';
1.987     raeburn  11302:             $numinvalid++;
1.660     raeburn  11303:         } else {
1.1075.2.35  raeburn  11304:             $upload_output .= '<td>'.
                   11305:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  11306:                                                      $embed_file,\%mapping,
1.1071    raeburn  11307:                                                      $allfiles,$codebase,'upload');
                   11308:             $counter ++;
                   11309:             $numnew ++;
1.987     raeburn  11310:         }
                   11311:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   11312:     }
                   11313:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  11314:         if ($actionurl eq '/adm/dependencies') {
                   11315:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   11316:             $modify_output .= &start_data_table_row().
                   11317:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   11318:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   11319:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   11320:                               '<td>'.$size.'</td>'.
                   11321:                               '<td>'.$mtime.'</td>'.
                   11322:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   11323:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   11324:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   11325:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   11326:                               &embedded_file_element('upload_embedded',$counter,
                   11327:                                                      $embed_file,\%mapping,
                   11328:                                                      $allfiles,$codebase,'modify').
                   11329:                               '</div></td>'.
                   11330:                               &end_data_table_row()."\n";
                   11331:             $counter ++;
                   11332:         } else {
                   11333:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11334:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   11335:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   11336:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  11337:                               &Apache::loncommon::end_data_table_row()."\n";
                   11338:         }
                   11339:     }
                   11340:     my $delidx = $counter;
                   11341:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   11342:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   11343:         $delete_output .= &start_data_table_row().
                   11344:                           '<td><img src="'.&icon($oldfile).'" />'.
                   11345:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   11346:                           '<td>'.$size.'</td>'.
                   11347:                           '<td>'.$mtime.'</td>'.
                   11348:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   11349:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   11350:                           &embedded_file_element('upload_embedded',$delidx,
                   11351:                                                  $oldfile,\%mapping,$allfiles,
                   11352:                                                  $codebase,'delete').'</td>'.
                   11353:                           &end_data_table_row()."\n"; 
                   11354:         $numunused ++;
                   11355:         $delidx ++;
1.987     raeburn  11356:     }
                   11357:     if ($upload_output) {
                   11358:         $upload_output = &start_data_table().
                   11359:                          $upload_output.
                   11360:                          &end_data_table()."\n";
                   11361:     }
1.1071    raeburn  11362:     if ($modify_output) {
                   11363:         $modify_output = &start_data_table().
                   11364:                          &start_data_table_header_row().
                   11365:                          '<th>'.&mt('File').'</th>'.
                   11366:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11367:                          '<th>'.&mt('Modified').'</th>'.
                   11368:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   11369:                          &end_data_table_header_row().
                   11370:                          $modify_output.
                   11371:                          &end_data_table()."\n";
                   11372:     }
                   11373:     if ($delete_output) {
                   11374:         $delete_output = &start_data_table().
                   11375:                          &start_data_table_header_row().
                   11376:                          '<th>'.&mt('File').'</th>'.
                   11377:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11378:                          '<th>'.&mt('Modified').'</th>'.
                   11379:                          '<th>'.&mt('Delete?').'</th>'.
                   11380:                          &end_data_table_header_row().
                   11381:                          $delete_output.
                   11382:                          &end_data_table()."\n";
                   11383:     }
1.987     raeburn  11384:     my $applies = 0;
                   11385:     if ($numremref) {
                   11386:         $applies ++;
                   11387:     }
                   11388:     if ($numinvalid) {
                   11389:         $applies ++;
                   11390:     }
                   11391:     if ($numexisting) {
                   11392:         $applies ++;
                   11393:     }
1.1071    raeburn  11394:     if ($counter || $numunused) {
1.987     raeburn  11395:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   11396:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  11397:                   $state.'<h3>'.$heading.'</h3>'; 
                   11398:         if ($actionurl eq '/adm/dependencies') {
                   11399:             if ($numnew) {
                   11400:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   11401:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   11402:                            $upload_output.'<br />'."\n";
                   11403:             }
                   11404:             if ($numexisting) {
                   11405:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   11406:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   11407:                            $modify_output.'<br />'."\n";
                   11408:                            $buttontext = &mt('Save changes');
                   11409:             }
                   11410:             if ($numunused) {
                   11411:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   11412:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   11413:                            $delete_output.'<br />'."\n";
                   11414:                            $buttontext = &mt('Save changes');
                   11415:             }
                   11416:         } else {
                   11417:             $output .= $upload_output.'<br />'."\n";
                   11418:         }
                   11419:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   11420:                    $counter.'" />'."\n";
                   11421:         if ($actionurl eq '/adm/dependencies') { 
                   11422:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   11423:                        $numnew.'" />'."\n";
                   11424:         } elsif ($actionurl eq '') {
1.987     raeburn  11425:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   11426:         }
                   11427:     } elsif ($applies) {
                   11428:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   11429:         if ($applies > 1) {
                   11430:             $output .=  
1.1075.2.35  raeburn  11431:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  11432:             if ($numremref) {
                   11433:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   11434:             }
                   11435:             if ($numinvalid) {
                   11436:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   11437:             }
                   11438:             if ($numexisting) {
                   11439:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   11440:             }
                   11441:             $output .= '</ul><br />';
                   11442:         } elsif ($numremref) {
                   11443:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   11444:         } elsif ($numinvalid) {
                   11445:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   11446:         } elsif ($numexisting) {
                   11447:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   11448:         }
                   11449:         $output .= $upload_output.'<br />';
                   11450:     }
                   11451:     my ($pathchange_output,$chgcount);
1.1071    raeburn  11452:     $chgcount = $counter;
1.987     raeburn  11453:     if (keys(%pathchanges) > 0) {
                   11454:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  11455:             if ($counter) {
1.987     raeburn  11456:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   11457:                                                   $embed_file,\%mapping,
1.1071    raeburn  11458:                                                   $allfiles,$codebase,'change');
1.987     raeburn  11459:             } else {
                   11460:                 $pathchange_output .= 
                   11461:                     &start_data_table_row().
                   11462:                     '<td><input type ="checkbox" name="namechange" value="'.
                   11463:                     $chgcount.'" checked="checked" /></td>'.
                   11464:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11465:                     '<td>'.$embed_file.
                   11466:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11467:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11468:                     '</td>'.&end_data_table_row();
1.660     raeburn  11469:             }
1.987     raeburn  11470:             $numpathchg ++;
                   11471:             $chgcount ++;
1.660     raeburn  11472:         }
                   11473:     }
1.1075.2.35  raeburn  11474:     if (($counter) || ($numunused)) {
1.987     raeburn  11475:         if ($numpathchg) {
                   11476:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11477:                        $numpathchg.'" />'."\n";
                   11478:         }
                   11479:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11480:             ($actionurl eq '/adm/imsimport')) {
                   11481:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11482:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11483:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11484:         } elsif ($actionurl eq '/adm/dependencies') {
                   11485:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11486:         }
1.1075.2.35  raeburn  11487:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11488:     } elsif ($numpathchg) {
                   11489:         my %pathchange = ();
                   11490:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11491:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11492:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  11493:         }
1.987     raeburn  11494:     }
1.1071    raeburn  11495:     return ($output,$counter,$numpathchg);
1.987     raeburn  11496: }
                   11497: 
1.1075.2.47  raeburn  11498: =pod
                   11499: 
                   11500: =item * clean_path($name)
                   11501: 
                   11502: Performs clean-up of directories, subdirectories and filename in an
                   11503: embedded object, referenced in an HTML file which is being uploaded
                   11504: to a course or portfolio, where
                   11505: "Upload embedded images/multimedia files if HTML file" checkbox was
                   11506: checked.
                   11507: 
                   11508: Clean-up is similar to replacements in lonnet::clean_filename()
                   11509: except each / between sub-directory and next level is preserved.
                   11510: 
                   11511: =cut
                   11512: 
                   11513: sub clean_path {
                   11514:     my ($embed_file) = @_;
                   11515:     $embed_file =~s{^/+}{};
                   11516:     my @contents;
                   11517:     if ($embed_file =~ m{/}) {
                   11518:         @contents = split(/\//,$embed_file);
                   11519:     } else {
                   11520:         @contents = ($embed_file);
                   11521:     }
                   11522:     my $lastidx = scalar(@contents)-1;
                   11523:     for (my $i=0; $i<=$lastidx; $i++) {
                   11524:         $contents[$i]=~s{\\}{/}g;
                   11525:         $contents[$i]=~s/\s+/\_/g;
                   11526:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   11527:         if ($i == $lastidx) {
                   11528:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   11529:         }
                   11530:     }
                   11531:     if ($lastidx > 0) {
                   11532:         return join('/',@contents);
                   11533:     } else {
                   11534:         return $contents[0];
                   11535:     }
                   11536: }
                   11537: 
1.987     raeburn  11538: sub embedded_file_element {
1.1071    raeburn  11539:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  11540:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   11541:                    (ref($codebase) eq 'HASH'));
                   11542:     my $output;
1.1071    raeburn  11543:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  11544:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   11545:     }
                   11546:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   11547:                &escape($embed_file).'" />';
                   11548:     unless (($context eq 'upload_embedded') && 
                   11549:             ($mapping->{$embed_file} eq $embed_file)) {
                   11550:         $output .='
                   11551:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   11552:     }
                   11553:     my $attrib;
                   11554:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   11555:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   11556:     }
                   11557:     $output .=
                   11558:         "\n\t\t".
                   11559:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   11560:         $attrib.'" />';
                   11561:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   11562:         $output .=
                   11563:             "\n\t\t".
                   11564:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   11565:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  11566:     }
1.987     raeburn  11567:     return $output;
1.660     raeburn  11568: }
                   11569: 
1.1071    raeburn  11570: sub get_dependency_details {
                   11571:     my ($currfile,$currsubfile,$embed_file) = @_;
                   11572:     my ($size,$mtime,$showsize,$showmtime);
                   11573:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   11574:         if ($embed_file =~ m{/}) {
                   11575:             my ($path,$fname) = split(/\//,$embed_file);
                   11576:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   11577:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   11578:             }
                   11579:         } else {
                   11580:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   11581:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   11582:             }
                   11583:         }
                   11584:         $showsize = $size/1024.0;
                   11585:         $showsize = sprintf("%.1f",$showsize);
                   11586:         if ($mtime > 0) {
                   11587:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   11588:         }
                   11589:     }
                   11590:     return ($showsize,$showmtime);
                   11591: }
                   11592: 
                   11593: sub ask_embedded_js {
                   11594:     return <<"END";
                   11595: <script type="text/javascript"">
                   11596: // <![CDATA[
                   11597: function toggleBrowse(counter) {
                   11598:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   11599:     var fileid = document.getElementById('embedded_item_'+counter);
                   11600:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   11601:     if (chkboxid.checked == true) {
                   11602:         uploaddivid.style.display='block';
                   11603:     } else {
                   11604:         uploaddivid.style.display='none';
                   11605:         fileid.value = '';
                   11606:     }
                   11607: }
                   11608: // ]]>
                   11609: </script>
                   11610: 
                   11611: END
                   11612: }
                   11613: 
1.661     raeburn  11614: sub upload_embedded {
                   11615:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  11616:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   11617:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  11618:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   11619:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   11620:         my $orig_uploaded_filename =
                   11621:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  11622:         foreach my $type ('orig','ref','attrib','codebase') {
                   11623:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   11624:                 $env{'form.embedded_'.$type.'_'.$i} =
                   11625:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   11626:             }
                   11627:         }
1.661     raeburn  11628:         my ($path,$fname) =
                   11629:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   11630:         # no path, whole string is fname
                   11631:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   11632:         $fname = &Apache::lonnet::clean_filename($fname);
                   11633:         # See if there is anything left
                   11634:         next if ($fname eq '');
                   11635: 
                   11636:         # Check if file already exists as a file or directory.
                   11637:         my ($state,$msg);
                   11638:         if ($context eq 'portfolio') {
                   11639:             my $port_path = $dirpath;
                   11640:             if ($group ne '') {
                   11641:                 $port_path = "groups/$group/$port_path";
                   11642:             }
1.987     raeburn  11643:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   11644:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  11645:                                               $dir_root,$port_path,$disk_quota,
                   11646:                                               $current_disk_usage,$uname,$udom);
                   11647:             if ($state eq 'will_exceed_quota'
1.984     raeburn  11648:                 || $state eq 'file_locked') {
1.661     raeburn  11649:                 $output .= $msg;
                   11650:                 next;
                   11651:             }
                   11652:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   11653:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   11654:             if ($state eq 'exists') {
                   11655:                 $output .= $msg;
                   11656:                 next;
                   11657:             }
                   11658:         }
                   11659:         # Check if extension is valid
                   11660:         if (($fname =~ /\.(\w+)$/) &&
                   11661:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  11662:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   11663:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  11664:             next;
                   11665:         } elsif (($fname =~ /\.(\w+)$/) &&
                   11666:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  11667:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  11668:             next;
                   11669:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  11670:             $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  11671:             next;
                   11672:         }
                   11673:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  11674:         my $subdir = $path;
                   11675:         $subdir =~ s{/+$}{};
1.661     raeburn  11676:         if ($context eq 'portfolio') {
1.984     raeburn  11677:             my $result;
                   11678:             if ($state eq 'existingfile') {
                   11679:                 $result=
                   11680:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  11681:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  11682:             } else {
1.984     raeburn  11683:                 $result=
                   11684:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  11685:                                                     $dirpath.
1.1075.2.35  raeburn  11686:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  11687:                 if ($result !~ m|^/uploaded/|) {
                   11688:                     $output .= '<span class="LC_error">'
                   11689:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11690:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11691:                                .'</span><br />';
                   11692:                     next;
                   11693:                 } else {
1.987     raeburn  11694:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11695:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  11696:                 }
1.661     raeburn  11697:             }
1.1075.2.35  raeburn  11698:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   11699:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   11700:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  11701:             my $result =
1.1075.2.35  raeburn  11702:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  11703:             if ($result !~ m|^/uploaded/|) {
                   11704:                 $output .= '<span class="LC_error">'
                   11705:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11706:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11707:                            .'</span><br />';
                   11708:                     next;
                   11709:             } else {
                   11710:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11711:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  11712:                 if ($context eq 'syllabus') {
                   11713:                     &Apache::lonnet::make_public_indefinitely($result);
                   11714:                 }
1.987     raeburn  11715:             }
1.661     raeburn  11716:         } else {
                   11717: # Save the file
                   11718:             my $target = $env{'form.embedded_item_'.$i};
                   11719:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   11720:             my $dest = $fullpath.$fname;
                   11721:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  11722:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  11723:             my $count;
                   11724:             my $filepath = $dir_root;
1.1027    raeburn  11725:             foreach my $subdir (@parts) {
                   11726:                 $filepath .= "/$subdir";
                   11727:                 if (!-e $filepath) {
1.661     raeburn  11728:                     mkdir($filepath,0770);
                   11729:                 }
                   11730:             }
                   11731:             my $fh;
                   11732:             if (!open($fh,'>'.$dest)) {
                   11733:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11734:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11735:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11736:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11737:                            '</span><br />';
                   11738:             } else {
                   11739:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11740:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11741:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11742:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11743:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11744:                               '</span><br />';
                   11745:                 } else {
1.987     raeburn  11746:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11747:                                $url.'</span>').'<br />';
                   11748:                     unless ($context eq 'testbank') {
                   11749:                         $footer .= &mt('View embedded file: [_1]',
                   11750:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11751:                     }
                   11752:                 }
                   11753:                 close($fh);
                   11754:             }
                   11755:         }
                   11756:         if ($env{'form.embedded_ref_'.$i}) {
                   11757:             $pathchange{$i} = 1;
                   11758:         }
                   11759:     }
                   11760:     if ($output) {
                   11761:         $output = '<p>'.$output.'</p>';
                   11762:     }
                   11763:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11764:     $returnflag = 'ok';
1.1071    raeburn  11765:     my $numpathchgs = scalar(keys(%pathchange));
                   11766:     if ($numpathchgs > 0) {
1.987     raeburn  11767:         if ($context eq 'portfolio') {
                   11768:             $output .= '<p>'.&mt('or').'</p>';
                   11769:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11770:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11771:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11772:             $returnflag = 'modify_orightml';
                   11773:         }
                   11774:     }
1.1071    raeburn  11775:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11776: }
                   11777: 
                   11778: sub modify_html_form {
                   11779:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11780:     my $end = 0;
                   11781:     my $modifyform;
                   11782:     if ($context eq 'upload_embedded') {
                   11783:         return unless (ref($pathchange) eq 'HASH');
                   11784:         if ($env{'form.number_embedded_items'}) {
                   11785:             $end += $env{'form.number_embedded_items'};
                   11786:         }
                   11787:         if ($env{'form.number_pathchange_items'}) {
                   11788:             $end += $env{'form.number_pathchange_items'};
                   11789:         }
                   11790:         if ($end) {
                   11791:             for (my $i=0; $i<$end; $i++) {
                   11792:                 if ($i < $env{'form.number_embedded_items'}) {
                   11793:                     next unless($pathchange->{$i});
                   11794:                 }
                   11795:                 $modifyform .=
                   11796:                     &start_data_table_row().
                   11797:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   11798:                     'checked="checked" /></td>'.
                   11799:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   11800:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   11801:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   11802:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   11803:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   11804:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   11805:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   11806:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   11807:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   11808:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   11809:                     &end_data_table_row();
1.1071    raeburn  11810:             }
1.987     raeburn  11811:         }
                   11812:     } else {
                   11813:         $modifyform = $pathchgtable;
                   11814:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   11815:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   11816:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11817:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   11818:         }
                   11819:     }
                   11820:     if ($modifyform) {
1.1071    raeburn  11821:         if ($actionurl eq '/adm/dependencies') {
                   11822:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   11823:         }
1.987     raeburn  11824:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   11825:                '<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".
                   11826:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   11827:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   11828:                '</ol></p>'."\n".'<p>'.
                   11829:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   11830:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   11831:                &start_data_table()."\n".
                   11832:                &start_data_table_header_row().
                   11833:                '<th>'.&mt('Change?').'</th>'.
                   11834:                '<th>'.&mt('Current reference').'</th>'.
                   11835:                '<th>'.&mt('Required reference').'</th>'.
                   11836:                &end_data_table_header_row()."\n".
                   11837:                $modifyform.
                   11838:                &end_data_table().'<br />'."\n".$hiddenstate.
                   11839:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   11840:                '</form>'."\n";
                   11841:     }
                   11842:     return;
                   11843: }
                   11844: 
                   11845: sub modify_html_refs {
1.1075.2.35  raeburn  11846:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  11847:     my $container;
                   11848:     if ($context eq 'portfolio') {
                   11849:         $container = $env{'form.container'};
                   11850:     } elsif ($context eq 'coursedoc') {
                   11851:         $container = $env{'form.primaryurl'};
1.1071    raeburn  11852:     } elsif ($context eq 'manage_dependencies') {
                   11853:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   11854:         $container = "/$container";
1.1075.2.35  raeburn  11855:     } elsif ($context eq 'syllabus') {
                   11856:         $container = $url;
1.987     raeburn  11857:     } else {
1.1027    raeburn  11858:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  11859:     }
                   11860:     my (%allfiles,%codebase,$output,$content);
                   11861:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  11862:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  11863:         if (wantarray) {
                   11864:             return ('',0,0); 
                   11865:         } else {
                   11866:             return;
                   11867:         }
                   11868:     }
                   11869:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11870:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  11871:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   11872:             if (wantarray) {
                   11873:                 return ('',0,0);
                   11874:             } else {
                   11875:                 return;
                   11876:             }
                   11877:         } 
1.987     raeburn  11878:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  11879:         if ($content eq '-1') {
                   11880:             if (wantarray) {
                   11881:                 return ('',0,0);
                   11882:             } else {
                   11883:                 return;
                   11884:             }
                   11885:         }
1.987     raeburn  11886:     } else {
1.1071    raeburn  11887:         unless ($container =~ /^\Q$dir_root\E/) {
                   11888:             if (wantarray) {
                   11889:                 return ('',0,0);
                   11890:             } else {
                   11891:                 return;
                   11892:             }
                   11893:         } 
1.1075.2.128  raeburn  11894:         if (open(my $fh,'<',$container)) {
1.987     raeburn  11895:             $content = join('', <$fh>);
                   11896:             close($fh);
                   11897:         } else {
1.1071    raeburn  11898:             if (wantarray) {
                   11899:                 return ('',0,0);
                   11900:             } else {
                   11901:                 return;
                   11902:             }
1.987     raeburn  11903:         }
                   11904:     }
                   11905:     my ($count,$codebasecount) = (0,0);
                   11906:     my $mm = new File::MMagic;
                   11907:     my $mime_type = $mm->checktype_contents($content);
                   11908:     if ($mime_type eq 'text/html') {
                   11909:         my $parse_result = 
                   11910:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   11911:                                                     \%codebase,\$content);
                   11912:         if ($parse_result eq 'ok') {
                   11913:             foreach my $i (@changes) {
                   11914:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   11915:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   11916:                 if ($allfiles{$ref}) {
                   11917:                     my $newname =  $orig;
                   11918:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  11919:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  11920:                     if ($attrib_regexp =~ /:/) {
                   11921:                         $attrib_regexp =~ s/\:/|/g;
                   11922:                     }
                   11923:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11924:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11925:                         $count += $numchg;
1.1075.2.35  raeburn  11926:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  11927:                         delete($allfiles{$ref});
1.987     raeburn  11928:                     }
                   11929:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  11930:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  11931:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   11932:                         $codebasecount ++;
                   11933:                     }
                   11934:                 }
                   11935:             }
1.1075.2.35  raeburn  11936:             my $skiprewrites;
1.987     raeburn  11937:             if ($count || $codebasecount) {
                   11938:                 my $saveresult;
1.1071    raeburn  11939:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11940:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  11941:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11942:                     if ($url eq $container) {
                   11943:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   11944:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11945:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  11946:                                             $fname.'</span>').'</p>';
1.987     raeburn  11947:                     } else {
                   11948:                          $output = '<p class="LC_error">'.
                   11949:                                    &mt('Error: update failed for: [_1].',
                   11950:                                    '<span class="LC_filename">'.
                   11951:                                    $container.'</span>').'</p>';
                   11952:                     }
1.1075.2.35  raeburn  11953:                     if ($context eq 'syllabus') {
                   11954:                         unless ($saveresult eq 'ok') {
                   11955:                             $skiprewrites = 1;
                   11956:                         }
                   11957:                     }
1.987     raeburn  11958:                 } else {
1.1075.2.128  raeburn  11959:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  11960:                         print $fh $content;
                   11961:                         close($fh);
                   11962:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11963:                                   $count,'<span class="LC_filename">'.
                   11964:                                   $container.'</span>').'</p>';
1.661     raeburn  11965:                     } else {
1.987     raeburn  11966:                          $output = '<p class="LC_error">'.
                   11967:                                    &mt('Error: could not update [_1].',
                   11968:                                    '<span class="LC_filename">'.
                   11969:                                    $container.'</span>').'</p>';
1.661     raeburn  11970:                     }
                   11971:                 }
                   11972:             }
1.1075.2.35  raeburn  11973:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   11974:                 my ($actionurl,$state);
                   11975:                 $actionurl = "/public/$udom/$uname/syllabus";
                   11976:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   11977:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   11978:                                               \%codebase,
                   11979:                                               {'context' => 'rewrites',
                   11980:                                                'ignore_remote_references' => 1,});
                   11981:                 if (ref($mapping) eq 'HASH') {
                   11982:                     my $rewrites = 0;
                   11983:                     foreach my $key (keys(%{$mapping})) {
                   11984:                         next if ($key =~ m{^https?://});
                   11985:                         my $ref = $mapping->{$key};
                   11986:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   11987:                         my $attrib;
                   11988:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   11989:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   11990:                         }
                   11991:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11992:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11993:                             $rewrites += $numchg;
                   11994:                         }
                   11995:                     }
                   11996:                     if ($rewrites) {
                   11997:                         my $saveresult;
                   11998:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11999:                         if ($url eq $container) {
                   12000:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   12001:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   12002:                                             $count,'<span class="LC_filename">'.
                   12003:                                             $fname.'</span>').'</p>';
                   12004:                         } else {
                   12005:                             $output .= '<p class="LC_error">'.
                   12006:                                        &mt('Error: could not update links in [_1].',
                   12007:                                        '<span class="LC_filename">'.
                   12008:                                        $container.'</span>').'</p>';
                   12009: 
                   12010:                         }
                   12011:                     }
                   12012:                 }
                   12013:             }
1.987     raeburn  12014:         } else {
                   12015:             &logthis('Failed to parse '.$container.
                   12016:                      ' to modify references: '.$parse_result);
1.661     raeburn  12017:         }
                   12018:     }
1.1071    raeburn  12019:     if (wantarray) {
                   12020:         return ($output,$count,$codebasecount);
                   12021:     } else {
                   12022:         return $output;
                   12023:     }
1.661     raeburn  12024: }
                   12025: 
                   12026: sub check_for_existing {
                   12027:     my ($path,$fname,$element) = @_;
                   12028:     my ($state,$msg);
                   12029:     if (-d $path.'/'.$fname) {
                   12030:         $state = 'exists';
                   12031:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12032:     } elsif (-e $path.'/'.$fname) {
                   12033:         $state = 'exists';
                   12034:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12035:     }
                   12036:     if ($state eq 'exists') {
                   12037:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   12038:     }
                   12039:     return ($state,$msg);
                   12040: }
                   12041: 
                   12042: sub check_for_upload {
                   12043:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   12044:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  12045:     my $filesize = length($env{'form.'.$element});
                   12046:     if (!$filesize) {
                   12047:         my $msg = '<span class="LC_error">'.
                   12048:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   12049:                       '<span class="LC_filename">'.$fname.'</span>',
                   12050:                       $filesize).'<br />'.
1.1007    raeburn  12051:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  12052:                   '</span>';
                   12053:         return ('zero_bytes',$msg);
                   12054:     }
                   12055:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  12056:     my $getpropath = 1;
1.1021    raeburn  12057:     my ($dirlistref,$listerror) =
                   12058:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  12059:     my $found_file = 0;
                   12060:     my $locked_file = 0;
1.991     raeburn  12061:     my @lockers;
                   12062:     my $navmap;
                   12063:     if ($env{'request.course.id'}) {
                   12064:         $navmap = Apache::lonnavmaps::navmap->new();
                   12065:     }
1.1021    raeburn  12066:     if (ref($dirlistref) eq 'ARRAY') {
                   12067:         foreach my $line (@{$dirlistref}) {
                   12068:             my ($file_name,$rest)=split(/\&/,$line,2);
                   12069:             if ($file_name eq $fname){
                   12070:                 $file_name = $path.$file_name;
                   12071:                 if ($group ne '') {
                   12072:                     $file_name = $group.$file_name;
                   12073:                 }
                   12074:                 $found_file = 1;
                   12075:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   12076:                     foreach my $lock (@lockers) {
                   12077:                         if (ref($lock) eq 'ARRAY') {
                   12078:                             my ($symb,$crsid) = @{$lock};
                   12079:                             if ($crsid eq $env{'request.course.id'}) {
                   12080:                                 if (ref($navmap)) {
                   12081:                                     my $res = $navmap->getBySymb($symb);
                   12082:                                     foreach my $part (@{$res->parts()}) { 
                   12083:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   12084:                                         unless (($slot_status == $res->RESERVED) ||
                   12085:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   12086:                                             $locked_file = 1;
                   12087:                                         }
1.991     raeburn  12088:                                     }
1.1021    raeburn  12089:                                 } else {
                   12090:                                     $locked_file = 1;
1.991     raeburn  12091:                                 }
                   12092:                             } else {
                   12093:                                 $locked_file = 1;
                   12094:                             }
                   12095:                         }
1.1021    raeburn  12096:                    }
                   12097:                 } else {
                   12098:                     my @info = split(/\&/,$rest);
                   12099:                     my $currsize = $info[6]/1000;
                   12100:                     if ($currsize < $filesize) {
                   12101:                         my $extra = $filesize - $currsize;
                   12102:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  12103:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  12104:                                       &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  12105:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   12106:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   12107:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  12108:                             return ('will_exceed_quota',$msg);
                   12109:                         }
1.984     raeburn  12110:                     }
                   12111:                 }
1.661     raeburn  12112:             }
                   12113:         }
                   12114:     }
                   12115:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  12116:         my $msg = '<p class="LC_warning">'.
                   12117:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   12118:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  12119:         return ('will_exceed_quota',$msg);
                   12120:     } elsif ($found_file) {
                   12121:         if ($locked_file) {
1.1075.2.69  raeburn  12122:             my $msg = '<p class="LC_warning">';
1.661     raeburn  12123:             $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  12124:             $msg .= '</p>';
1.661     raeburn  12125:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   12126:             return ('file_locked',$msg);
                   12127:         } else {
1.1075.2.69  raeburn  12128:             my $msg = '<p class="LC_error">';
1.984     raeburn  12129:             $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  12130:             $msg .= '</p>';
1.984     raeburn  12131:             return ('existingfile',$msg);
1.661     raeburn  12132:         }
                   12133:     }
                   12134: }
                   12135: 
1.987     raeburn  12136: sub check_for_traversal {
                   12137:     my ($path,$url,$toplevel) = @_;
                   12138:     my @parts=split(/\//,$path);
                   12139:     my $cleanpath;
                   12140:     my $fullpath = $url;
                   12141:     for (my $i=0;$i<@parts;$i++) {
                   12142:         next if ($parts[$i] eq '.');
                   12143:         if ($parts[$i] eq '..') {
                   12144:             $fullpath =~ s{([^/]+/)$}{};
                   12145:         } else {
                   12146:             $fullpath .= $parts[$i].'/';
                   12147:         }
                   12148:     }
                   12149:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   12150:         $cleanpath = $1;
                   12151:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   12152:         my $curr_toprel = $1;
                   12153:         my @parts = split(/\//,$curr_toprel);
                   12154:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   12155:         my @urlparts = split(/\//,$url_toprel);
                   12156:         my $doubledots;
                   12157:         my $startdiff = -1;
                   12158:         for (my $i=0; $i<@urlparts; $i++) {
                   12159:             if ($startdiff == -1) {
                   12160:                 unless ($urlparts[$i] eq $parts[$i]) {
                   12161:                     $startdiff = $i;
                   12162:                     $doubledots .= '../';
                   12163:                 }
                   12164:             } else {
                   12165:                 $doubledots .= '../';
                   12166:             }
                   12167:         }
                   12168:         if ($startdiff > -1) {
                   12169:             $cleanpath = $doubledots;
                   12170:             for (my $i=$startdiff; $i<@parts; $i++) {
                   12171:                 $cleanpath .= $parts[$i].'/';
                   12172:             }
                   12173:         }
                   12174:     }
                   12175:     $cleanpath =~ s{(/)$}{};
                   12176:     return $cleanpath;
                   12177: }
1.31      albertel 12178: 
1.1053    raeburn  12179: sub is_archive_file {
                   12180:     my ($mimetype) = @_;
                   12181:     if (($mimetype eq 'application/octet-stream') ||
                   12182:         ($mimetype eq 'application/x-stuffit') ||
                   12183:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   12184:         return 1;
                   12185:     }
                   12186:     return;
                   12187: }
                   12188: 
                   12189: sub decompress_form {
1.1065    raeburn  12190:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  12191:     my %lt = &Apache::lonlocal::texthash (
                   12192:         this => 'This file is an archive file.',
1.1067    raeburn  12193:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  12194:         itsc => 'Its contents are as follows:',
1.1053    raeburn  12195:         youm => 'You may wish to extract its contents.',
                   12196:         extr => 'Extract contents',
1.1067    raeburn  12197:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   12198:         proa => 'Process automatically?',
1.1053    raeburn  12199:         yes  => 'Yes',
                   12200:         no   => 'No',
1.1067    raeburn  12201:         fold => 'Title for folder containing movie',
                   12202:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  12203:     );
1.1065    raeburn  12204:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  12205:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  12206:     my $info = &list_archive_contents($fileloc,\@paths);
                   12207:     if (@paths) {
                   12208:         foreach my $path (@paths) {
                   12209:             $path =~ s{^/}{};
1.1067    raeburn  12210:             if ($path =~ m{^([^/]+)/$}) {
                   12211:                 $topdir = $1;
                   12212:             }
1.1065    raeburn  12213:             if ($path =~ m{^([^/]+)/}) {
                   12214:                 $toplevel{$1} = $path;
                   12215:             } else {
                   12216:                 $toplevel{$path} = $path;
                   12217:             }
                   12218:         }
                   12219:     }
1.1067    raeburn  12220:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  12221:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  12222:                         "$topdir/media/",
                   12223:                         "$topdir/media/$topdir.mp4",
                   12224:                         "$topdir/media/FirstFrame.png",
                   12225:                         "$topdir/media/player.swf",
                   12226:                         "$topdir/media/swfobject.js",
                   12227:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  12228:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  12229:                          "$topdir/$topdir.mp4",
                   12230:                          "$topdir/$topdir\_config.xml",
                   12231:                          "$topdir/$topdir\_controller.swf",
                   12232:                          "$topdir/$topdir\_embed.css",
                   12233:                          "$topdir/$topdir\_First_Frame.png",
                   12234:                          "$topdir/$topdir\_player.html",
                   12235:                          "$topdir/$topdir\_Thumbnails.png",
                   12236:                          "$topdir/playerProductInstall.swf",
                   12237:                          "$topdir/scripts/",
                   12238:                          "$topdir/scripts/config_xml.js",
                   12239:                          "$topdir/scripts/handlebars.js",
                   12240:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   12241:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   12242:                          "$topdir/scripts/modernizr.js",
                   12243:                          "$topdir/scripts/player-min.js",
                   12244:                          "$topdir/scripts/swfobject.js",
                   12245:                          "$topdir/skins/",
                   12246:                          "$topdir/skins/configuration_express.xml",
                   12247:                          "$topdir/skins/express_show/",
                   12248:                          "$topdir/skins/express_show/player-min.css",
                   12249:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  12250:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   12251:                          "$topdir/$topdir.mp4",
                   12252:                          "$topdir/$topdir\_config.xml",
                   12253:                          "$topdir/$topdir\_controller.swf",
                   12254:                          "$topdir/$topdir\_embed.css",
                   12255:                          "$topdir/$topdir\_First_Frame.png",
                   12256:                          "$topdir/$topdir\_player.html",
                   12257:                          "$topdir/$topdir\_Thumbnails.png",
                   12258:                          "$topdir/playerProductInstall.swf",
                   12259:                          "$topdir/scripts/",
                   12260:                          "$topdir/scripts/config_xml.js",
                   12261:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   12262:                          "$topdir/skins/",
                   12263:                          "$topdir/skins/configuration_express.xml",
                   12264:                          "$topdir/skins/express_show/",
                   12265:                          "$topdir/skins/express_show/spritesheet.min.css",
                   12266:                          "$topdir/skins/express_show/spritesheet.png",
                   12267:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  12268:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  12269:         if (@diffs == 0) {
1.1075.2.59  raeburn  12270:             $is_camtasia = 6;
                   12271:         } else {
1.1075.2.81  raeburn  12272:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  12273:             if (@diffs == 0) {
                   12274:                 $is_camtasia = 8;
1.1075.2.81  raeburn  12275:             } else {
                   12276:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   12277:                 if (@diffs == 0) {
                   12278:                     $is_camtasia = 8;
                   12279:                 }
1.1075.2.59  raeburn  12280:             }
1.1067    raeburn  12281:         }
                   12282:     }
                   12283:     my $output;
                   12284:     if ($is_camtasia) {
                   12285:         $output = <<"ENDCAM";
                   12286: <script type="text/javascript" language="Javascript">
                   12287: // <![CDATA[
                   12288: 
                   12289: function camtasiaToggle() {
                   12290:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   12291:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  12292:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  12293:                 document.getElementById('camtasia_titles').style.display='block';
                   12294:             } else {
                   12295:                 document.getElementById('camtasia_titles').style.display='none';
                   12296:             }
                   12297:         }
                   12298:     }
                   12299:     return;
                   12300: }
                   12301: 
                   12302: // ]]>
                   12303: </script>
                   12304: <p>$lt{'camt'}</p>
                   12305: ENDCAM
1.1065    raeburn  12306:     } else {
1.1067    raeburn  12307:         $output = '<p>'.$lt{'this'};
                   12308:         if ($info eq '') {
                   12309:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   12310:         } else {
                   12311:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   12312:                        '<div><pre>'.$info.'</pre></div>';
                   12313:         }
1.1065    raeburn  12314:     }
1.1067    raeburn  12315:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  12316:     my $duplicates;
                   12317:     my $num = 0;
                   12318:     if (ref($dirlist) eq 'ARRAY') {
                   12319:         foreach my $item (@{$dirlist}) {
                   12320:             if (ref($item) eq 'ARRAY') {
                   12321:                 if (exists($toplevel{$item->[0]})) {
                   12322:                     $duplicates .= 
                   12323:                         &start_data_table_row().
                   12324:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12325:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   12326:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12327:                         'value="1" />'.&mt('Yes').'</label>'.
                   12328:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   12329:                         '<td>'.$item->[0].'</td>';
                   12330:                     if ($item->[2]) {
                   12331:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   12332:                     } else {
                   12333:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   12334:                     }
                   12335:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   12336:                                    '<td>'.
                   12337:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   12338:                                    '</td>'.
                   12339:                                    &end_data_table_row();
                   12340:                     $num ++;
                   12341:                 }
                   12342:             }
                   12343:         }
                   12344:     }
                   12345:     my $itemcount;
                   12346:     if (@paths > 0) {
                   12347:         $itemcount = scalar(@paths);
                   12348:     } else {
                   12349:         $itemcount = 1;
                   12350:     }
1.1067    raeburn  12351:     if ($is_camtasia) {
                   12352:         $output .= $lt{'auto'}.'<br />'.
                   12353:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  12354:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  12355:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   12356:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   12357:                    $lt{'no'}.'</label></span><br />'.
                   12358:                    '<div id="camtasia_titles" style="display:block">'.
                   12359:                    &Apache::lonhtmlcommon::start_pick_box().
                   12360:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   12361:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   12362:                    &Apache::lonhtmlcommon::row_closure().
                   12363:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   12364:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   12365:                    &Apache::lonhtmlcommon::row_closure(1).
                   12366:                    &Apache::lonhtmlcommon::end_pick_box().
                   12367:                    '</div>';
                   12368:     }
1.1065    raeburn  12369:     $output .= 
                   12370:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  12371:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   12372:         "\n";
1.1065    raeburn  12373:     if ($duplicates ne '') {
                   12374:         $output .= '<p><span class="LC_warning">'.
                   12375:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   12376:                    &start_data_table().
                   12377:                    &start_data_table_header_row().
                   12378:                    '<th>'.&mt('Overwrite?').'</th>'.
                   12379:                    '<th>'.&mt('Name').'</th>'.
                   12380:                    '<th>'.&mt('Type').'</th>'.
                   12381:                    '<th>'.&mt('Size').'</th>'.
                   12382:                    '<th>'.&mt('Last modified').'</th>'.
                   12383:                    &end_data_table_header_row().
                   12384:                    $duplicates.
                   12385:                    &end_data_table().
                   12386:                    '</p>';
                   12387:     }
1.1067    raeburn  12388:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  12389:     if (ref($hiddenelements) eq 'HASH') {
                   12390:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   12391:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   12392:         }
                   12393:     }
                   12394:     $output .= <<"END";
1.1067    raeburn  12395: <br />
1.1053    raeburn  12396: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   12397: </form>
                   12398: $noextract
                   12399: END
                   12400:     return $output;
                   12401: }
                   12402: 
1.1065    raeburn  12403: sub decompression_utility {
                   12404:     my ($program) = @_;
                   12405:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   12406:     my $location;
                   12407:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   12408:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   12409:                          '/usr/sbin/') {
                   12410:             if (-x $dir.$program) {
                   12411:                 $location = $dir.$program;
                   12412:                 last;
                   12413:             }
                   12414:         }
                   12415:     }
                   12416:     return $location;
                   12417: }
                   12418: 
                   12419: sub list_archive_contents {
                   12420:     my ($file,$pathsref) = @_;
                   12421:     my (@cmd,$output);
                   12422:     my $needsregexp;
                   12423:     if ($file =~ /\.zip$/) {
                   12424:         @cmd = (&decompression_utility('unzip'),"-l");
                   12425:         $needsregexp = 1;
                   12426:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   12427:              ($file =~ /\.tgz$/)) {
                   12428:         @cmd = (&decompression_utility('tar'),"-ztf");
                   12429:     } elsif ($file =~ /\.tar\.bz2$/) {
                   12430:         @cmd = (&decompression_utility('tar'),"-jtf");
                   12431:     } elsif ($file =~ m|\.tar$|) {
                   12432:         @cmd = (&decompression_utility('tar'),"-tf");
                   12433:     }
                   12434:     if (@cmd) {
                   12435:         undef($!);
                   12436:         undef($@);
                   12437:         if (open(my $fh,"-|", @cmd, $file)) {
                   12438:             while (my $line = <$fh>) {
                   12439:                 $output .= $line;
                   12440:                 chomp($line);
                   12441:                 my $item;
                   12442:                 if ($needsregexp) {
                   12443:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   12444:                 } else {
                   12445:                     $item = $line;
                   12446:                 }
                   12447:                 if ($item ne '') {
                   12448:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   12449:                         push(@{$pathsref},$item);
                   12450:                     } 
                   12451:                 }
                   12452:             }
                   12453:             close($fh);
                   12454:         }
                   12455:     }
                   12456:     return $output;
                   12457: }
                   12458: 
1.1053    raeburn  12459: sub decompress_uploaded_file {
                   12460:     my ($file,$dir) = @_;
                   12461:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   12462:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   12463:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   12464:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12465:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12466:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12467:     my $decompressed = $env{'cgi.decompressed'};
                   12468:     &Apache::lonnet::delenv('cgi.file');
                   12469:     &Apache::lonnet::delenv('cgi.dir');
                   12470:     &Apache::lonnet::delenv('cgi.decompressed');
                   12471:     return ($decompressed,$result);
                   12472: }
                   12473: 
1.1055    raeburn  12474: sub process_decompression {
                   12475:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12476:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12477:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12478:                &mt('Unexpected file path.').'</p>'."\n";
                   12479:     }
                   12480:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12481:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12482:                &mt('Unexpected course context.').'</p>'."\n";
                   12483:     }
                   12484:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12485:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12486:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12487:     }
1.1055    raeburn  12488:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12489:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12490:         $error = &mt('Filename not a supported archive file type.').
                   12491:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12492:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   12493:     } else {
                   12494:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12495:         if ($docuhome eq 'no_host') {
                   12496:             $error = &mt('Could not determine home server for course.');
                   12497:         } else {
                   12498:             my @ids=&Apache::lonnet::current_machine_ids();
                   12499:             my $currdir = "$dir_root/$destination";
                   12500:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12501:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   12502:                        "$dir_root/$destination";
                   12503:             } else {
                   12504:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   12505:                        "$dir_root/$docudom/$docuname/$destination";
                   12506:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   12507:                     $error = &mt('Archive file not found.');
                   12508:                 }
                   12509:             }
1.1065    raeburn  12510:             my (@to_overwrite,@to_skip);
                   12511:             if ($env{'form.archive_overwrite_total'} > 0) {
                   12512:                 my $total = $env{'form.archive_overwrite_total'};
                   12513:                 for (my $i=0; $i<$total; $i++) {
                   12514:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   12515:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   12516:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   12517:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   12518:                     }
                   12519:                 }
                   12520:             }
                   12521:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  12522:             my $numoverwrite = scalar(@to_overwrite);
                   12523:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  12524:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   12525:             } elsif ($dir eq '') {
1.1055    raeburn  12526:                 $error = &mt('Directory containing archive file unavailable.');
                   12527:             } elsif (!$error) {
1.1065    raeburn  12528:                 my ($decompressed,$display);
1.1075.2.128  raeburn  12529:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  12530:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   12531:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  12532:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   12533:                         ($decompressed,$display) =
                   12534:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   12535:                         foreach my $item (@to_skip) {
                   12536:                             if (($item ne '') && ($item !~ /\.\./)) {
                   12537:                                 if (-f "$dir/$tempdir/$item") {
                   12538:                                     unlink("$dir/$tempdir/$item");
                   12539:                                 } elsif (-d "$dir/$tempdir/$item") {
                   12540:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   12541:                                 }
                   12542:                             }
                   12543:                         }
                   12544:                         foreach my $item (@to_overwrite) {
                   12545:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   12546:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   12547:                                     if (-f "$dir/$item") {
                   12548:                                         unlink("$dir/$item");
                   12549:                                     } elsif (-d "$dir/$item") {
                   12550:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   12551:                                     }
                   12552:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   12553:                                 }
1.1065    raeburn  12554:                             }
                   12555:                         }
1.1075.2.128  raeburn  12556:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   12557:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   12558:                         }
1.1065    raeburn  12559:                     }
                   12560:                 } else {
                   12561:                     ($decompressed,$display) = 
                   12562:                         &decompress_uploaded_file($file,$dir);
                   12563:                 }
1.1055    raeburn  12564:                 if ($decompressed eq 'ok') {
1.1065    raeburn  12565:                     $output = '<p class="LC_info">'.
                   12566:                               &mt('Files extracted successfully from archive.').
                   12567:                               '</p>'."\n";
1.1055    raeburn  12568:                     my ($warning,$result,@contents);
                   12569:                     my ($newdirlistref,$newlisterror) =
                   12570:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   12571:                                                  $docuname,1);
                   12572:                     my (%is_dir,%changes,@newitems);
                   12573:                     my $dirptr = 16384;
1.1065    raeburn  12574:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  12575:                         foreach my $dir_line (@{$newdirlistref}) {
                   12576:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  12577:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  12578:                                 push(@newitems,$item);
                   12579:                                 if ($dirptr&$testdir) {
                   12580:                                     $is_dir{$item} = 1;
                   12581:                                 }
                   12582:                                 $changes{$item} = 1;
                   12583:                             }
                   12584:                         }
                   12585:                     }
                   12586:                     if (keys(%changes) > 0) {
                   12587:                         foreach my $item (sort(@newitems)) {
                   12588:                             if ($changes{$item}) {
                   12589:                                 push(@contents,$item);
                   12590:                             }
                   12591:                         }
                   12592:                     }
                   12593:                     if (@contents > 0) {
1.1067    raeburn  12594:                         my $wantform;
                   12595:                         unless ($env{'form.autoextract_camtasia'}) {
                   12596:                             $wantform = 1;
                   12597:                         }
1.1056    raeburn  12598:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  12599:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   12600:                                                                 $currdir,\%is_dir,
                   12601:                                                                 \%children,\%parent,
1.1056    raeburn  12602:                                                                 \@contents,\%dirorder,
                   12603:                                                                 \%titles,$wantform);
1.1055    raeburn  12604:                         if ($datatable ne '') {
                   12605:                             $output .= &archive_options_form('decompressed',$datatable,
                   12606:                                                              $count,$hiddenelem);
1.1065    raeburn  12607:                             my $startcount = 6;
1.1055    raeburn  12608:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  12609:                                                            \%titles,\%children);
1.1055    raeburn  12610:                         }
1.1067    raeburn  12611:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  12612:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  12613:                             my %displayed;
                   12614:                             my $total = 1;
                   12615:                             $env{'form.archive_directory'} = [];
                   12616:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   12617:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   12618:                                 $path =~ s{/$}{};
                   12619:                                 my $item;
                   12620:                                 if ($path ne '') {
                   12621:                                     $item = "$path/$titles{$i}";
                   12622:                                 } else {
                   12623:                                     $item = $titles{$i};
                   12624:                                 }
                   12625:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   12626:                                 if ($item eq $contents[0]) {
                   12627:                                     push(@{$env{'form.archive_directory'}},$i);
                   12628:                                     $env{'form.archive_'.$i} = 'display';
                   12629:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   12630:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  12631:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   12632:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  12633:                                     $env{'form.archive_'.$i} = 'display';
                   12634:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   12635:                                     $displayed{'web'} = $i;
                   12636:                                 } else {
1.1075.2.59  raeburn  12637:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   12638:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   12639:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  12640:                                         push(@{$env{'form.archive_directory'}},$i);
                   12641:                                     }
                   12642:                                     $env{'form.archive_'.$i} = 'dependency';
                   12643:                                 }
                   12644:                                 $total ++;
                   12645:                             }
                   12646:                             for (my $i=1; $i<$total; $i++) {
                   12647:                                 next if ($i == $displayed{'web'});
                   12648:                                 next if ($i == $displayed{'folder'});
                   12649:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   12650:                             }
                   12651:                             $env{'form.phase'} = 'decompress_cleanup';
                   12652:                             $env{'form.archivedelete'} = 1;
                   12653:                             $env{'form.archive_count'} = $total-1;
                   12654:                             $output .=
                   12655:                                 &process_extracted_files('coursedocs',$docudom,
                   12656:                                                          $docuname,$destination,
                   12657:                                                          $dir_root,$hiddenelem);
                   12658:                         }
1.1055    raeburn  12659:                     } else {
                   12660:                         $warning = &mt('No new items extracted from archive file.');
                   12661:                     }
                   12662:                 } else {
                   12663:                     $output = $display;
                   12664:                     $error = &mt('An error occurred during extraction from the archive file.');
                   12665:                 }
                   12666:             }
                   12667:         }
                   12668:     }
                   12669:     if ($error) {
                   12670:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12671:                    $error.'</p>'."\n";
                   12672:     }
                   12673:     if ($warning) {
                   12674:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12675:     }
                   12676:     return $output;
                   12677: }
                   12678: 
                   12679: sub get_extracted {
1.1056    raeburn  12680:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   12681:         $titles,$wantform) = @_;
1.1055    raeburn  12682:     my $count = 0;
                   12683:     my $depth = 0;
                   12684:     my $datatable;
1.1056    raeburn  12685:     my @hierarchy;
1.1055    raeburn  12686:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  12687:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   12688:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  12689:     foreach my $item (@{$contents}) {
                   12690:         $count ++;
1.1056    raeburn  12691:         @{$dirorder->{$count}} = @hierarchy;
                   12692:         $titles->{$count} = $item;
1.1055    raeburn  12693:         &archive_hierarchy($depth,$count,$parent,$children);
                   12694:         if ($wantform) {
                   12695:             $datatable .= &archive_row($is_dir->{$item},$item,
                   12696:                                        $currdir,$depth,$count);
                   12697:         }
                   12698:         if ($is_dir->{$item}) {
                   12699:             $depth ++;
1.1056    raeburn  12700:             push(@hierarchy,$count);
                   12701:             $parent->{$depth} = $count;
1.1055    raeburn  12702:             $datatable .=
                   12703:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  12704:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   12705:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  12706:             $depth --;
1.1056    raeburn  12707:             pop(@hierarchy);
1.1055    raeburn  12708:         }
                   12709:     }
                   12710:     return ($count,$datatable);
                   12711: }
                   12712: 
                   12713: sub recurse_extracted_archive {
1.1056    raeburn  12714:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   12715:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  12716:     my $result='';
1.1056    raeburn  12717:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   12718:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   12719:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  12720:         return $result;
                   12721:     }
                   12722:     my $dirptr = 16384;
                   12723:     my ($newdirlistref,$newlisterror) =
                   12724:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   12725:     if (ref($newdirlistref) eq 'ARRAY') {
                   12726:         foreach my $dir_line (@{$newdirlistref}) {
                   12727:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   12728:             unless ($item =~ /^\.+$/) {
                   12729:                 $$count ++;
1.1056    raeburn  12730:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   12731:                 $titles->{$$count} = $item;
1.1055    raeburn  12732:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  12733: 
1.1055    raeburn  12734:                 my $is_dir;
                   12735:                 if ($dirptr&$testdir) {
                   12736:                     $is_dir = 1;
                   12737:                 }
                   12738:                 if ($wantform) {
                   12739:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   12740:                 }
                   12741:                 if ($is_dir) {
                   12742:                     $$depth ++;
1.1056    raeburn  12743:                     push(@{$hierarchy},$$count);
                   12744:                     $parent->{$$depth} = $$count;
1.1055    raeburn  12745:                     $result .=
                   12746:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   12747:                                                    $docuname,$depth,$count,
1.1056    raeburn  12748:                                                    $hierarchy,$dirorder,$children,
                   12749:                                                    $parent,$titles,$wantform);
1.1055    raeburn  12750:                     $$depth --;
1.1056    raeburn  12751:                     pop(@{$hierarchy});
1.1055    raeburn  12752:                 }
                   12753:             }
                   12754:         }
                   12755:     }
                   12756:     return $result;
                   12757: }
                   12758: 
                   12759: sub archive_hierarchy {
                   12760:     my ($depth,$count,$parent,$children) =@_;
                   12761:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12762:         if (exists($parent->{$depth})) {
                   12763:              $children->{$parent->{$depth}} .= $count.':';
                   12764:         }
                   12765:     }
                   12766:     return;
                   12767: }
                   12768: 
                   12769: sub archive_row {
                   12770:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12771:     my ($name) = ($item =~ m{([^/]+)$});
                   12772:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12773:                                        'display'    => 'Add as file',
1.1055    raeburn  12774:                                        'dependency' => 'Include as dependency',
                   12775:                                        'discard'    => 'Discard',
                   12776:                                       );
                   12777:     if ($is_dir) {
1.1059    raeburn  12778:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12779:     }
1.1056    raeburn  12780:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   12781:     my $offset = 0;
1.1055    raeburn  12782:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  12783:         $offset ++;
1.1065    raeburn  12784:         if ($action ne 'display') {
                   12785:             $offset ++;
                   12786:         }  
1.1055    raeburn  12787:         $output .= '<td><span class="LC_nobreak">'.
                   12788:                    '<label><input type="radio" name="archive_'.$count.
                   12789:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   12790:         my $text = $choices{$action};
                   12791:         if ($is_dir) {
                   12792:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   12793:             if ($action eq 'display') {
1.1059    raeburn  12794:                 $text = &mt('Add as folder');
1.1055    raeburn  12795:             }
1.1056    raeburn  12796:         } else {
                   12797:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   12798: 
                   12799:         }
                   12800:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   12801:         if ($action eq 'dependency') {
                   12802:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   12803:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   12804:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   12805:                        '<option value=""></option>'."\n".
                   12806:                        '</select>'."\n".
                   12807:                        '</div>';
1.1059    raeburn  12808:         } elsif ($action eq 'display') {
                   12809:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   12810:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   12811:                        '</div>';
1.1055    raeburn  12812:         }
1.1056    raeburn  12813:         $output .= '</td>';
1.1055    raeburn  12814:     }
                   12815:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   12816:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   12817:     for (my $i=0; $i<$depth; $i++) {
                   12818:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   12819:     }
                   12820:     if ($is_dir) {
                   12821:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   12822:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   12823:     } else {
                   12824:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   12825:     }
                   12826:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   12827:                &end_data_table_row();
                   12828:     return $output;
                   12829: }
                   12830: 
                   12831: sub archive_options_form {
1.1065    raeburn  12832:     my ($form,$display,$count,$hiddenelem) = @_;
                   12833:     my %lt = &Apache::lonlocal::texthash(
                   12834:                perm => 'Permanently remove archive file?',
                   12835:                hows => 'How should each extracted item be incorporated in the course?',
                   12836:                cont => 'Content actions for all',
                   12837:                addf => 'Add as folder/file',
                   12838:                incd => 'Include as dependency for a displayed file',
                   12839:                disc => 'Discard',
                   12840:                no   => 'No',
                   12841:                yes  => 'Yes',
                   12842:                save => 'Save',
                   12843:     );
                   12844:     my $output = <<"END";
                   12845: <form name="$form" method="post" action="">
                   12846: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   12847: <label>
                   12848:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   12849: </label>
                   12850: &nbsp;
                   12851: <label>
                   12852:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   12853: </span>
                   12854: </p>
                   12855: <input type="hidden" name="phase" value="decompress_cleanup" />
                   12856: <br />$lt{'hows'}
                   12857: <div class="LC_columnSection">
                   12858:   <fieldset>
                   12859:     <legend>$lt{'cont'}</legend>
                   12860:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   12861:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   12862:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   12863:   </fieldset>
                   12864: </div>
                   12865: END
                   12866:     return $output.
1.1055    raeburn  12867:            &start_data_table()."\n".
1.1065    raeburn  12868:            $display."\n".
1.1055    raeburn  12869:            &end_data_table()."\n".
                   12870:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   12871:            $hiddenelem.
1.1065    raeburn  12872:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  12873:            '</form>';
                   12874: }
                   12875: 
                   12876: sub archive_javascript {
1.1056    raeburn  12877:     my ($startcount,$numitems,$titles,$children) = @_;
                   12878:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  12879:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  12880:     my $scripttag = <<START;
                   12881: <script type="text/javascript">
                   12882: // <![CDATA[
                   12883: 
                   12884: function checkAll(form,prefix) {
                   12885:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   12886:     for (var i=0; i < form.elements.length; i++) {
                   12887:         var id = form.elements[i].id;
                   12888:         if ((id != '') && (id != undefined)) {
                   12889:             if (idstr.test(id)) {
                   12890:                 if (form.elements[i].type == 'radio') {
                   12891:                     form.elements[i].checked = true;
1.1056    raeburn  12892:                     var nostart = i-$startcount;
1.1059    raeburn  12893:                     var offset = nostart%7;
                   12894:                     var count = (nostart-offset)/7;    
1.1056    raeburn  12895:                     dependencyCheck(form,count,offset);
1.1055    raeburn  12896:                 }
                   12897:             }
                   12898:         }
                   12899:     }
                   12900: }
                   12901: 
                   12902: function propagateCheck(form,count) {
                   12903:     if (count > 0) {
1.1059    raeburn  12904:         var startelement = $startcount + ((count-1) * 7);
                   12905:         for (var j=1; j<6; j++) {
                   12906:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  12907:                 var item = startelement + j; 
                   12908:                 if (form.elements[item].type == 'radio') {
                   12909:                     if (form.elements[item].checked) {
                   12910:                         containerCheck(form,count,j);
                   12911:                         break;
                   12912:                     }
1.1055    raeburn  12913:                 }
                   12914:             }
                   12915:         }
                   12916:     }
                   12917: }
                   12918: 
                   12919: numitems = $numitems
1.1056    raeburn  12920: var titles = new Array(numitems);
                   12921: var parents = new Array(numitems);
1.1055    raeburn  12922: for (var i=0; i<numitems; i++) {
1.1056    raeburn  12923:     parents[i] = new Array;
1.1055    raeburn  12924: }
1.1059    raeburn  12925: var maintitle = '$maintitle';
1.1055    raeburn  12926: 
                   12927: START
                   12928: 
1.1056    raeburn  12929:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   12930:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  12931:         for (my $i=0; $i<@contents; $i ++) {
                   12932:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   12933:         }
                   12934:     }
                   12935: 
1.1056    raeburn  12936:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   12937:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   12938:     }
                   12939: 
1.1055    raeburn  12940:     $scripttag .= <<END;
                   12941: 
                   12942: function containerCheck(form,count,offset) {
                   12943:     if (count > 0) {
1.1056    raeburn  12944:         dependencyCheck(form,count,offset);
1.1059    raeburn  12945:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  12946:         form.elements[item].checked = true;
                   12947:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12948:             if (parents[count].length > 0) {
                   12949:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  12950:                     containerCheck(form,parents[count][j],offset);
                   12951:                 }
                   12952:             }
                   12953:         }
                   12954:     }
                   12955: }
                   12956: 
                   12957: function dependencyCheck(form,count,offset) {
                   12958:     if (count > 0) {
1.1059    raeburn  12959:         var chosen = (offset+$startcount)+7*(count-1);
                   12960:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  12961:         var currtype = form.elements[depitem].type;
                   12962:         if (form.elements[chosen].value == 'dependency') {
                   12963:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   12964:             form.elements[depitem].options.length = 0;
                   12965:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  12966:             for (var i=1; i<=numitems; i++) {
                   12967:                 if (i == count) {
                   12968:                     continue;
                   12969:                 }
1.1059    raeburn  12970:                 var startelement = $startcount + (i-1) * 7;
                   12971:                 for (var j=1; j<6; j++) {
                   12972:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  12973:                         var item = startelement + j;
                   12974:                         if (form.elements[item].type == 'radio') {
                   12975:                             if (form.elements[item].checked) {
                   12976:                                 if (form.elements[item].value == 'display') {
                   12977:                                     var n = form.elements[depitem].options.length;
                   12978:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   12979:                                 }
                   12980:                             }
                   12981:                         }
                   12982:                     }
                   12983:                 }
                   12984:             }
                   12985:         } else {
                   12986:             document.getElementById('arc_depon_'+count).style.display='none';
                   12987:             form.elements[depitem].options.length = 0;
                   12988:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   12989:         }
1.1059    raeburn  12990:         titleCheck(form,count,offset);
1.1056    raeburn  12991:     }
                   12992: }
                   12993: 
                   12994: function propagateSelect(form,count,offset) {
                   12995:     if (count > 0) {
1.1065    raeburn  12996:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  12997:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   12998:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12999:             if (parents[count].length > 0) {
                   13000:                 for (var j=0; j<parents[count].length; j++) {
                   13001:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  13002:                 }
                   13003:             }
                   13004:         }
                   13005:     }
                   13006: }
1.1056    raeburn  13007: 
                   13008: function containerSelect(form,count,offset,picked) {
                   13009:     if (count > 0) {
1.1065    raeburn  13010:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  13011:         if (form.elements[item].type == 'radio') {
                   13012:             if (form.elements[item].value == 'dependency') {
                   13013:                 if (form.elements[item+1].type == 'select-one') {
                   13014:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   13015:                         if (form.elements[item+1].options[i].value == picked) {
                   13016:                             form.elements[item+1].selectedIndex = i;
                   13017:                             break;
                   13018:                         }
                   13019:                     }
                   13020:                 }
                   13021:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13022:                     if (parents[count].length > 0) {
                   13023:                         for (var j=0; j<parents[count].length; j++) {
                   13024:                             containerSelect(form,parents[count][j],offset,picked);
                   13025:                         }
                   13026:                     }
                   13027:                 }
                   13028:             }
                   13029:         }
                   13030:     }
                   13031: }
                   13032: 
1.1059    raeburn  13033: function titleCheck(form,count,offset) {
                   13034:     if (count > 0) {
                   13035:         var chosen = (offset+$startcount)+7*(count-1);
                   13036:         var depitem = $startcount + ((count-1) * 7) + 2;
                   13037:         var currtype = form.elements[depitem].type;
                   13038:         if (form.elements[chosen].value == 'display') {
                   13039:             document.getElementById('arc_title_'+count).style.display='block';
                   13040:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   13041:                 document.getElementById('archive_title_'+count).value=maintitle;
                   13042:             }
                   13043:         } else {
                   13044:             document.getElementById('arc_title_'+count).style.display='none';
                   13045:             if (currtype == 'text') { 
                   13046:                 document.getElementById('archive_title_'+count).value='';
                   13047:             }
                   13048:         }
                   13049:     }
                   13050:     return;
                   13051: }
                   13052: 
1.1055    raeburn  13053: // ]]>
                   13054: </script>
                   13055: END
                   13056:     return $scripttag;
                   13057: }
                   13058: 
                   13059: sub process_extracted_files {
1.1067    raeburn  13060:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  13061:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  13062:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  13063:     my @ids=&Apache::lonnet::current_machine_ids();
                   13064:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  13065:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  13066:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   13067:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   13068:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   13069:         $pathtocheck = "$dir_root/$destination";
                   13070:         $dir = $dir_root;
                   13071:         $ishome = 1;
                   13072:     } else {
                   13073:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   13074:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  13075:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  13076:     }
                   13077:     my $currdir = "$dir_root/$destination";
                   13078:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   13079:     if ($env{'form.folderpath'}) {
                   13080:         my @items = split('&',$env{'form.folderpath'});
                   13081:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  13082:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   13083:             $containers{'0'}='page';
                   13084:         } else {
                   13085:             $containers{'0'}='sequence';
                   13086:         }
1.1055    raeburn  13087:     }
                   13088:     my @archdirs = &get_env_multiple('form.archive_directory');
                   13089:     if ($numitems) {
                   13090:         for (my $i=1; $i<=$numitems; $i++) {
                   13091:             my $path = $env{'form.archive_content_'.$i};
                   13092:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   13093:                 my $item = $1;
                   13094:                 $toplevelitems{$item} = $i;
                   13095:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   13096:                     $is_dir{$item} = 1;
                   13097:                 }
                   13098:             }
                   13099:         }
                   13100:     }
1.1067    raeburn  13101:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  13102:     if (keys(%toplevelitems) > 0) {
                   13103:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  13104:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   13105:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  13106:     }
1.1066    raeburn  13107:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  13108:     if ($numitems) {
                   13109:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  13110:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  13111:             my $path = $env{'form.archive_content_'.$i};
                   13112:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13113:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   13114:                     if ($prefix ne '' && $path ne '') {
                   13115:                         if (-e $prefix.$path) {
1.1066    raeburn  13116:                             if ((@archdirs > 0) && 
                   13117:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   13118:                                 $todeletedir{$prefix.$path} = 1;
                   13119:                             } else {
                   13120:                                 $todelete{$prefix.$path} = 1;
                   13121:                             }
1.1055    raeburn  13122:                         }
                   13123:                     }
                   13124:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  13125:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  13126:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  13127:                     $docstitle = $env{'form.archive_title_'.$i};
                   13128:                     if ($docstitle eq '') {
                   13129:                         $docstitle = $title;
                   13130:                     }
1.1055    raeburn  13131:                     $outer = 0;
1.1056    raeburn  13132:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13133:                         if (@{$dirorder{$i}} > 0) {
                   13134:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  13135:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   13136:                                     $outer = $item;
                   13137:                                     last;
                   13138:                                 }
                   13139:                             }
                   13140:                         }
                   13141:                     }
                   13142:                     my ($errtext,$fatal) = 
                   13143:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   13144:                                                '/'.$folders{$outer}.'.'.
                   13145:                                                $containers{$outer});
                   13146:                     next if ($fatal);
                   13147:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   13148:                         if ($context eq 'coursedocs') {
1.1056    raeburn  13149:                             $mapinner{$i} = time;
1.1055    raeburn  13150:                             $folders{$i} = 'default_'.$mapinner{$i};
                   13151:                             $containers{$i} = 'sequence';
                   13152:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13153:                                       $folders{$i}.'.'.$containers{$i};
                   13154:                             my $newidx = &LONCAPA::map::getresidx();
                   13155:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  13156:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  13157:                             push(@LONCAPA::map::order,$newidx);
                   13158:                             my ($outtext,$errtext) =
                   13159:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13160:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  13161:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  13162:                             $newseqid{$i} = $newidx;
1.1067    raeburn  13163:                             unless ($errtext) {
1.1075.2.128  raeburn  13164:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   13165:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   13166:                                             '</li>'."\n";
1.1067    raeburn  13167:                             }
1.1055    raeburn  13168:                         }
                   13169:                     } else {
                   13170:                         if ($context eq 'coursedocs') {
                   13171:                             my $newidx=&LONCAPA::map::getresidx();
                   13172:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13173:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   13174:                                       $title;
1.1075.2.167  raeburn  13175:                             if (($outer !~ /\D/) &&
                   13176:                                 (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
                   13177:                                 ($newidx !~ /\D/)) {
1.1075.2.128  raeburn  13178:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   13179:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  13180:                                 }
1.1075.2.128  raeburn  13181:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13182:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   13183:                                 }
                   13184:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13185:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   13186:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   13187:                                         unless ($ishome) {
                   13188:                                             my $fetch = "$newdest{$i}/$title";
                   13189:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   13190:                                             $prompttofetch{$fetch} = 1;
                   13191:                                         }
                   13192:                                    }
                   13193:                                 }
                   13194:                                 $LONCAPA::map::resources[$newidx]=
                   13195:                                     $docstitle.':'.$url.':false:normal:res';
                   13196:                                 push(@LONCAPA::map::order, $newidx);
                   13197:                                 my ($outtext,$errtext)=
                   13198:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13199:                                                             $docuname.'/'.$folders{$outer}.
                   13200:                                                             '.'.$containers{$outer},1,1);
                   13201:                                 unless ($errtext) {
                   13202:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   13203:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   13204:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   13205:                                                    '</li>'."\n";
                   13206:                                     }
1.1067    raeburn  13207:                                 }
1.1075.2.128  raeburn  13208:                             } else {
                   13209:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13210:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  13211:                             }
1.1055    raeburn  13212:                         }
                   13213:                     }
1.1075.2.11  raeburn  13214:                 }
                   13215:             } else {
1.1075.2.128  raeburn  13216:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13217:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  13218:             }
                   13219:         }
                   13220:         for (my $i=1; $i<=$numitems; $i++) {
                   13221:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   13222:             my $path = $env{'form.archive_content_'.$i};
                   13223:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13224:                 my ($title) = ($path =~ m{/([^/]+)$});
                   13225:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   13226:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   13227:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13228:                         my ($itemidx,$fullpath,$relpath);
                   13229:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   13230:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  13231:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  13232:                                 if ($dirorder{$i}->[$j] eq $container) {
                   13233:                                     $itemidx = $j;
1.1056    raeburn  13234:                                 }
                   13235:                             }
1.1075.2.11  raeburn  13236:                         }
                   13237:                         if ($itemidx eq '') {
                   13238:                             $itemidx =  0;
                   13239:                         }
                   13240:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   13241:                             if ($mapinner{$referrer{$i}}) {
                   13242:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   13243:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13244:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13245:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13246:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13247:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13248:                                             if (!-e $fullpath) {
                   13249:                                                 mkdir($fullpath,0755);
1.1056    raeburn  13250:                                             }
                   13251:                                         }
1.1075.2.11  raeburn  13252:                                     } else {
                   13253:                                         last;
1.1056    raeburn  13254:                                     }
1.1075.2.11  raeburn  13255:                                 }
                   13256:                             }
                   13257:                         } elsif ($newdest{$referrer{$i}}) {
                   13258:                             $fullpath = $newdest{$referrer{$i}};
                   13259:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13260:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   13261:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   13262:                                     last;
                   13263:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13264:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13265:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13266:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13267:                                         if (!-e $fullpath) {
                   13268:                                             mkdir($fullpath,0755);
1.1056    raeburn  13269:                                         }
                   13270:                                     }
1.1075.2.11  raeburn  13271:                                 } else {
                   13272:                                     last;
1.1056    raeburn  13273:                                 }
1.1075.2.11  raeburn  13274:                             }
                   13275:                         }
                   13276:                         if ($fullpath ne '') {
                   13277:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  13278:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   13279:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   13280:                                 }
1.1075.2.11  raeburn  13281:                             }
                   13282:                             if (-e "$fullpath/$title") {
                   13283:                                 my $showpath;
                   13284:                                 if ($relpath ne '') {
                   13285:                                     $showpath = "$relpath/$title";
                   13286:                                 } else {
                   13287:                                     $showpath = "/$title";
1.1056    raeburn  13288:                                 }
1.1075.2.128  raeburn  13289:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   13290:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   13291:                                            '</li>'."\n";
                   13292:                                 unless ($ishome) {
                   13293:                                     my $fetch = "$fullpath/$title";
                   13294:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   13295:                                     $prompttofetch{$fetch} = 1;
                   13296:                                 }
1.1055    raeburn  13297:                             }
                   13298:                         }
                   13299:                     }
1.1075.2.11  raeburn  13300:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   13301:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  13302:                                     &HTML::Entities::encode($path,'<>&"'),
                   13303:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   13304:                                 '<br />';
1.1055    raeburn  13305:                 }
                   13306:             } else {
1.1075.2.128  raeburn  13307:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13308:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  13309:             }
                   13310:         }
                   13311:         if (keys(%todelete)) {
                   13312:             foreach my $key (keys(%todelete)) {
                   13313:                 unlink($key);
1.1066    raeburn  13314:             }
                   13315:         }
                   13316:         if (keys(%todeletedir)) {
                   13317:             foreach my $key (keys(%todeletedir)) {
                   13318:                 rmdir($key);
                   13319:             }
                   13320:         }
                   13321:         foreach my $dir (sort(keys(%is_dir))) {
                   13322:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   13323:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  13324:             }
                   13325:         }
1.1067    raeburn  13326:         if ($result ne '') {
                   13327:             $output .= '<ul>'."\n".
                   13328:                        $result."\n".
                   13329:                        '</ul>';
                   13330:         }
                   13331:         unless ($ishome) {
                   13332:             my $replicationfail;
                   13333:             foreach my $item (keys(%prompttofetch)) {
                   13334:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   13335:                 unless ($fetchresult eq 'ok') {
                   13336:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   13337:                 }
                   13338:             }
                   13339:             if ($replicationfail) {
                   13340:                 $output .= '<p class="LC_error">'.
                   13341:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   13342:                            $replicationfail.
                   13343:                            '</ul></p>';
                   13344:             }
                   13345:         }
1.1055    raeburn  13346:     } else {
                   13347:         $warning = &mt('No items found in archive.');
                   13348:     }
                   13349:     if ($error) {
                   13350:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13351:                    $error.'</p>'."\n";
                   13352:     }
                   13353:     if ($warning) {
                   13354:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13355:     }
                   13356:     return $output;
                   13357: }
                   13358: 
1.1066    raeburn  13359: sub cleanup_empty_dirs {
                   13360:     my ($path) = @_;
                   13361:     if (($path ne '') && (-d $path)) {
                   13362:         if (opendir(my $dirh,$path)) {
                   13363:             my @dircontents = grep(!/^\./,readdir($dirh));
                   13364:             my $numitems = 0;
                   13365:             foreach my $item (@dircontents) {
                   13366:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  13367:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  13368:                     if (-e "$path/$item") {
                   13369:                         $numitems ++;
                   13370:                     }
                   13371:                 } else {
                   13372:                     $numitems ++;
                   13373:                 }
                   13374:             }
                   13375:             if ($numitems == 0) {
                   13376:                 rmdir($path);
                   13377:             }
                   13378:             closedir($dirh);
                   13379:         }
                   13380:     }
                   13381:     return;
                   13382: }
                   13383: 
1.41      ng       13384: =pod
1.45      matthew  13385: 
1.1075.2.56  raeburn  13386: =item * &get_folder_hierarchy()
1.1068    raeburn  13387: 
                   13388: Provides hierarchy of names of folders/sub-folders containing the current
                   13389: item,
                   13390: 
                   13391: Inputs: 3
                   13392:      - $navmap - navmaps object
                   13393: 
                   13394:      - $map - url for map (either the trigger itself, or map containing
                   13395:                            the resource, which is the trigger).
                   13396: 
                   13397:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   13398: 
                   13399: Outputs: 1 @pathitems - array of folder/subfolder names.
                   13400: 
                   13401: =cut
                   13402: 
                   13403: sub get_folder_hierarchy {
                   13404:     my ($navmap,$map,$showitem) = @_;
                   13405:     my @pathitems;
                   13406:     if (ref($navmap)) {
                   13407:         my $mapres = $navmap->getResourceByUrl($map);
                   13408:         if (ref($mapres)) {
                   13409:             my $pcslist = $mapres->map_hierarchy();
                   13410:             if ($pcslist ne '') {
                   13411:                 my @pcs = split(/,/,$pcslist);
                   13412:                 foreach my $pc (@pcs) {
                   13413:                     if ($pc == 1) {
1.1075.2.38  raeburn  13414:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  13415:                     } else {
                   13416:                         my $res = $navmap->getByMapPc($pc);
                   13417:                         if (ref($res)) {
                   13418:                             my $title = $res->compTitle();
                   13419:                             $title =~ s/\W+/_/g;
                   13420:                             if ($title ne '') {
                   13421:                                 push(@pathitems,$title);
                   13422:                             }
                   13423:                         }
                   13424:                     }
                   13425:                 }
                   13426:             }
1.1071    raeburn  13427:             if ($showitem) {
                   13428:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  13429:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  13430:                 } else {
                   13431:                     my $maptitle = $mapres->compTitle();
                   13432:                     $maptitle =~ s/\W+/_/g;
                   13433:                     if ($maptitle ne '') {
                   13434:                         push(@pathitems,$maptitle);
                   13435:                     }
1.1068    raeburn  13436:                 }
                   13437:             }
                   13438:         }
                   13439:     }
                   13440:     return @pathitems;
                   13441: }
                   13442: 
                   13443: =pod
                   13444: 
1.1015    raeburn  13445: =item * &get_turnedin_filepath()
                   13446: 
                   13447: Determines path in a user's portfolio file for storage of files uploaded
                   13448: to a specific essayresponse or dropbox item.
                   13449: 
                   13450: Inputs: 3 required + 1 optional.
                   13451: $symb is symb for resource, $uname and $udom are for current user (required).
                   13452: $caller is optional (can be "submission", if routine is called when storing
                   13453: an upoaded file when "Submit Answer" button was pressed).
                   13454: 
                   13455: Returns array containing $path and $multiresp. 
                   13456: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   13457: than one file upload item.  Callers of routine should append partid as a 
                   13458: subdirectory to $path in cases where $multiresp is 1.
                   13459: 
                   13460: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   13461: 
                   13462: =cut
                   13463: 
                   13464: sub get_turnedin_filepath {
                   13465:     my ($symb,$uname,$udom,$caller) = @_;
                   13466:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13467:     my $turnindir;
                   13468:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13469:     $turnindir = $userhash{'turnindir'};
                   13470:     my ($path,$multiresp);
                   13471:     if ($turnindir eq '') {
                   13472:         if ($caller eq 'submission') {
                   13473:             $turnindir = &mt('turned in');
                   13474:             $turnindir =~ s/\W+/_/g;
                   13475:             my %newhash = (
                   13476:                             'turnindir' => $turnindir,
                   13477:                           );
                   13478:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13479:         }
                   13480:     }
                   13481:     if ($turnindir ne '') {
                   13482:         $path = '/'.$turnindir.'/';
                   13483:         my ($multipart,$turnin,@pathitems);
                   13484:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13485:         if (defined($navmap)) {
                   13486:             my $mapres = $navmap->getResourceByUrl($map);
                   13487:             if (ref($mapres)) {
                   13488:                 my $pcslist = $mapres->map_hierarchy();
                   13489:                 if ($pcslist ne '') {
                   13490:                     foreach my $pc (split(/,/,$pcslist)) {
                   13491:                         my $res = $navmap->getByMapPc($pc);
                   13492:                         if (ref($res)) {
                   13493:                             my $title = $res->compTitle();
                   13494:                             $title =~ s/\W+/_/g;
                   13495:                             if ($title ne '') {
1.1075.2.48  raeburn  13496:                                 if (($pc > 1) && (length($title) > 12)) {
                   13497:                                     $title = substr($title,0,12);
                   13498:                                 }
1.1015    raeburn  13499:                                 push(@pathitems,$title);
                   13500:                             }
                   13501:                         }
                   13502:                     }
                   13503:                 }
                   13504:                 my $maptitle = $mapres->compTitle();
                   13505:                 $maptitle =~ s/\W+/_/g;
                   13506:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  13507:                     if (length($maptitle) > 12) {
                   13508:                         $maptitle = substr($maptitle,0,12);
                   13509:                     }
1.1015    raeburn  13510:                     push(@pathitems,$maptitle);
                   13511:                 }
                   13512:                 unless ($env{'request.state'} eq 'construct') {
                   13513:                     my $res = $navmap->getBySymb($symb);
                   13514:                     if (ref($res)) {
                   13515:                         my $partlist = $res->parts();
                   13516:                         my $totaluploads = 0;
                   13517:                         if (ref($partlist) eq 'ARRAY') {
                   13518:                             foreach my $part (@{$partlist}) {
                   13519:                                 my @types = $res->responseType($part);
                   13520:                                 my @ids = $res->responseIds($part);
                   13521:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   13522:                                     if ($types[$i] eq 'essay') {
                   13523:                                         my $partid = $part.'_'.$ids[$i];
                   13524:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   13525:                                             $totaluploads ++;
                   13526:                                         }
                   13527:                                     }
                   13528:                                 }
                   13529:                             }
                   13530:                             if ($totaluploads > 1) {
                   13531:                                 $multiresp = 1;
                   13532:                             }
                   13533:                         }
                   13534:                     }
                   13535:                 }
                   13536:             } else {
                   13537:                 return;
                   13538:             }
                   13539:         } else {
                   13540:             return;
                   13541:         }
                   13542:         my $restitle=&Apache::lonnet::gettitle($symb);
                   13543:         $restitle =~ s/\W+/_/g;
                   13544:         if ($restitle eq '') {
                   13545:             $restitle = ($resurl =~ m{/[^/]+$});
                   13546:             if ($restitle eq '') {
                   13547:                 $restitle = time;
                   13548:             }
                   13549:         }
1.1075.2.48  raeburn  13550:         if (length($restitle) > 12) {
                   13551:             $restitle = substr($restitle,0,12);
                   13552:         }
1.1015    raeburn  13553:         push(@pathitems,$restitle);
                   13554:         $path .= join('/',@pathitems);
                   13555:     }
                   13556:     return ($path,$multiresp);
                   13557: }
                   13558: 
                   13559: =pod
                   13560: 
1.464     albertel 13561: =back
1.41      ng       13562: 
1.112     bowersj2 13563: =head1 CSV Upload/Handling functions
1.38      albertel 13564: 
1.41      ng       13565: =over 4
                   13566: 
1.648     raeburn  13567: =item * &upfile_store($r)
1.41      ng       13568: 
                   13569: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 13570: needs $env{'form.upfile'}
1.41      ng       13571: returns $datatoken to be put into hidden field
                   13572: 
                   13573: =cut
1.31      albertel 13574: 
                   13575: sub upfile_store {
                   13576:     my $r=shift;
1.258     albertel 13577:     $env{'form.upfile'}=~s/\r/\n/gs;
                   13578:     $env{'form.upfile'}=~s/\f/\n/gs;
                   13579:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   13580:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 13581: 
1.1075.2.128  raeburn  13582:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   13583:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   13584:                                      time.'_'.$$);
                   13585:     return if ($datatoken eq '');
                   13586: 
1.31      albertel 13587:     {
1.158     raeburn  13588:         my $datafile = $r->dir_config('lonDaemons').
                   13589:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  13590:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 13591:             print $fh $env{'form.upfile'};
1.158     raeburn  13592:             close($fh);
                   13593:         }
1.31      albertel 13594:     }
                   13595:     return $datatoken;
                   13596: }
                   13597: 
1.56      matthew  13598: =pod
                   13599: 
1.1075.2.128  raeburn  13600: =item * &load_tmp_file($r,$datatoken)
1.41      ng       13601: 
                   13602: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  13603: $datatoken is the name to assign to the temporary file.
1.258     albertel 13604: sets $env{'form.upfile'} to the contents of the file
1.41      ng       13605: 
                   13606: =cut
1.31      albertel 13607: 
                   13608: sub load_tmp_file {
1.1075.2.128  raeburn  13609:     my ($r,$datatoken) = @_;
                   13610:     return if ($datatoken eq '');
1.31      albertel 13611:     my @studentdata=();
                   13612:     {
1.158     raeburn  13613:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  13614:                               '/tmp/'.$datatoken.'.tmp';
                   13615:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  13616:             @studentdata=<$fh>;
                   13617:             close($fh);
                   13618:         }
1.31      albertel 13619:     }
1.258     albertel 13620:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 13621: }
                   13622: 
1.1075.2.128  raeburn  13623: sub valid_datatoken {
                   13624:     my ($datatoken) = @_;
1.1075.2.131  raeburn  13625:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128  raeburn  13626:         return $datatoken;
                   13627:     }
                   13628:     return;
                   13629: }
                   13630: 
1.56      matthew  13631: =pod
                   13632: 
1.648     raeburn  13633: =item * &upfile_record_sep()
1.41      ng       13634: 
                   13635: Separate uploaded file into records
                   13636: returns array of records,
1.258     albertel 13637: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       13638: 
                   13639: =cut
1.31      albertel 13640: 
                   13641: sub upfile_record_sep {
1.258     albertel 13642:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 13643:     } else {
1.248     albertel 13644: 	my @records;
1.258     albertel 13645: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 13646: 	    if ($line=~/^\s*$/) { next; }
                   13647: 	    push(@records,$line);
                   13648: 	}
                   13649: 	return @records;
1.31      albertel 13650:     }
                   13651: }
                   13652: 
1.56      matthew  13653: =pod
                   13654: 
1.648     raeburn  13655: =item * &record_sep($record)
1.41      ng       13656: 
1.258     albertel 13657: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       13658: 
                   13659: =cut
                   13660: 
1.263     www      13661: sub takeleft {
                   13662:     my $index=shift;
                   13663:     return substr('0000'.$index,-4,4);
                   13664: }
                   13665: 
1.31      albertel 13666: sub record_sep {
                   13667:     my $record=shift;
                   13668:     my %components=();
1.258     albertel 13669:     if ($env{'form.upfiletype'} eq 'xml') {
                   13670:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 13671:         my $i=0;
1.356     albertel 13672:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 13673:             $field=~s/^(\"|\')//;
                   13674:             $field=~s/(\"|\')$//;
1.263     www      13675:             $components{&takeleft($i)}=$field;
1.31      albertel 13676:             $i++;
                   13677:         }
1.258     albertel 13678:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 13679:         my $i=0;
1.356     albertel 13680:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 13681:             $field=~s/^(\"|\')//;
                   13682:             $field=~s/(\"|\')$//;
1.263     www      13683:             $components{&takeleft($i)}=$field;
1.31      albertel 13684:             $i++;
                   13685:         }
                   13686:     } else {
1.561     www      13687:         my $separator=',';
1.480     banghart 13688:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      13689:             $separator=';';
1.480     banghart 13690:         }
1.31      albertel 13691:         my $i=0;
1.561     www      13692: # the character we are looking for to indicate the end of a quote or a record 
                   13693:         my $looking_for=$separator;
                   13694: # do not add the characters to the fields
                   13695:         my $ignore=0;
                   13696: # we just encountered a separator (or the beginning of the record)
                   13697:         my $just_found_separator=1;
                   13698: # store the field we are working on here
                   13699:         my $field='';
                   13700: # work our way through all characters in record
                   13701:         foreach my $character ($record=~/(.)/g) {
                   13702:             if ($character eq $looking_for) {
                   13703:                if ($character ne $separator) {
                   13704: # Found the end of a quote, again looking for separator
                   13705:                   $looking_for=$separator;
                   13706:                   $ignore=1;
                   13707:                } else {
                   13708: # Found a separator, store away what we got
                   13709:                   $components{&takeleft($i)}=$field;
                   13710: 	          $i++;
                   13711:                   $just_found_separator=1;
                   13712:                   $ignore=0;
                   13713:                   $field='';
                   13714:                }
                   13715:                next;
                   13716:             }
                   13717: # single or double quotation marks after a separator indicate beginning of a quote
                   13718: # we are now looking for the end of the quote and need to ignore separators
                   13719:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   13720:                $looking_for=$character;
                   13721:                next;
                   13722:             }
                   13723: # ignore would be true after we reached the end of a quote
                   13724:             if ($ignore) { next; }
                   13725:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   13726:             $field.=$character;
                   13727:             $just_found_separator=0; 
1.31      albertel 13728:         }
1.561     www      13729: # catch the very last entry, since we never encountered the separator
                   13730:         $components{&takeleft($i)}=$field;
1.31      albertel 13731:     }
                   13732:     return %components;
                   13733: }
                   13734: 
1.144     matthew  13735: ######################################################
                   13736: ######################################################
                   13737: 
1.56      matthew  13738: =pod
                   13739: 
1.648     raeburn  13740: =item * &upfile_select_html()
1.41      ng       13741: 
1.144     matthew  13742: Return HTML code to select a file from the users machine and specify 
                   13743: the file type.
1.41      ng       13744: 
                   13745: =cut
                   13746: 
1.144     matthew  13747: ######################################################
                   13748: ######################################################
1.31      albertel 13749: sub upfile_select_html {
1.144     matthew  13750:     my %Types = (
                   13751:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 13752:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  13753:                  space => &mt('Space separated'),
                   13754:                  tab   => &mt('Tabulator separated'),
                   13755: #                 xml   => &mt('HTML/XML'),
                   13756:                  );
                   13757:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  13758:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  13759:     foreach my $type (sort(keys(%Types))) {
                   13760:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   13761:     }
                   13762:     $Str .= "</select>\n";
                   13763:     return $Str;
1.31      albertel 13764: }
                   13765: 
1.301     albertel 13766: sub get_samples {
                   13767:     my ($records,$toget) = @_;
                   13768:     my @samples=({});
                   13769:     my $got=0;
                   13770:     foreach my $rec (@$records) {
                   13771: 	my %temp = &record_sep($rec);
                   13772: 	if (! grep(/\S/, values(%temp))) { next; }
                   13773: 	if (%temp) {
                   13774: 	    $samples[$got]=\%temp;
                   13775: 	    $got++;
                   13776: 	    if ($got == $toget) { last; }
                   13777: 	}
                   13778:     }
                   13779:     return \@samples;
                   13780: }
                   13781: 
1.144     matthew  13782: ######################################################
                   13783: ######################################################
                   13784: 
1.56      matthew  13785: =pod
                   13786: 
1.648     raeburn  13787: =item * &csv_print_samples($r,$records)
1.41      ng       13788: 
                   13789: Prints a table of sample values from each column uploaded $r is an
                   13790: Apache Request ref, $records is an arrayref from
                   13791: &Apache::loncommon::upfile_record_sep
                   13792: 
                   13793: =cut
                   13794: 
1.144     matthew  13795: ######################################################
                   13796: ######################################################
1.31      albertel 13797: sub csv_print_samples {
                   13798:     my ($r,$records) = @_;
1.662     bisitz   13799:     my $samples = &get_samples($records,5);
1.301     albertel 13800: 
1.594     raeburn  13801:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   13802:               &start_data_table_header_row());
1.356     albertel 13803:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   13804:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  13805:     $r->print(&end_data_table_header_row());
1.301     albertel 13806:     foreach my $hash (@$samples) {
1.594     raeburn  13807: 	$r->print(&start_data_table_row());
1.356     albertel 13808: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 13809: 	    $r->print('<td>');
1.356     albertel 13810: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 13811: 	    $r->print('</td>');
                   13812: 	}
1.594     raeburn  13813: 	$r->print(&end_data_table_row());
1.31      albertel 13814:     }
1.594     raeburn  13815:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 13816: }
                   13817: 
1.144     matthew  13818: ######################################################
                   13819: ######################################################
                   13820: 
1.56      matthew  13821: =pod
                   13822: 
1.648     raeburn  13823: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       13824: 
                   13825: Prints a table to create associations between values and table columns.
1.144     matthew  13826: 
1.41      ng       13827: $r is an Apache Request ref,
                   13828: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  13829: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       13830: 
                   13831: =cut
                   13832: 
1.144     matthew  13833: ######################################################
                   13834: ######################################################
1.31      albertel 13835: sub csv_print_select_table {
                   13836:     my ($r,$records,$d) = @_;
1.301     albertel 13837:     my $i=0;
                   13838:     my $samples = &get_samples($records,1);
1.144     matthew  13839:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  13840: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  13841:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  13842:               '<th>'.&mt('Column').'</th>'.
                   13843:               &end_data_table_header_row()."\n");
1.356     albertel 13844:     foreach my $array_ref (@$d) {
                   13845: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  13846: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 13847: 
1.875     bisitz   13848: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  13849: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 13850: 	$r->print('<option value="none"></option>');
1.356     albertel 13851: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   13852: 	    $r->print('<option value="'.$sample.'"'.
                   13853:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   13854:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 13855: 	}
1.594     raeburn  13856: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 13857: 	$i++;
                   13858:     }
1.594     raeburn  13859:     $r->print(&end_data_table());
1.31      albertel 13860:     $i--;
                   13861:     return $i;
                   13862: }
1.56      matthew  13863: 
1.144     matthew  13864: ######################################################
                   13865: ######################################################
                   13866: 
1.56      matthew  13867: =pod
1.31      albertel 13868: 
1.648     raeburn  13869: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       13870: 
                   13871: Prints a table of sample values from the upload and can make associate samples to internal names.
                   13872: 
                   13873: $r is an Apache Request ref,
                   13874: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   13875: $d is an array of 2 element arrays (internal name, displayed name)
                   13876: 
                   13877: =cut
                   13878: 
1.144     matthew  13879: ######################################################
                   13880: ######################################################
1.31      albertel 13881: sub csv_samples_select_table {
                   13882:     my ($r,$records,$d) = @_;
                   13883:     my $i=0;
1.144     matthew  13884:     #
1.662     bisitz   13885:     my $max_samples = 5;
                   13886:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  13887:     $r->print(&start_data_table().
                   13888:               &start_data_table_header_row().'<th>'.
                   13889:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   13890:               &end_data_table_header_row());
1.301     albertel 13891: 
                   13892:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  13893: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  13894: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 13895: 	foreach my $option (@$d) {
                   13896: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  13897: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 13898:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  13899:                       $display.'</option>');
1.31      albertel 13900: 	}
                   13901: 	$r->print('</select></td><td>');
1.662     bisitz   13902: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 13903: 	    if (defined($samples->[$line]{$key})) { 
                   13904: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   13905: 	    }
                   13906: 	}
1.594     raeburn  13907: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 13908: 	$i++;
                   13909:     }
1.594     raeburn  13910:     $r->print(&end_data_table());
1.31      albertel 13911:     $i--;
                   13912:     return($i);
1.115     matthew  13913: }
                   13914: 
1.144     matthew  13915: ######################################################
                   13916: ######################################################
                   13917: 
1.115     matthew  13918: =pod
                   13919: 
1.648     raeburn  13920: =item * &clean_excel_name($name)
1.115     matthew  13921: 
                   13922: Returns a replacement for $name which does not contain any illegal characters.
                   13923: 
                   13924: =cut
                   13925: 
1.144     matthew  13926: ######################################################
                   13927: ######################################################
1.115     matthew  13928: sub clean_excel_name {
                   13929:     my ($name) = @_;
                   13930:     $name =~ s/[:\*\?\/\\]//g;
                   13931:     if (length($name) > 31) {
                   13932:         $name = substr($name,0,31);
                   13933:     }
                   13934:     return $name;
1.25      albertel 13935: }
1.84      albertel 13936: 
1.85      albertel 13937: =pod
                   13938: 
1.648     raeburn  13939: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 13940: 
                   13941: Returns either 1 or undef
                   13942: 
                   13943: 1 if the part is to be hidden, undef if it is to be shown
                   13944: 
                   13945: Arguments are:
                   13946: 
                   13947: $id the id of the part to be checked
                   13948: $symb, optional the symb of the resource to check
                   13949: $udom, optional the domain of the user to check for
                   13950: $uname, optional the username of the user to check for
                   13951: 
                   13952: =cut
1.84      albertel 13953: 
                   13954: sub check_if_partid_hidden {
                   13955:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 13956:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 13957: 					 $symb,$udom,$uname);
1.141     albertel 13958:     my $truth=1;
                   13959:     #if the string starts with !, then the list is the list to show not hide
                   13960:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 13961:     my @hiddenlist=split(/,/,$hiddenparts);
                   13962:     foreach my $checkid (@hiddenlist) {
1.141     albertel 13963: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 13964:     }
1.141     albertel 13965:     return !$truth;
1.84      albertel 13966: }
1.127     matthew  13967: 
1.138     matthew  13968: 
                   13969: ############################################################
                   13970: ############################################################
                   13971: 
                   13972: =pod
                   13973: 
1.157     matthew  13974: =back 
                   13975: 
1.138     matthew  13976: =head1 cgi-bin script and graphing routines
                   13977: 
1.157     matthew  13978: =over 4
                   13979: 
1.648     raeburn  13980: =item * &get_cgi_id()
1.138     matthew  13981: 
                   13982: Inputs: none
                   13983: 
                   13984: Returns an id which can be used to pass environment variables
                   13985: to various cgi-bin scripts.  These environment variables will
                   13986: be removed from the users environment after a given time by
                   13987: the routine &Apache::lonnet::transfer_profile_to_env.
                   13988: 
                   13989: =cut
                   13990: 
                   13991: ############################################################
                   13992: ############################################################
1.152     albertel 13993: my $uniq=0;
1.136     matthew  13994: sub get_cgi_id {
1.154     albertel 13995:     $uniq=($uniq+1)%100000;
1.280     albertel 13996:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  13997: }
                   13998: 
1.127     matthew  13999: ############################################################
                   14000: ############################################################
                   14001: 
                   14002: =pod
                   14003: 
1.648     raeburn  14004: =item * &DrawBarGraph()
1.127     matthew  14005: 
1.138     matthew  14006: Facilitates the plotting of data in a (stacked) bar graph.
                   14007: Puts plot definition data into the users environment in order for 
                   14008: graph.png to plot it.  Returns an <img> tag for the plot.
                   14009: The bars on the plot are labeled '1','2',...,'n'.
                   14010: 
                   14011: Inputs:
                   14012: 
                   14013: =over 4
                   14014: 
                   14015: =item $Title: string, the title of the plot
                   14016: 
                   14017: =item $xlabel: string, text describing the X-axis of the plot
                   14018: 
                   14019: =item $ylabel: string, text describing the Y-axis of the plot
                   14020: 
                   14021: =item $Max: scalar, the maximum Y value to use in the plot
                   14022: If $Max is < any data point, the graph will not be rendered.
                   14023: 
1.140     matthew  14024: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  14025: they are plotted.  If undefined, default values will be used.
                   14026: 
1.178     matthew  14027: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   14028: 
1.138     matthew  14029: =item @Values: An array of array references.  Each array reference holds data
                   14030: to be plotted in a stacked bar chart.
                   14031: 
1.239     matthew  14032: =item If the final element of @Values is a hash reference the key/value
                   14033: pairs will be added to the graph definition.
                   14034: 
1.138     matthew  14035: =back
                   14036: 
                   14037: Returns:
                   14038: 
                   14039: An <img> tag which references graph.png and the appropriate identifying
                   14040: information for the plot.
                   14041: 
1.127     matthew  14042: =cut
                   14043: 
                   14044: ############################################################
                   14045: ############################################################
1.134     matthew  14046: sub DrawBarGraph {
1.178     matthew  14047:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  14048:     #
                   14049:     if (! defined($colors)) {
                   14050:         $colors = ['#33ff00', 
                   14051:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   14052:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   14053:                   ]; 
                   14054:     }
1.228     matthew  14055:     my $extra_settings = {};
                   14056:     if (ref($Values[-1]) eq 'HASH') {
                   14057:         $extra_settings = pop(@Values);
                   14058:     }
1.127     matthew  14059:     #
1.136     matthew  14060:     my $identifier = &get_cgi_id();
                   14061:     my $id = 'cgi.'.$identifier;        
1.129     matthew  14062:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  14063:         return '';
                   14064:     }
1.225     matthew  14065:     #
                   14066:     my @Labels;
                   14067:     if (defined($labels)) {
                   14068:         @Labels = @$labels;
                   14069:     } else {
                   14070:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  14071:             push(@Labels,$i+1);
1.225     matthew  14072:         }
                   14073:     }
                   14074:     #
1.129     matthew  14075:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  14076:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  14077:     my %ValuesHash;
                   14078:     my $NumSets=1;
                   14079:     foreach my $array (@Values) {
                   14080:         next if (! ref($array));
1.136     matthew  14081:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  14082:             join(',',@$array);
1.129     matthew  14083:     }
1.127     matthew  14084:     #
1.136     matthew  14085:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  14086:     if ($NumBars < 3) {
                   14087:         $width = 120+$NumBars*32;
1.220     matthew  14088:         $xskip = 1;
1.225     matthew  14089:         $bar_width = 30;
                   14090:     } elsif ($NumBars < 5) {
                   14091:         $width = 120+$NumBars*20;
                   14092:         $xskip = 1;
                   14093:         $bar_width = 20;
1.220     matthew  14094:     } elsif ($NumBars < 10) {
1.136     matthew  14095:         $width = 120+$NumBars*15;
                   14096:         $xskip = 1;
                   14097:         $bar_width = 15;
                   14098:     } elsif ($NumBars <= 25) {
                   14099:         $width = 120+$NumBars*11;
                   14100:         $xskip = 5;
                   14101:         $bar_width = 8;
                   14102:     } elsif ($NumBars <= 50) {
                   14103:         $width = 120+$NumBars*8;
                   14104:         $xskip = 5;
                   14105:         $bar_width = 4;
                   14106:     } else {
                   14107:         $width = 120+$NumBars*8;
                   14108:         $xskip = 5;
                   14109:         $bar_width = 4;
                   14110:     }
                   14111:     #
1.137     matthew  14112:     $Max = 1 if ($Max < 1);
                   14113:     if ( int($Max) < $Max ) {
                   14114:         $Max++;
                   14115:         $Max = int($Max);
                   14116:     }
1.127     matthew  14117:     $Title  = '' if (! defined($Title));
                   14118:     $xlabel = '' if (! defined($xlabel));
                   14119:     $ylabel = '' if (! defined($ylabel));
1.369     www      14120:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   14121:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   14122:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  14123:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  14124:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   14125:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   14126:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   14127:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14128:     $ValuesHash{$id.'.height'}   = $height;
                   14129:     $ValuesHash{$id.'.width'}    = $width;
                   14130:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   14131:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   14132:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  14133:     #
1.228     matthew  14134:     # Deal with other parameters
                   14135:     while (my ($key,$value) = each(%$extra_settings)) {
                   14136:         $ValuesHash{$id.'.'.$key} = $value;
                   14137:     }
                   14138:     #
1.646     raeburn  14139:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  14140:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14141: }
                   14142: 
                   14143: ############################################################
                   14144: ############################################################
                   14145: 
                   14146: =pod
                   14147: 
1.648     raeburn  14148: =item * &DrawXYGraph()
1.137     matthew  14149: 
1.138     matthew  14150: Facilitates the plotting of data in an XY graph.
                   14151: Puts plot definition data into the users environment in order for 
                   14152: graph.png to plot it.  Returns an <img> tag for the plot.
                   14153: 
                   14154: Inputs:
                   14155: 
                   14156: =over 4
                   14157: 
                   14158: =item $Title: string, the title of the plot
                   14159: 
                   14160: =item $xlabel: string, text describing the X-axis of the plot
                   14161: 
                   14162: =item $ylabel: string, text describing the Y-axis of the plot
                   14163: 
                   14164: =item $Max: scalar, the maximum Y value to use in the plot
                   14165: If $Max is < any data point, the graph will not be rendered.
                   14166: 
                   14167: =item $colors: Array ref containing the hex color codes for the data to be 
                   14168: plotted in.  If undefined, default values will be used.
                   14169: 
                   14170: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14171: 
                   14172: =item $Ydata: Array ref containing Array refs.  
1.185     www      14173: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  14174: 
                   14175: =item %Values: hash indicating or overriding any default values which are 
                   14176: passed to graph.png.  
                   14177: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14178: 
                   14179: =back
                   14180: 
                   14181: Returns:
                   14182: 
                   14183: An <img> tag which references graph.png and the appropriate identifying
                   14184: information for the plot.
                   14185: 
1.137     matthew  14186: =cut
                   14187: 
                   14188: ############################################################
                   14189: ############################################################
                   14190: sub DrawXYGraph {
                   14191:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   14192:     #
                   14193:     # Create the identifier for the graph
                   14194:     my $identifier = &get_cgi_id();
                   14195:     my $id = 'cgi.'.$identifier;
                   14196:     #
                   14197:     $Title  = '' if (! defined($Title));
                   14198:     $xlabel = '' if (! defined($xlabel));
                   14199:     $ylabel = '' if (! defined($ylabel));
                   14200:     my %ValuesHash = 
                   14201:         (
1.369     www      14202:          $id.'.title'  => &escape($Title),
                   14203:          $id.'.xlabel' => &escape($xlabel),
                   14204:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  14205:          $id.'.y_max_value'=> $Max,
                   14206:          $id.'.labels'     => join(',',@$Xlabels),
                   14207:          $id.'.PlotType'   => 'XY',
                   14208:          );
                   14209:     #
                   14210:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14211:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14212:     }
                   14213:     #
                   14214:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   14215:         return '';
                   14216:     }
                   14217:     my $NumSets=1;
1.138     matthew  14218:     foreach my $array (@{$Ydata}){
1.137     matthew  14219:         next if (! ref($array));
                   14220:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   14221:     }
1.138     matthew  14222:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  14223:     #
                   14224:     # Deal with other parameters
                   14225:     while (my ($key,$value) = each(%Values)) {
                   14226:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  14227:     }
                   14228:     #
1.646     raeburn  14229:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  14230:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14231: }
                   14232: 
                   14233: ############################################################
                   14234: ############################################################
                   14235: 
                   14236: =pod
                   14237: 
1.648     raeburn  14238: =item * &DrawXYYGraph()
1.138     matthew  14239: 
                   14240: Facilitates the plotting of data in an XY graph with two Y axes.
                   14241: Puts plot definition data into the users environment in order for 
                   14242: graph.png to plot it.  Returns an <img> tag for the plot.
                   14243: 
                   14244: Inputs:
                   14245: 
                   14246: =over 4
                   14247: 
                   14248: =item $Title: string, the title of the plot
                   14249: 
                   14250: =item $xlabel: string, text describing the X-axis of the plot
                   14251: 
                   14252: =item $ylabel: string, text describing the Y-axis of the plot
                   14253: 
                   14254: =item $colors: Array ref containing the hex color codes for the data to be 
                   14255: plotted in.  If undefined, default values will be used.
                   14256: 
                   14257: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14258: 
                   14259: =item $Ydata1: The first data set
                   14260: 
                   14261: =item $Min1: The minimum value of the left Y-axis
                   14262: 
                   14263: =item $Max1: The maximum value of the left Y-axis
                   14264: 
                   14265: =item $Ydata2: The second data set
                   14266: 
                   14267: =item $Min2: The minimum value of the right Y-axis
                   14268: 
                   14269: =item $Max2: The maximum value of the left Y-axis
                   14270: 
                   14271: =item %Values: hash indicating or overriding any default values which are 
                   14272: passed to graph.png.  
                   14273: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14274: 
                   14275: =back
                   14276: 
                   14277: Returns:
                   14278: 
                   14279: An <img> tag which references graph.png and the appropriate identifying
                   14280: information for the plot.
1.136     matthew  14281: 
                   14282: =cut
                   14283: 
                   14284: ############################################################
                   14285: ############################################################
1.137     matthew  14286: sub DrawXYYGraph {
                   14287:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   14288:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  14289:     #
                   14290:     # Create the identifier for the graph
                   14291:     my $identifier = &get_cgi_id();
                   14292:     my $id = 'cgi.'.$identifier;
                   14293:     #
                   14294:     $Title  = '' if (! defined($Title));
                   14295:     $xlabel = '' if (! defined($xlabel));
                   14296:     $ylabel = '' if (! defined($ylabel));
                   14297:     my %ValuesHash = 
                   14298:         (
1.369     www      14299:          $id.'.title'  => &escape($Title),
                   14300:          $id.'.xlabel' => &escape($xlabel),
                   14301:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  14302:          $id.'.labels' => join(',',@$Xlabels),
                   14303:          $id.'.PlotType' => 'XY',
                   14304:          $id.'.NumSets' => 2,
1.137     matthew  14305:          $id.'.two_axes' => 1,
                   14306:          $id.'.y1_max_value' => $Max1,
                   14307:          $id.'.y1_min_value' => $Min1,
                   14308:          $id.'.y2_max_value' => $Max2,
                   14309:          $id.'.y2_min_value' => $Min2,
1.136     matthew  14310:          );
                   14311:     #
1.137     matthew  14312:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14313:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14314:     }
                   14315:     #
                   14316:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   14317:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  14318:         return '';
                   14319:     }
                   14320:     my $NumSets=1;
1.137     matthew  14321:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  14322:         next if (! ref($array));
                   14323:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  14324:     }
                   14325:     #
                   14326:     # Deal with other parameters
                   14327:     while (my ($key,$value) = each(%Values)) {
                   14328:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  14329:     }
                   14330:     #
1.646     raeburn  14331:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 14332:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  14333: }
                   14334: 
                   14335: ############################################################
                   14336: ############################################################
                   14337: 
                   14338: =pod
                   14339: 
1.157     matthew  14340: =back 
                   14341: 
1.139     matthew  14342: =head1 Statistics helper routines?  
                   14343: 
                   14344: Bad place for them but what the hell.
                   14345: 
1.157     matthew  14346: =over 4
                   14347: 
1.648     raeburn  14348: =item * &chartlink()
1.139     matthew  14349: 
                   14350: Returns a link to the chart for a specific student.  
                   14351: 
                   14352: Inputs:
                   14353: 
                   14354: =over 4
                   14355: 
                   14356: =item $linktext: The text of the link
                   14357: 
                   14358: =item $sname: The students username
                   14359: 
                   14360: =item $sdomain: The students domain
                   14361: 
                   14362: =back
                   14363: 
1.157     matthew  14364: =back
                   14365: 
1.139     matthew  14366: =cut
                   14367: 
                   14368: ############################################################
                   14369: ############################################################
                   14370: sub chartlink {
                   14371:     my ($linktext, $sname, $sdomain) = @_;
                   14372:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      14373:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 14374:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  14375:        '">'.$linktext.'</a>';
1.153     matthew  14376: }
                   14377: 
                   14378: #######################################################
                   14379: #######################################################
                   14380: 
                   14381: =pod
                   14382: 
                   14383: =head1 Course Environment Routines
1.157     matthew  14384: 
                   14385: =over 4
1.153     matthew  14386: 
1.648     raeburn  14387: =item * &restore_course_settings()
1.153     matthew  14388: 
1.648     raeburn  14389: =item * &store_course_settings()
1.153     matthew  14390: 
                   14391: Restores/Store indicated form parameters from the course environment.
                   14392: Will not overwrite existing values of the form parameters.
                   14393: 
                   14394: Inputs: 
                   14395: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   14396: 
                   14397: a hash ref describing the data to be stored.  For example:
                   14398:    
                   14399: %Save_Parameters = ('Status' => 'scalar',
                   14400:     'chartoutputmode' => 'scalar',
                   14401:     'chartoutputdata' => 'scalar',
                   14402:     'Section' => 'array',
1.373     raeburn  14403:     'Group' => 'array',
1.153     matthew  14404:     'StudentData' => 'array',
                   14405:     'Maps' => 'array');
                   14406: 
                   14407: Returns: both routines return nothing
                   14408: 
1.631     raeburn  14409: =back
                   14410: 
1.153     matthew  14411: =cut
                   14412: 
                   14413: #######################################################
                   14414: #######################################################
                   14415: sub store_course_settings {
1.496     albertel 14416:     return &store_settings($env{'request.course.id'},@_);
                   14417: }
                   14418: 
                   14419: sub store_settings {
1.153     matthew  14420:     # save to the environment
                   14421:     # appenv the same items, just to be safe
1.300     albertel 14422:     my $udom  = $env{'user.domain'};
                   14423:     my $uname = $env{'user.name'};
1.496     albertel 14424:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14425:     my %SaveHash;
                   14426:     my %AppHash;
                   14427:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 14428:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 14429:         my $envname = 'environment.'.$basename;
1.258     albertel 14430:         if (exists($env{'form.'.$setting})) {
1.153     matthew  14431:             # Save this value away
                   14432:             if ($type eq 'scalar' &&
1.258     albertel 14433:                 (! exists($env{$envname}) || 
                   14434:                  $env{$envname} ne $env{'form.'.$setting})) {
                   14435:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   14436:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  14437:             } elsif ($type eq 'array') {
                   14438:                 my $stored_form;
1.258     albertel 14439:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  14440:                     $stored_form = join(',',
                   14441:                                         map {
1.369     www      14442:                                             &escape($_);
1.258     albertel 14443:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  14444:                 } else {
                   14445:                     $stored_form = 
1.369     www      14446:                         &escape($env{'form.'.$setting});
1.153     matthew  14447:                 }
                   14448:                 # Determine if the array contents are the same.
1.258     albertel 14449:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  14450:                     $SaveHash{$basename} = $stored_form;
                   14451:                     $AppHash{$envname}   = $stored_form;
                   14452:                 }
                   14453:             }
                   14454:         }
                   14455:     }
                   14456:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 14457:                                           $udom,$uname);
1.153     matthew  14458:     if ($put_result !~ /^(ok|delayed)/) {
                   14459:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   14460:                                  'got error:'.$put_result);
                   14461:     }
                   14462:     # Make sure these settings stick around in this session, too
1.646     raeburn  14463:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  14464:     return;
                   14465: }
                   14466: 
                   14467: sub restore_course_settings {
1.499     albertel 14468:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14469: }
                   14470: 
                   14471: sub restore_settings {
                   14472:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14473:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14474:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14475:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14476:             '.'.$setting;
1.258     albertel 14477:         if (exists($env{$envname})) {
1.153     matthew  14478:             if ($type eq 'scalar') {
1.258     albertel 14479:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14480:             } elsif ($type eq 'array') {
1.258     albertel 14481:                 $env{'form.'.$setting} = [ 
1.153     matthew  14482:                                            map { 
1.369     www      14483:                                                &unescape($_); 
1.258     albertel 14484:                                            } split(',',$env{$envname})
1.153     matthew  14485:                                            ];
                   14486:             }
                   14487:         }
                   14488:     }
1.127     matthew  14489: }
                   14490: 
1.618     raeburn  14491: #######################################################
                   14492: #######################################################
                   14493: 
                   14494: =pod
                   14495: 
                   14496: =head1 Domain E-mail Routines  
                   14497: 
                   14498: =over 4
                   14499: 
1.648     raeburn  14500: =item * &build_recipient_list()
1.618     raeburn  14501: 
1.1075.2.44  raeburn  14502: Build recipient lists for following types of e-mail:
1.766     raeburn  14503: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  14504: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   14505: module change checking, student/employee ID conflict checks, as
                   14506: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   14507: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  14508: 
                   14509: Inputs:
1.1075.2.44  raeburn  14510: defmail (scalar - email address of default recipient),
                   14511: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   14512: requestsmail, updatesmail, or idconflictsmail).
                   14513: 
1.619     raeburn  14514: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  14515: 
                   14516: origmail (scalar - email address of recipient from loncapa.conf,
                   14517: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  14518: 
1.1075.2.139  raeburn  14519: $requname username of requester (if mailing type is helpdeskmail)
                   14520: 
                   14521: $requdom domain of requester (if mailing type is helpdeskmail)
                   14522: 
                   14523: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   14524: 
1.655     raeburn  14525: Returns: comma separated list of addresses to which to send e-mail.
                   14526: 
                   14527: =back
1.618     raeburn  14528: 
                   14529: =cut
                   14530: 
                   14531: ############################################################
                   14532: ############################################################
                   14533: sub build_recipient_list {
1.1075.2.139  raeburn  14534:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  14535:     my @recipients;
1.1075.2.122  raeburn  14536:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  14537:     my %domconfig =
1.1075.2.122  raeburn  14538:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  14539:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  14540:         if (exists($domconfig{'contacts'}{$mailing})) {
                   14541:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   14542:                 my @contacts = ('adminemail','supportemail');
                   14543:                 foreach my $item (@contacts) {
                   14544:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   14545:                         my $addr = $domconfig{'contacts'}{$item}; 
                   14546:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14547:                             push(@recipients,$addr);
                   14548:                         }
1.619     raeburn  14549:                     }
1.1075.2.122  raeburn  14550:                 }
                   14551:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   14552:                 if ($mailing eq 'helpdeskmail') {
                   14553:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   14554:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   14555:                         my @ok_bccs;
                   14556:                         foreach my $bcc (@bccs) {
                   14557:                             $bcc =~ s/^\s+//g;
                   14558:                             $bcc =~ s/\s+$//g;
                   14559:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14560:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14561:                                     push(@ok_bccs,$bcc);
                   14562:                                 }
                   14563:                             }
                   14564:                         }
                   14565:                         if (@ok_bccs > 0) {
                   14566:                             $allbcc = join(', ',@ok_bccs);
                   14567:                         }
                   14568:                     }
                   14569:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  14570:                 }
                   14571:             }
1.766     raeburn  14572:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14573:             $lastresort = $origmail;
1.618     raeburn  14574:         }
1.1075.2.139  raeburn  14575:         if ($mailing eq 'helpdeskmail') {
                   14576:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   14577:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   14578:                 my ($inststatus,$inststatus_checked);
                   14579:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   14580:                     ($env{'user.domain'} ne 'public')) {
                   14581:                     $inststatus_checked = 1;
                   14582:                     $inststatus = $env{'environment.inststatus'};
                   14583:                 }
                   14584:                 unless ($inststatus_checked) {
                   14585:                     if (($requname ne '') && ($requdom ne '')) {
                   14586:                         if (($requname =~ /^$match_username$/) &&
                   14587:                             ($requdom =~ /^$match_domain$/) &&
                   14588:                             (&Apache::lonnet::domain($requdom))) {
                   14589:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   14590:                                                                       $requdom);
                   14591:                             unless ($requhome eq 'no_host') {
                   14592:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   14593:                                 $inststatus = $userenv{'inststatus'};
                   14594:                                 $inststatus_checked = 1;
                   14595:                             }
                   14596:                         }
                   14597:                     }
                   14598:                 }
                   14599:                 unless ($inststatus_checked) {
                   14600:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   14601:                         my %srch = (srchby     => 'email',
                   14602:                                     srchdomain => $defdom,
                   14603:                                     srchterm   => $reqemail,
                   14604:                                     srchtype   => 'exact');
                   14605:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   14606:                         foreach my $uname (keys(%srch_results)) {
                   14607:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14608:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14609:                                 $inststatus_checked = 1;
                   14610:                                 last;
                   14611:                             }
                   14612:                         }
                   14613:                         unless ($inststatus_checked) {
                   14614:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   14615:                             if ($dirsrchres eq 'ok') {
                   14616:                                 foreach my $uname (keys(%srch_results)) {
                   14617:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14618:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14619:                                         $inststatus_checked = 1;
                   14620:                                         last;
                   14621:                                     }
                   14622:                                 }
                   14623:                             }
                   14624:                         }
                   14625:                     }
                   14626:                 }
                   14627:                 if ($inststatus ne '') {
                   14628:                     foreach my $status (split(/\:/,$inststatus)) {
                   14629:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   14630:                             my @contacts = ('adminemail','supportemail');
                   14631:                             foreach my $item (@contacts) {
                   14632:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   14633:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   14634:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14635:                                         push(@recipients,$addr);
                   14636:                                     }
                   14637:                                 }
                   14638:                             }
                   14639:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   14640:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   14641:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   14642:                                 my @ok_bccs;
                   14643:                                 foreach my $bcc (@bccs) {
                   14644:                                     $bcc =~ s/^\s+//g;
                   14645:                                     $bcc =~ s/\s+$//g;
                   14646:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14647:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14648:                                             push(@ok_bccs,$bcc);
                   14649:                                         }
                   14650:                                     }
                   14651:                                 }
                   14652:                                 if (@ok_bccs > 0) {
                   14653:                                     $allbcc = join(', ',@ok_bccs);
                   14654:                                 }
                   14655:                             }
                   14656:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   14657:                             last;
                   14658:                         }
                   14659:                     }
                   14660:                 }
                   14661:             }
                   14662:         }
1.619     raeburn  14663:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14664:         $lastresort = $origmail;
                   14665:     }
1.1075.2.128  raeburn  14666:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  14667:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   14668:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   14669:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   14670:             my %what = (
                   14671:                           perlvar => 1,
                   14672:                        );
                   14673:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   14674:             if ($primary) {
                   14675:                 my $gotaddr;
                   14676:                 my ($result,$returnhash) =
                   14677:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   14678:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   14679:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   14680:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   14681:                         $gotaddr = 1;
                   14682:                     }
                   14683:                 }
                   14684:                 unless ($gotaddr) {
                   14685:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   14686:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   14687:                     unless ($uintdom eq $intdom) {
                   14688:                         my %domconfig =
                   14689:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   14690:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   14691:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   14692:                                 my @contacts = ('adminemail','supportemail');
                   14693:                                 foreach my $item (@contacts) {
                   14694:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   14695:                                         my $addr = $domconfig{'contacts'}{$item};
                   14696:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14697:                                             push(@recipients,$addr);
                   14698:                                         }
                   14699:                                     }
                   14700:                                 }
                   14701:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   14702:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   14703:                                 }
                   14704:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   14705:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   14706:                                     my @ok_bccs;
                   14707:                                     foreach my $bcc (@bccs) {
                   14708:                                         $bcc =~ s/^\s+//g;
                   14709:                                         $bcc =~ s/\s+$//g;
                   14710:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14711:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14712:                                                 push(@ok_bccs,$bcc);
                   14713:                                             }
                   14714:                                         }
                   14715:                                     }
                   14716:                                     if (@ok_bccs > 0) {
                   14717:                                         $allbcc = join(', ',@ok_bccs);
                   14718:                                     }
                   14719:                                 }
                   14720:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   14721:                             }
                   14722:                         }
                   14723:                     }
                   14724:                 }
                   14725:             }
                   14726:         }
1.618     raeburn  14727:     }
1.688     raeburn  14728:     if (defined($defmail)) {
                   14729:         if ($defmail ne '') {
                   14730:             push(@recipients,$defmail);
                   14731:         }
1.618     raeburn  14732:     }
                   14733:     if ($otheremails) {
1.619     raeburn  14734:         my @others;
                   14735:         if ($otheremails =~ /,/) {
                   14736:             @others = split(/,/,$otheremails);
1.618     raeburn  14737:         } else {
1.619     raeburn  14738:             push(@others,$otheremails);
                   14739:         }
                   14740:         foreach my $addr (@others) {
                   14741:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14742:                 push(@recipients,$addr);
                   14743:             }
1.618     raeburn  14744:         }
                   14745:     }
1.1075.2.128  raeburn  14746:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  14747:         if ((!@recipients) && ($lastresort ne '')) {
                   14748:             push(@recipients,$lastresort);
                   14749:         }
                   14750:     } elsif ($lastresort ne '') {
                   14751:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   14752:             push(@recipients,$lastresort);
                   14753:         }
                   14754:     }
                   14755:     my $recipientlist = join(',',@recipients);
                   14756:     if (wantarray) {
                   14757:         return ($recipientlist,$allbcc,$addtext);
                   14758:     } else {
                   14759:         return $recipientlist;
                   14760:     }
1.618     raeburn  14761: }
                   14762: 
1.127     matthew  14763: ############################################################
                   14764: ############################################################
1.154     albertel 14765: 
1.655     raeburn  14766: =pod
                   14767: 
                   14768: =head1 Course Catalog Routines
                   14769: 
                   14770: =over 4
                   14771: 
                   14772: =item * &gather_categories()
                   14773: 
                   14774: Converts category definitions - keys of categories hash stored in  
                   14775: coursecategories in configuration.db on the primary library server in a 
                   14776: domain - to an array.  Also generates javascript and idx hash used to 
                   14777: generate Domain Coordinator interface for editing Course Categories.
                   14778: 
                   14779: Inputs:
1.663     raeburn  14780: 
1.655     raeburn  14781: categories (reference to hash of category definitions).
1.663     raeburn  14782: 
1.655     raeburn  14783: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14784:       categories and subcategories).
1.663     raeburn  14785: 
1.655     raeburn  14786: idx (reference to hash of counters used in Domain Coordinator interface for 
                   14787:       editing Course Categories).
1.663     raeburn  14788: 
1.655     raeburn  14789: jsarray (reference to array of categories used to create Javascript arrays for
                   14790:          Domain Coordinator interface for editing Course Categories).
                   14791: 
                   14792: Returns: nothing
                   14793: 
                   14794: Side effects: populates cats, idx and jsarray. 
                   14795: 
                   14796: =cut
                   14797: 
                   14798: sub gather_categories {
                   14799:     my ($categories,$cats,$idx,$jsarray) = @_;
                   14800:     my %counters;
                   14801:     my $num = 0;
                   14802:     foreach my $item (keys(%{$categories})) {
                   14803:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   14804:         if ($container eq '' && $depth == 0) {
                   14805:             $cats->[$depth][$categories->{$item}] = $cat;
                   14806:         } else {
                   14807:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   14808:         }
                   14809:         my ($escitem,$tail) = split(/:/,$item,2);
                   14810:         if ($counters{$tail} eq '') {
                   14811:             $counters{$tail} = $num;
                   14812:             $num ++;
                   14813:         }
                   14814:         if (ref($idx) eq 'HASH') {
                   14815:             $idx->{$item} = $counters{$tail};
                   14816:         }
                   14817:         if (ref($jsarray) eq 'ARRAY') {
                   14818:             push(@{$jsarray->[$counters{$tail}]},$item);
                   14819:         }
                   14820:     }
                   14821:     return;
                   14822: }
                   14823: 
                   14824: =pod
                   14825: 
                   14826: =item * &extract_categories()
                   14827: 
                   14828: Used to generate breadcrumb trails for course categories.
                   14829: 
                   14830: Inputs:
1.663     raeburn  14831: 
1.655     raeburn  14832: categories (reference to hash of category definitions).
1.663     raeburn  14833: 
1.655     raeburn  14834: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14835:       categories and subcategories).
1.663     raeburn  14836: 
1.655     raeburn  14837: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  14838: 
1.655     raeburn  14839: allitems (reference to hash - key is category key 
                   14840:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14841: 
1.655     raeburn  14842: idx (reference to hash of counters used in Domain Coordinator interface for
                   14843:       editing Course Categories).
1.663     raeburn  14844: 
1.655     raeburn  14845: jsarray (reference to array of categories used to create Javascript arrays for
                   14846:          Domain Coordinator interface for editing Course Categories).
                   14847: 
1.665     raeburn  14848: subcats (reference to hash of arrays containing all subcategories within each 
                   14849:          category, -recursive)
                   14850: 
1.1075.2.132  raeburn  14851: maxd (reference to hash used to hold max depth for all top-level categories).
                   14852: 
1.655     raeburn  14853: Returns: nothing
                   14854: 
                   14855: Side effects: populates trails and allitems hash references.
                   14856: 
                   14857: =cut
                   14858: 
                   14859: sub extract_categories {
1.1075.2.132  raeburn  14860:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  14861:     if (ref($categories) eq 'HASH') {
                   14862:         &gather_categories($categories,$cats,$idx,$jsarray);
                   14863:         if (ref($cats->[0]) eq 'ARRAY') {
                   14864:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   14865:                 my $name = $cats->[0][$i];
                   14866:                 my $item = &escape($name).'::0';
                   14867:                 my $trailstr;
                   14868:                 if ($name eq 'instcode') {
                   14869:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  14870:                 } elsif ($name eq 'communities') {
                   14871:                     $trailstr = &mt('Communities');
1.655     raeburn  14872:                 } else {
                   14873:                     $trailstr = $name;
                   14874:                 }
                   14875:                 if ($allitems->{$item} eq '') {
                   14876:                     push(@{$trails},$trailstr);
                   14877:                     $allitems->{$item} = scalar(@{$trails})-1;
                   14878:                 }
                   14879:                 my @parents = ($name);
                   14880:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   14881:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   14882:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  14883:                         if (ref($subcats) eq 'HASH') {
                   14884:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   14885:                         }
1.1075.2.132  raeburn  14886:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  14887:                     }
                   14888:                 } else {
                   14889:                     if (ref($subcats) eq 'HASH') {
                   14890:                         $subcats->{$item} = [];
1.655     raeburn  14891:                     }
1.1075.2.132  raeburn  14892:                     if (ref($maxd) eq 'HASH') {
                   14893:                         $maxd->{$name} = 1;
                   14894:                     }
1.655     raeburn  14895:                 }
                   14896:             }
                   14897:         }
                   14898:     }
                   14899:     return;
                   14900: }
                   14901: 
                   14902: =pod
                   14903: 
1.1075.2.56  raeburn  14904: =item * &recurse_categories()
1.655     raeburn  14905: 
                   14906: Recursively used to generate breadcrumb trails for course categories.
                   14907: 
                   14908: Inputs:
1.663     raeburn  14909: 
1.655     raeburn  14910: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14911:       categories and subcategories).
1.663     raeburn  14912: 
1.655     raeburn  14913: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  14914: 
                   14915: category (current course category, for which breadcrumb trail is being generated).
                   14916: 
                   14917: trails (reference to array of breadcrumb trails for each category).
                   14918: 
1.655     raeburn  14919: allitems (reference to hash - key is category key
                   14920:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14921: 
1.655     raeburn  14922: parents (array containing containers directories for current category, 
                   14923:          back to top level). 
                   14924: 
                   14925: Returns: nothing
                   14926: 
                   14927: Side effects: populates trails and allitems hash references
                   14928: 
                   14929: =cut
                   14930: 
                   14931: sub recurse_categories {
1.1075.2.132  raeburn  14932:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  14933:     my $shallower = $depth - 1;
                   14934:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   14935:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   14936:             my $name = $cats->[$depth]{$category}[$k];
                   14937:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.164  raeburn  14938:             my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  14939:             if ($allitems->{$item} eq '') {
                   14940:                 push(@{$trails},$trailstr);
                   14941:                 $allitems->{$item} = scalar(@{$trails})-1;
                   14942:             }
                   14943:             my $deeper = $depth+1;
                   14944:             push(@{$parents},$category);
1.665     raeburn  14945:             if (ref($subcats) eq 'HASH') {
                   14946:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   14947:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   14948:                     my $higher;
                   14949:                     if ($j > 0) {
                   14950:                         $higher = &escape($parents->[$j]).':'.
                   14951:                                   &escape($parents->[$j-1]).':'.$j;
                   14952:                     } else {
                   14953:                         $higher = &escape($parents->[$j]).'::'.$j;
                   14954:                     }
                   14955:                     push(@{$subcats->{$higher}},$subcat);
                   14956:                 }
                   14957:             }
                   14958:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132  raeburn  14959:                                 $subcats,$maxd);
1.655     raeburn  14960:             pop(@{$parents});
                   14961:         }
                   14962:     } else {
                   14963:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132  raeburn  14964:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  14965:         if ($allitems->{$item} eq '') {
                   14966:             push(@{$trails},$trailstr);
                   14967:             $allitems->{$item} = scalar(@{$trails})-1;
                   14968:         }
1.1075.2.132  raeburn  14969:         if (ref($maxd) eq 'HASH') {
                   14970:             if ($depth > $maxd->{$parents->[0]}) {
                   14971:                 $maxd->{$parents->[0]} = $depth;
                   14972:             }
                   14973:         }
1.655     raeburn  14974:     }
                   14975:     return;
                   14976: }
                   14977: 
1.663     raeburn  14978: =pod
                   14979: 
1.1075.2.56  raeburn  14980: =item * &assign_categories_table()
1.663     raeburn  14981: 
                   14982: Create a datatable for display of hierarchical categories in a domain,
                   14983: with checkboxes to allow a course to be categorized. 
                   14984: 
                   14985: Inputs:
                   14986: 
                   14987: cathash - reference to hash of categories defined for the domain (from
                   14988:           configuration.db)
                   14989: 
                   14990: currcat - scalar with an & separated list of categories assigned to a course. 
                   14991: 
1.919     raeburn  14992: type    - scalar contains course type (Course or Community).
                   14993: 
1.1075.2.117  raeburn  14994: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   14995:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   14996: 
1.663     raeburn  14997: Returns: $output (markup to be displayed) 
                   14998: 
                   14999: =cut
                   15000: 
                   15001: sub assign_categories_table {
1.1075.2.117  raeburn  15002:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  15003:     my $output;
                   15004:     if (ref($cathash) eq 'HASH') {
1.1075.2.132  raeburn  15005:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   15006:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  15007:         $maxdepth = scalar(@cats);
                   15008:         if (@cats > 0) {
                   15009:             my $itemcount = 0;
                   15010:             if (ref($cats[0]) eq 'ARRAY') {
                   15011:                 my @currcategories;
                   15012:                 if ($currcat ne '') {
                   15013:                     @currcategories = split('&',$currcat);
                   15014:                 }
1.919     raeburn  15015:                 my $table;
1.663     raeburn  15016:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   15017:                     my $parent = $cats[0][$i];
1.919     raeburn  15018:                     next if ($parent eq 'instcode');
                   15019:                     if ($type eq 'Community') {
                   15020:                         next unless ($parent eq 'communities');
                   15021:                     } else {
                   15022:                         next if ($parent eq 'communities');
                   15023:                     }
1.663     raeburn  15024:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   15025:                     my $item = &escape($parent).'::0';
                   15026:                     my $checked = '';
                   15027:                     if (@currcategories > 0) {
                   15028:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   15029:                             $checked = ' checked="checked"';
1.663     raeburn  15030:                         }
                   15031:                     }
1.919     raeburn  15032:                     my $parent_title = $parent;
                   15033:                     if ($parent eq 'communities') {
                   15034:                         $parent_title = &mt('Communities');
                   15035:                     }
                   15036:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   15037:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15038:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  15039:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  15040:                     my $depth = 1;
                   15041:                     push(@path,$parent);
1.1075.2.117  raeburn  15042:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  15043:                     pop(@path);
1.919     raeburn  15044:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  15045:                     $itemcount ++;
                   15046:                 }
1.919     raeburn  15047:                 if ($itemcount) {
                   15048:                     $output = &Apache::loncommon::start_data_table().
                   15049:                               $table.
                   15050:                               &Apache::loncommon::end_data_table();
                   15051:                 }
1.663     raeburn  15052:             }
                   15053:         }
                   15054:     }
                   15055:     return $output;
                   15056: }
                   15057: 
                   15058: =pod
                   15059: 
1.1075.2.56  raeburn  15060: =item * &assign_category_rows()
1.663     raeburn  15061: 
                   15062: Create a datatable row for display of nested categories in a domain,
                   15063: with checkboxes to allow a course to be categorized,called recursively.
                   15064: 
                   15065: Inputs:
                   15066: 
                   15067: itemcount - track row number for alternating colors
                   15068: 
                   15069: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   15070:       categories and subcategories.
                   15071: 
                   15072: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   15073: 
                   15074: parent - parent of current category item
                   15075: 
                   15076: path - Array containing all categories back up through the hierarchy from the
                   15077:        current category to the top level.
                   15078: 
                   15079: currcategories - reference to array of current categories assigned to the course
                   15080: 
1.1075.2.117  raeburn  15081: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15082:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15083: 
1.663     raeburn  15084: Returns: $output (markup to be displayed).
                   15085: 
                   15086: =cut
                   15087: 
                   15088: sub assign_category_rows {
1.1075.2.117  raeburn  15089:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  15090:     my ($text,$name,$item,$chgstr);
                   15091:     if (ref($cats) eq 'ARRAY') {
                   15092:         my $maxdepth = scalar(@{$cats});
                   15093:         if (ref($cats->[$depth]) eq 'HASH') {
                   15094:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   15095:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   15096:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  15097:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  15098:                 for (my $j=0; $j<$numchildren; $j++) {
                   15099:                     $name = $cats->[$depth]{$parent}[$j];
                   15100:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   15101:                     my $deeper = $depth+1;
                   15102:                     my $checked = '';
                   15103:                     if (ref($currcategories) eq 'ARRAY') {
                   15104:                         if (@{$currcategories} > 0) {
                   15105:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   15106:                                 $checked = ' checked="checked"';
1.663     raeburn  15107:                             }
                   15108:                         }
                   15109:                     }
1.664     raeburn  15110:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   15111:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15112:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  15113:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   15114:                              '</td><td>';
1.663     raeburn  15115:                     if (ref($path) eq 'ARRAY') {
                   15116:                         push(@{$path},$name);
1.1075.2.117  raeburn  15117:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  15118:                         pop(@{$path});
                   15119:                     }
                   15120:                     $text .= '</td></tr>';
                   15121:                 }
                   15122:                 $text .= '</table></td>';
                   15123:             }
                   15124:         }
                   15125:     }
                   15126:     return $text;
                   15127: }
                   15128: 
1.1075.2.69  raeburn  15129: =pod
                   15130: 
                   15131: =back
                   15132: 
                   15133: =cut
                   15134: 
1.655     raeburn  15135: ############################################################
                   15136: ############################################################
                   15137: 
                   15138: 
1.443     albertel 15139: sub commit_customrole {
1.664     raeburn  15140:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  15141:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 15142:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   15143:                          ($end?', ending '.localtime($end):'').': <b>'.
                   15144:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  15145:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 15146:                  '</b><br />';
                   15147:     return $output;
                   15148: }
                   15149: 
                   15150: sub commit_standardrole {
1.1075.2.31  raeburn  15151:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  15152:     my ($output,$logmsg,$linefeed);
                   15153:     if ($context eq 'auto') {
                   15154:         $linefeed = "\n";
                   15155:     } else {
                   15156:         $linefeed = "<br />\n";
                   15157:     }  
1.443     albertel 15158:     if ($three eq 'st') {
1.541     raeburn  15159:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  15160:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  15161:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  15162:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   15163:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 15164:         } else {
1.541     raeburn  15165:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 15166:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15167:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   15168:             if ($context eq 'auto') {
                   15169:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   15170:             } else {
                   15171:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   15172:                &mt('Add to classlist').': <b>ok</b>';
                   15173:             }
                   15174:             $output .= $linefeed;
1.443     albertel 15175:         }
                   15176:     } else {
                   15177:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   15178:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15179:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  15180:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  15181:         if ($context eq 'auto') {
                   15182:             $output .= $result.$linefeed;
                   15183:         } else {
                   15184:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   15185:         }
1.443     albertel 15186:     }
                   15187:     return $output;
                   15188: }
                   15189: 
                   15190: sub commit_studentrole {
1.1075.2.31  raeburn  15191:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   15192:         $credits) = @_;
1.626     raeburn  15193:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  15194:     if ($context eq 'auto') {
                   15195:         $linefeed = "\n";
                   15196:     } else {
                   15197:         $linefeed = '<br />'."\n";
                   15198:     }
1.443     albertel 15199:     if (defined($one) && defined($two)) {
                   15200:         my $cid=$one.'_'.$two;
                   15201:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   15202:         my $secchange = 0;
                   15203:         my $expire_role_result;
                   15204:         my $modify_section_result;
1.628     raeburn  15205:         if ($oldsec ne '-1') { 
                   15206:             if ($oldsec ne $sec) {
1.443     albertel 15207:                 $secchange = 1;
1.628     raeburn  15208:                 my $now = time;
1.443     albertel 15209:                 my $uurl='/'.$cid;
                   15210:                 $uurl=~s/\_/\//g;
                   15211:                 if ($oldsec) {
                   15212:                     $uurl.='/'.$oldsec;
                   15213:                 }
1.626     raeburn  15214:                 $oldsecurl = $uurl;
1.628     raeburn  15215:                 $expire_role_result = 
1.1075.2.167  raeburn  15216:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
                   15217:                                                 '','','',$context);
1.628     raeburn  15218:                 if ($env{'request.course.sec'} ne '') { 
                   15219:                     if ($expire_role_result eq 'refused') {
                   15220:                         my @roles = ('st');
                   15221:                         my @statuses = ('previous');
                   15222:                         my @roledoms = ($one);
                   15223:                         my $withsec = 1;
                   15224:                         my %roleshash = 
                   15225:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   15226:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   15227:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   15228:                             my ($oldstart,$oldend) = 
                   15229:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   15230:                             if ($oldend > 0 && $oldend <= $now) {
                   15231:                                 $expire_role_result = 'ok';
                   15232:                             }
                   15233:                         }
                   15234:                     }
                   15235:                 }
1.443     albertel 15236:                 $result = $expire_role_result;
                   15237:             }
                   15238:         }
                   15239:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  15240:             $modify_section_result = 
                   15241:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   15242:                                                            undef,undef,undef,$sec,
                   15243:                                                            $end,$start,'','',$cid,
                   15244:                                                            '',$context,$credits);
1.443     albertel 15245:             if ($modify_section_result =~ /^ok/) {
                   15246:                 if ($secchange == 1) {
1.628     raeburn  15247:                     if ($sec eq '') {
                   15248:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   15249:                     } else {
                   15250:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   15251:                     }
1.443     albertel 15252:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  15253:                     if ($sec eq '') {
                   15254:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   15255:                     } else {
                   15256:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15257:                     }
1.443     albertel 15258:                 } else {
1.628     raeburn  15259:                     if ($sec eq '') {
                   15260:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   15261:                     } else {
                   15262:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15263:                     }
1.443     albertel 15264:                 }
                   15265:             } else {
1.628     raeburn  15266:                 if ($secchange) {       
                   15267:                     $$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;
                   15268:                 } else {
                   15269:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   15270:                 }
1.443     albertel 15271:             }
                   15272:             $result = $modify_section_result;
                   15273:         } elsif ($secchange == 1) {
1.628     raeburn  15274:             if ($oldsec eq '') {
1.1075.2.20  raeburn  15275:                 $$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  15276:             } else {
                   15277:                 $$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;
                   15278:             }
1.626     raeburn  15279:             if ($expire_role_result eq 'refused') {
                   15280:                 my $newsecurl = '/'.$cid;
                   15281:                 $newsecurl =~ s/\_/\//g;
                   15282:                 if ($sec ne '') {
                   15283:                     $newsecurl.='/'.$sec;
                   15284:                 }
                   15285:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   15286:                     if ($sec eq '') {
                   15287:                         $$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;
                   15288:                     } else {
                   15289:                         $$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;
                   15290:                     }
                   15291:                 }
                   15292:             }
1.443     albertel 15293:         }
                   15294:     } else {
1.626     raeburn  15295:         $$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 15296:         $result = "error: incomplete course id\n";
                   15297:     }
                   15298:     return $result;
                   15299: }
                   15300: 
1.1075.2.25  raeburn  15301: sub show_role_extent {
                   15302:     my ($scope,$context,$role) = @_;
                   15303:     $scope =~ s{^/}{};
                   15304:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   15305:     push(@courseroles,'co');
                   15306:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   15307:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   15308:         $scope =~ s{/}{_};
                   15309:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   15310:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   15311:         my ($audom,$auname) = split(/\//,$scope);
                   15312:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   15313:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   15314:     } else {
                   15315:         $scope =~ s{/$}{};
                   15316:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   15317:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   15318:     }
                   15319: }
                   15320: 
1.443     albertel 15321: ############################################################
                   15322: ############################################################
                   15323: 
1.566     albertel 15324: sub check_clone {
1.578     raeburn  15325:     my ($args,$linefeed) = @_;
1.566     albertel 15326:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   15327:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   15328:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   15329:     my $clonemsg;
                   15330:     my $can_clone = 0;
1.944     raeburn  15331:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  15332:     if ($lctype ne 'community') {
                   15333:         $lctype = 'course';
                   15334:     }
1.566     albertel 15335:     if ($clonehome eq 'no_host') {
1.944     raeburn  15336:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15337:             $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'});
                   15338:         } else {
                   15339:             $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'});
                   15340:         }     
1.566     albertel 15341:     } else {
                   15342: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  15343:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15344:             if ($clonedesc{'type'} ne 'Community') {
                   15345:                  $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'});
                   15346:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15347:             }
                   15348:         }
1.1075.2.119  raeburn  15349: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  15350:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 15351: 	    $can_clone = 1;
                   15352: 	} else {
1.1075.2.95  raeburn  15353: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 15354: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  15355:             if ($clonehash{'cloners'} eq '') {
                   15356:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   15357:                 if ($domdefs{'canclone'}) {
                   15358:                     unless ($domdefs{'canclone'} eq 'none') {
                   15359:                         if ($domdefs{'canclone'} eq 'domain') {
                   15360:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   15361:                                 $can_clone = 1;
                   15362:                             }
                   15363:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15364:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   15365:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   15366:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   15367:                                 $can_clone = 1;
                   15368:                             }
                   15369:                         }
                   15370:                     }
1.908     raeburn  15371:                 }
1.1075.2.95  raeburn  15372:             } else {
                   15373: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   15374:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  15375:                     $can_clone = 1;
1.1075.2.95  raeburn  15376:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  15377:                     $can_clone = 1;
1.1075.2.96  raeburn  15378:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   15379:                     $can_clone = 1;
1.1075.2.95  raeburn  15380:                 }
                   15381:                 unless ($can_clone) {
1.1075.2.96  raeburn  15382:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15383:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  15384:                         my (%gotdomdefaults,%gotcodedefaults);
                   15385:                         foreach my $cloner (@cloners) {
                   15386:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   15387:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   15388:                                 my (%codedefaults,@code_order);
                   15389:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   15390:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   15391:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   15392:                                     }
                   15393:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   15394:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   15395:                                     }
                   15396:                                 } else {
                   15397:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   15398:                                                                             \%codedefaults,
                   15399:                                                                             \@code_order);
                   15400:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   15401:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   15402:                                 }
                   15403:                                 if (@code_order > 0) {
                   15404:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   15405:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   15406:                                                                                 $args->{'crscode'})) {
                   15407:                                         $can_clone = 1;
                   15408:                                         last;
                   15409:                                     }
                   15410:                                 }
                   15411:                             }
                   15412:                         }
                   15413:                     }
1.1075.2.96  raeburn  15414:                 }
                   15415:             }
                   15416:             unless ($can_clone) {
                   15417:                 my $ccrole = 'cc';
                   15418:                 if ($args->{'crstype'} eq 'Community') {
                   15419:                     $ccrole = 'co';
                   15420:                 }
                   15421:                 my %roleshash =
                   15422:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   15423:                                                   $args->{'ccdomain'},
                   15424:                                                   'userroles',['active'],[$ccrole],
                   15425:                                                   [$args->{'clonedomain'}]);
                   15426:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   15427:                     $can_clone = 1;
                   15428:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   15429:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   15430:                     $can_clone = 1;
1.1075.2.95  raeburn  15431:                 }
                   15432:             }
                   15433:             unless ($can_clone) {
                   15434:                 if ($args->{'crstype'} eq 'Community') {
                   15435:                     $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'});
                   15436:                 } else {
                   15437:                     $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  15438: 	        }
1.566     albertel 15439: 	    }
1.578     raeburn  15440:         }
1.566     albertel 15441:     }
                   15442:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15443: }
                   15444: 
1.444     albertel 15445: sub construct_course {
1.1075.2.119  raeburn  15446:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
                   15447:         $cnum,$category,$coderef) = @_;
1.444     albertel 15448:     my $outcome;
1.541     raeburn  15449:     my $linefeed =  '<br />'."\n";
                   15450:     if ($context eq 'auto') {
                   15451:         $linefeed = "\n";
                   15452:     }
1.566     albertel 15453: 
                   15454: #
                   15455: # Are we cloning?
                   15456: #
                   15457:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15458:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  15459: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 15460: 	if ($context ne 'auto') {
1.578     raeburn  15461:             if ($clonemsg ne '') {
                   15462: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   15463:             }
1.566     albertel 15464: 	}
                   15465: 	$outcome .= $clonemsg.$linefeed;
                   15466: 
                   15467:         if (!$can_clone) {
                   15468: 	    return (0,$outcome);
                   15469: 	}
                   15470:     }
                   15471: 
1.444     albertel 15472: #
                   15473: # Open course
                   15474: #
                   15475:     my $crstype = lc($args->{'crstype'});
                   15476:     my %cenv=();
                   15477:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   15478:                                              $args->{'cdescr'},
                   15479:                                              $args->{'curl'},
                   15480:                                              $args->{'course_home'},
                   15481:                                              $args->{'nonstandard'},
                   15482:                                              $args->{'crscode'},
                   15483:                                              $args->{'ccuname'}.':'.
                   15484:                                              $args->{'ccdomain'},
1.882     raeburn  15485:                                              $args->{'crstype'},
1.885     raeburn  15486:                                              $cnum,$context,$category);
1.444     albertel 15487: 
                   15488:     # Note: The testing routines depend on this being output; see 
                   15489:     # Utils::Course. This needs to at least be output as a comment
                   15490:     # if anyone ever decides to not show this, and Utils::Course::new
                   15491:     # will need to be suitably modified.
1.541     raeburn  15492:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  15493:     if ($$courseid =~ /^error:/) {
                   15494:         return (0,$outcome);
                   15495:     }
                   15496: 
1.444     albertel 15497: #
                   15498: # Check if created correctly
                   15499: #
1.479     albertel 15500:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 15501:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  15502:     if ($crsuhome eq 'no_host') {
                   15503:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   15504:         return (0,$outcome);
                   15505:     }
1.541     raeburn  15506:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 15507: 
1.444     albertel 15508: #
1.566     albertel 15509: # Do the cloning
                   15510: #   
                   15511:     if ($can_clone && $cloneid) {
                   15512: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   15513: 	if ($context ne 'auto') {
                   15514: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   15515: 	}
                   15516: 	$outcome .= $clonemsg.$linefeed;
                   15517: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 15518: # Copy all files
1.637     www      15519: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 15520: # Restore URL
1.566     albertel 15521: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 15522: # Restore title
1.566     albertel 15523: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  15524: # Restore creation date, creator and creation context.
                   15525:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   15526:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   15527:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 15528: # Mark as cloned
1.566     albertel 15529: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      15530: # Need to clone grading mode
                   15531:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   15532:         $cenv{'grading'}=$newenv{'grading'};
                   15533: # Do not clone these environment entries
                   15534:         &Apache::lonnet::del('environment',
                   15535:                   ['default_enrollment_start_date',
                   15536:                    'default_enrollment_end_date',
                   15537:                    'question.email',
                   15538:                    'policy.email',
                   15539:                    'comment.email',
                   15540:                    'pch.users.denied',
1.725     raeburn  15541:                    'plc.users.denied',
                   15542:                    'hidefromcat',
1.1075.2.36  raeburn  15543:                    'checkforpriv',
1.1075.2.158  raeburn  15544:                    'categories'],
1.638     www      15545:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  15546:         if ($args->{'textbook'}) {
                   15547:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   15548:         }
1.444     albertel 15549:     }
1.566     albertel 15550: 
1.444     albertel 15551: #
                   15552: # Set environment (will override cloned, if existing)
                   15553: #
                   15554:     my @sections = ();
                   15555:     my @xlists = ();
                   15556:     if ($args->{'crstype'}) {
                   15557:         $cenv{'type'}=$args->{'crstype'};
                   15558:     }
                   15559:     if ($args->{'crsid'}) {
                   15560:         $cenv{'courseid'}=$args->{'crsid'};
                   15561:     }
                   15562:     if ($args->{'crscode'}) {
                   15563:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   15564:     }
                   15565:     if ($args->{'crsquota'} ne '') {
                   15566:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   15567:     } else {
                   15568:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   15569:     }
                   15570:     if ($args->{'ccuname'}) {
                   15571:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   15572:                                         ':'.$args->{'ccdomain'};
                   15573:     } else {
                   15574:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   15575:     }
1.1075.2.31  raeburn  15576:     if ($args->{'defaultcredits'}) {
                   15577:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   15578:     }
1.444     albertel 15579:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1075.2.166  raeburn  15580:     my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444     albertel 15581:     if ($args->{'crssections'}) {
                   15582:         $cenv{'internal.sectionnums'} = '';
                   15583:         if ($args->{'crssections'} =~ m/,/) {
                   15584:             @sections = split/,/,$args->{'crssections'};
                   15585:         } else {
                   15586:             $sections[0] = $args->{'crssections'};
                   15587:         }
                   15588:         if (@sections > 0) {
                   15589:             foreach my $item (@sections) {
                   15590:                 my ($sec,$gp) = split/:/,$item;
                   15591:                 my $class = $args->{'crscode'}.$sec;
                   15592:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   15593:                 $cenv{'internal.sectionnums'} .= $item.',';
1.1075.2.166  raeburn  15594:                 if ($addcheck eq 'ok') {
                   15595:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   15596:                         push(@oklcsecs,$gp);
                   15597:                     }
                   15598:                 } else {
1.1075.2.119  raeburn  15599:                     push(@badclasses,$class);
1.444     albertel 15600:                 }
                   15601:             }
                   15602:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   15603:         }
                   15604:     }
                   15605: # do not hide course coordinator from staff listing, 
                   15606: # even if privileged
                   15607:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  15608: # add course coordinator's domain to domains to check for privileged users
                   15609: # if different to course domain
                   15610:     if ($$crsudom ne $args->{'ccdomain'}) {
                   15611:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   15612:     }
1.444     albertel 15613: # add crosslistings
                   15614:     if ($args->{'crsxlist'}) {
                   15615:         $cenv{'internal.crosslistings'}='';
                   15616:         if ($args->{'crsxlist'} =~ m/,/) {
                   15617:             @xlists = split/,/,$args->{'crsxlist'};
                   15618:         } else {
                   15619:             $xlists[0] = $args->{'crsxlist'};
                   15620:         }
                   15621:         if (@xlists > 0) {
                   15622:             foreach my $item (@xlists) {
                   15623:                 my ($xl,$gp) = split/:/,$item;
                   15624:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   15625:                 $cenv{'internal.crosslistings'} .= $item.',';
1.1075.2.166  raeburn  15626:                 if ($addcheck eq 'ok') {
                   15627:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   15628:                         push(@oklcsecs,$gp);
                   15629:                     }
                   15630:                 } else {
1.1075.2.119  raeburn  15631:                     push(@badclasses,$xl);
1.444     albertel 15632:                 }
                   15633:             }
                   15634:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   15635:         }
                   15636:     }
                   15637:     if ($args->{'autoadds'}) {
                   15638:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   15639:     }
                   15640:     if ($args->{'autodrops'}) {
                   15641:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   15642:     }
                   15643: # check for notification of enrollment changes
                   15644:     my @notified = ();
                   15645:     if ($args->{'notify_owner'}) {
                   15646:         if ($args->{'ccuname'} ne '') {
                   15647:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   15648:         }
                   15649:     }
                   15650:     if ($args->{'notify_dc'}) {
                   15651:         if ($uname ne '') { 
1.630     raeburn  15652:             push(@notified,$uname.':'.$udom);
1.444     albertel 15653:         }
                   15654:     }
                   15655:     if (@notified > 0) {
                   15656:         my $notifylist;
                   15657:         if (@notified > 1) {
                   15658:             $notifylist = join(',',@notified);
                   15659:         } else {
                   15660:             $notifylist = $notified[0];
                   15661:         }
                   15662:         $cenv{'internal.notifylist'} = $notifylist;
                   15663:     }
                   15664:     if (@badclasses > 0) {
                   15665:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  15666:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   15667:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   15668:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 15669:         );
1.1075.2.119  raeburn  15670:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   15671:                            &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  15672:         if ($context eq 'auto') {
                   15673:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  15674:         } else {
1.566     albertel 15675:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  15676:         }
                   15677:         foreach my $item (@badclasses) {
1.541     raeburn  15678:             if ($context eq 'auto') {
1.1075.2.119  raeburn  15679:                 $outcome .= " - $item\n";
1.541     raeburn  15680:             } else {
1.1075.2.119  raeburn  15681:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  15682:             }
1.1075.2.119  raeburn  15683:         }
                   15684:         if ($context eq 'auto') {
                   15685:             $outcome .= $linefeed;
                   15686:         } else {
                   15687:             $outcome .= "</ul><br /><br /></div>\n";
                   15688:         }
1.444     albertel 15689:     }
                   15690:     if ($args->{'no_end_date'}) {
                   15691:         $args->{'endaccess'} = 0;
                   15692:     }
1.1075.2.166  raeburn  15693: #  If an official course with institutional sections is created by cloning
                   15694: #  an existing course, section-specific hiding of course totals in student's
                   15695: #  view of grades as copied from cloned course, will be checked for valid
                   15696: #  sections.
                   15697:     if (($can_clone && $cloneid) &&
                   15698:         ($cenv{'internal.coursecode'} ne '') &&
                   15699:         ($cenv{'grading'} eq 'standard') &&
                   15700:         ($cenv{'hidetotals'} ne '') &&
                   15701:         ($cenv{'hidetotals'} ne 'all')) {
                   15702:         my @hidesecs;
                   15703:         my $deletehidetotals;
                   15704:         if (@oklcsecs) {
                   15705:             foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
                   15706:                 if (grep(/^\Q$sec$/,@oklcsecs)) {
                   15707:                     push(@hidesecs,$sec);
                   15708:                 }
                   15709:             }
                   15710:             if (@hidesecs) {
                   15711:                 $cenv{'hidetotals'} = join(',',@hidesecs);
                   15712:             } else {
                   15713:                 $deletehidetotals = 1;
                   15714:             }
                   15715:         } else {
                   15716:             $deletehidetotals = 1;
                   15717:         }
                   15718:         if ($deletehidetotals) {
                   15719:             delete($cenv{'hidetotals'});
                   15720:             &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
                   15721:         }
                   15722:     }
1.444     albertel 15723:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   15724:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   15725:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   15726:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   15727:     if ($args->{'showphotos'}) {
                   15728:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   15729:     }
                   15730:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   15731:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   15732:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   15733:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  15734:             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'); 
                   15735:             if ($context eq 'auto') {
                   15736:                 $outcome .= $krb_msg;
                   15737:             } else {
1.566     albertel 15738:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  15739:             }
                   15740:             $outcome .= $linefeed;
1.444     albertel 15741:         }
                   15742:     }
                   15743:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   15744:        if ($args->{'setpolicy'}) {
                   15745:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15746:        }
                   15747:        if ($args->{'setcontent'}) {
                   15748:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15749:        }
1.1075.2.110  raeburn  15750:        if ($args->{'setcomment'}) {
                   15751:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15752:        }
1.444     albertel 15753:     }
                   15754:     if ($args->{'reshome'}) {
                   15755: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   15756: 	$cenv{'reshome'}=~s/\/+$/\//;
                   15757:     }
                   15758: #
                   15759: # course has keyed access
                   15760: #
                   15761:     if ($args->{'setkeys'}) {
                   15762:        $cenv{'keyaccess'}='yes';
                   15763:     }
                   15764: # if specified, key authority is not course, but user
                   15765: # only active if keyaccess is yes
                   15766:     if ($args->{'keyauth'}) {
1.487     albertel 15767: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   15768: 	$user = &LONCAPA::clean_username($user);
                   15769: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     15770: 	if ($user ne '' && $domain ne '') {
1.487     albertel 15771: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 15772: 	}
                   15773:     }
                   15774: 
1.1075.2.59  raeburn  15775: #
                   15776: #  generate and store uniquecode (available to course requester), if course should have one.
                   15777: #
                   15778:     if ($args->{'uniquecode'}) {
                   15779:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   15780:         if ($code) {
                   15781:             $cenv{'internal.uniquecode'} = $code;
                   15782:             my %crsinfo =
                   15783:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   15784:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   15785:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   15786:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   15787:             }
                   15788:             if (ref($coderef)) {
                   15789:                 $$coderef = $code;
                   15790:             }
                   15791:         }
                   15792:     }
                   15793: 
1.444     albertel 15794:     if ($args->{'disresdis'}) {
                   15795:         $cenv{'pch.roles.denied'}='st';
                   15796:     }
                   15797:     if ($args->{'disablechat'}) {
                   15798:         $cenv{'plc.roles.denied'}='st';
                   15799:     }
                   15800: 
                   15801:     # Record we've not yet viewed the Course Initialization Helper for this 
                   15802:     # course
                   15803:     $cenv{'course.helper.not.run'} = 1;
                   15804:     #
                   15805:     # Use new Randomseed
                   15806:     #
                   15807:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   15808:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   15809:     #
                   15810:     # The encryption code and receipt prefix for this course
                   15811:     #
                   15812:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   15813:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   15814:     #
                   15815:     # By default, use standard grading
                   15816:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   15817: 
1.541     raeburn  15818:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   15819:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15820: #
                   15821: # Open all assignments
                   15822: #
                   15823:     if ($args->{'openall'}) {
1.1075.2.146  raeburn  15824:        my $opendate = time;
                   15825:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   15826:            $opendate = $args->{'openallfrom'};
                   15827:        }
1.444     albertel 15828:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.146  raeburn  15829:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 15830:                            $storeunder.'.type' => 'date_start');
1.1075.2.146  raeburn  15831:        $outcome .= &mt('All assignments open starting [_1]',
                   15832:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   15833:                    &Apache::lonnet::cput
                   15834:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15835:    }
                   15836: #
                   15837: # Set first page
                   15838: #
                   15839:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   15840: 	    || ($cloneid)) {
1.445     albertel 15841: 	use LONCAPA::map;
1.444     albertel 15842: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 15843: 
                   15844: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   15845:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   15846: 
1.444     albertel 15847:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   15848:         my $title; my $url;
                   15849:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   15850: 	    $title=&mt('Syllabus');
1.444     albertel 15851:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   15852:         } else {
1.963     raeburn  15853:             $title=&mt('Table of Contents');
1.444     albertel 15854:             $url='/adm/navmaps';
                   15855:         }
1.445     albertel 15856: 
                   15857:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   15858: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   15859: 
                   15860: 	if ($errtext) { $fatal=2; }
1.541     raeburn  15861:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 15862:     }
1.566     albertel 15863: 
                   15864:     return (1,$outcome);
1.444     albertel 15865: }
                   15866: 
1.1075.2.59  raeburn  15867: sub make_unique_code {
                   15868:     my ($cdom,$cnum) = @_;
                   15869:     # get lock on uniquecodes db
                   15870:     my $lockhash = {
                   15871:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   15872:                                                   ':'.$env{'user.domain'},
                   15873:                    };
                   15874:     my $tries = 0;
                   15875:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15876:     my ($code,$error);
                   15877: 
                   15878:     while (($gotlock ne 'ok') && ($tries<3)) {
                   15879:         $tries ++;
                   15880:         sleep 1;
                   15881:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15882:     }
                   15883:     if ($gotlock eq 'ok') {
                   15884:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   15885:         my $gotcode;
                   15886:         my $attempts = 0;
                   15887:         while ((!$gotcode) && ($attempts < 100)) {
                   15888:             $code = &generate_code();
                   15889:             if (!exists($currcodes{$code})) {
                   15890:                 $gotcode = 1;
                   15891:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   15892:                     $error = 'nostore';
                   15893:                 }
                   15894:             }
                   15895:             $attempts ++;
                   15896:         }
                   15897:         my @del_lock = ($cnum."\0".'uniquecodes');
                   15898:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   15899:     } else {
                   15900:         $error = 'nolock';
                   15901:     }
                   15902:     return ($code,$error);
                   15903: }
                   15904: 
                   15905: sub generate_code {
                   15906:     my $code;
                   15907:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   15908:     for (my $i=0; $i<6; $i++) {
                   15909:         my $lettnum = int (rand 2);
                   15910:         my $item = '';
                   15911:         if ($lettnum) {
                   15912:             $item = $letts[int( rand(18) )];
                   15913:         } else {
                   15914:             $item = 1+int( rand(8) );
                   15915:         }
                   15916:         $code .= $item;
                   15917:     }
                   15918:     return $code;
                   15919: }
                   15920: 
1.444     albertel 15921: ############################################################
                   15922: ############################################################
                   15923: 
1.953     droeschl 15924: #SD
                   15925: # only Community and Course, or anything else?
1.378     raeburn  15926: sub course_type {
                   15927:     my ($cid) = @_;
                   15928:     if (!defined($cid)) {
                   15929:         $cid = $env{'request.course.id'};
                   15930:     }
1.404     albertel 15931:     if (defined($env{'course.'.$cid.'.type'})) {
                   15932:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  15933:     } else {
                   15934:         return 'Course';
1.377     raeburn  15935:     }
                   15936: }
1.156     albertel 15937: 
1.406     raeburn  15938: sub group_term {
                   15939:     my $crstype = &course_type();
                   15940:     my %names = (
                   15941:                   'Course' => 'group',
1.865     raeburn  15942:                   'Community' => 'group',
1.406     raeburn  15943:                 );
                   15944:     return $names{$crstype};
                   15945: }
                   15946: 
1.902     raeburn  15947: sub course_types {
1.1075.2.59  raeburn  15948:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  15949:     my %typename = (
                   15950:                          official   => 'Official course',
                   15951:                          unofficial => 'Unofficial course',
                   15952:                          community  => 'Community',
1.1075.2.59  raeburn  15953:                          textbook   => 'Textbook course',
1.902     raeburn  15954:                    );
                   15955:     return (\@types,\%typename);
                   15956: }
                   15957: 
1.156     albertel 15958: sub icon {
                   15959:     my ($file)=@_;
1.505     albertel 15960:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 15961:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 15962:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 15963:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   15964: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   15965: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15966: 	            $curfext.".gif") {
                   15967: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15968: 		$curfext.".gif";
                   15969: 	}
                   15970:     }
1.249     albertel 15971:     return &lonhttpdurl($iconname);
1.154     albertel 15972: } 
1.84      albertel 15973: 
1.575     albertel 15974: sub lonhttpdurl {
1.692     www      15975: #
                   15976: # Had been used for "small fry" static images on separate port 8080.
                   15977: # Modify here if lightweight http functionality desired again.
                   15978: # Currently eliminated due to increasing firewall issues.
                   15979: #
1.575     albertel 15980:     my ($url)=@_;
1.692     www      15981:     return $url;
1.215     albertel 15982: }
                   15983: 
1.213     albertel 15984: sub connection_aborted {
                   15985:     my ($r)=@_;
                   15986:     $r->print(" ");$r->rflush();
                   15987:     my $c = $r->connection;
                   15988:     return $c->aborted();
                   15989: }
                   15990: 
1.221     foxr     15991: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     15992: #    strings as 'strings'.
                   15993: sub escape_single {
1.221     foxr     15994:     my ($input) = @_;
1.223     albertel 15995:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     15996:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   15997:     return $input;
                   15998: }
1.223     albertel 15999: 
1.222     foxr     16000: #  Same as escape_single, but escape's "'s  This 
                   16001: #  can be used for  "strings"
                   16002: sub escape_double {
                   16003:     my ($input) = @_;
                   16004:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   16005:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   16006:     return $input;
                   16007: }
1.223     albertel 16008:  
1.222     foxr     16009: #   Escapes the last element of a full URL.
                   16010: sub escape_url {
                   16011:     my ($url)   = @_;
1.238     raeburn  16012:     my @urlslices = split(/\//, $url,-1);
1.369     www      16013:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  16014:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     16015: }
1.462     albertel 16016: 
1.820     raeburn  16017: sub compare_arrays {
                   16018:     my ($arrayref1,$arrayref2) = @_;
                   16019:     my (@difference,%count);
                   16020:     @difference = ();
                   16021:     %count = ();
                   16022:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   16023:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   16024:         foreach my $element (keys(%count)) {
                   16025:             if ($count{$element} == 1) {
                   16026:                 push(@difference,$element);
                   16027:             }
                   16028:         }
                   16029:     }
                   16030:     return @difference;
                   16031: }
                   16032: 
1.1075.2.152  raeburn  16033: sub lon_status_items {
                   16034:     my %defaults = (
                   16035:                      E         => 100,
                   16036:                      W         => 4,
                   16037:                      N         => 1,
                   16038:                      U         => 5,
                   16039:                      threshold => 200,
                   16040:                      sysmail   => 2500,
                   16041:                    );
                   16042:     my %names = (
                   16043:                    E => 'Errors',
                   16044:                    W => 'Warnings',
                   16045:                    N => 'Notices',
                   16046:                    U => 'Unsent',
                   16047:                 );
                   16048:     return (\%defaults,\%names);
                   16049: }
                   16050: 
1.817     bisitz   16051: # -------------------------------------------------------- Initialize user login
1.462     albertel 16052: sub init_user_environment {
1.463     albertel 16053:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 16054:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   16055: 
                   16056:     my $public=($username eq 'public' && $domain eq 'public');
                   16057: 
                   16058: # See if old ID present, if so, remove
                   16059: 
1.1062    raeburn  16060:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 16061:     my $now=time;
                   16062: 
                   16063:     if ($public) {
                   16064: 	my $max_public=100;
                   16065: 	my $oldest;
                   16066: 	my $oldest_time=0;
                   16067: 	for(my $next=1;$next<=$max_public;$next++) {
                   16068: 	    if (-e $lonids."/publicuser_$next.id") {
                   16069: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   16070: 		if ($mtime<$oldest_time || !$oldest_time) {
                   16071: 		    $oldest_time=$mtime;
                   16072: 		    $oldest=$next;
                   16073: 		}
                   16074: 	    } else {
                   16075: 		$cookie="publicuser_$next";
                   16076: 		last;
                   16077: 	    }
                   16078: 	}
                   16079: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   16080:     } else {
1.463     albertel 16081: 	# if this isn't a robot, kill any existing non-robot sessions
                   16082: 	if (!$args->{'robot'}) {
                   16083: 	    opendir(DIR,$lonids);
                   16084: 	    while ($filename=readdir(DIR)) {
                   16085: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136  raeburn  16086:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   16087:                             &GDBM_READER(),0640)) {
                   16088:                         my $linkedfile;
                   16089:                         if (exists($oldenv{'user.linkedenv'})) {
                   16090:                             $linkedfile = $oldenv{'user.linkedenv'};
                   16091:                         }
                   16092:                         untie(%oldenv);
                   16093:                         if (unlink("$lonids/$filename")) {
                   16094:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   16095:                                 if (-l "$lonids/$linkedfile.id") {
                   16096:                                     unlink("$lonids/$linkedfile.id");
                   16097:                                 }
                   16098:                             }
                   16099:                         }
                   16100:                     } else {
                   16101:                         unlink($lonids.'/'.$filename);
                   16102:                     }
1.463     albertel 16103: 		}
1.462     albertel 16104: 	    }
1.463     albertel 16105: 	    closedir(DIR);
1.1075.2.84  raeburn  16106: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   16107:             my $namespace = 'nohist_courseeditor';
                   16108:             my $lockingkey = 'paste'."\0".'locked_num';
                   16109:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   16110:                                                 $domain,$username);
                   16111:             if (exists($lockhash{$lockingkey})) {
                   16112:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   16113:                 unless ($delresult eq 'ok') {
                   16114:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   16115:                 }
                   16116:             }
1.462     albertel 16117: 	}
                   16118: # Give them a new cookie
1.463     albertel 16119: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      16120: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 16121: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 16122:     
                   16123: # Initialize roles
                   16124: 
1.1062    raeburn  16125: 	($userroles,$firstaccenv,$timerintenv) = 
                   16126:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 16127:     }
                   16128: # ------------------------------------ Check browser type and MathML capability
                   16129: 
1.1075.2.77  raeburn  16130:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   16131:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 16132: 
                   16133: # ------------------------------------------------------------- Get environment
                   16134: 
                   16135:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   16136:     my ($tmp) = keys(%userenv);
                   16137:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   16138:     } else {
                   16139: 	undef(%userenv);
                   16140:     }
                   16141:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   16142: 	$form->{'interface'}=$userenv{'interface'};
                   16143:     }
                   16144:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   16145: 
                   16146: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   16147:     foreach my $option ('interface','localpath','localres') {
                   16148:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 16149:     }
                   16150: # --------------------------------------------------------- Write first profile
                   16151: 
                   16152:     {
1.1075.2.150  raeburn  16153:         my $ip = &Apache::lonnet::get_requestor_ip();
1.462     albertel 16154: 	my %initial_env = 
                   16155: 	    ("user.name"          => $username,
                   16156: 	     "user.domain"        => $domain,
                   16157: 	     "user.home"          => $authhost,
                   16158: 	     "browser.type"       => $clientbrowser,
                   16159: 	     "browser.version"    => $clientversion,
                   16160: 	     "browser.mathml"     => $clientmathml,
                   16161: 	     "browser.unicode"    => $clientunicode,
                   16162: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  16163:              "browser.mobile"     => $clientmobile,
                   16164:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  16165:              "browser.osversion"  => $clientosversion,
1.462     albertel 16166: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   16167: 	     "request.course.fn"  => '',
                   16168: 	     "request.course.uri" => '',
                   16169: 	     "request.course.sec" => '',
                   16170: 	     "request.role"       => 'cm',
                   16171: 	     "request.role.adv"   => $env{'user.adv'},
1.1075.2.150  raeburn  16172: 	     "request.host"       => $ip,);
1.462     albertel 16173: 
                   16174:         if ($form->{'localpath'}) {
                   16175: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   16176: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   16177:         }
                   16178: 	
                   16179: 	if ($form->{'interface'}) {
                   16180: 	    $form->{'interface'}=~s/\W//gs;
                   16181: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   16182: 	    $env{'browser.interface'}=$form->{'interface'};
                   16183: 	}
                   16184: 
1.1075.2.54  raeburn  16185:         if ($form->{'iptoken'}) {
                   16186:             my $lonhost = $r->dir_config('lonHostID');
                   16187:             $initial_env{"user.noloadbalance"} = $lonhost;
                   16188:             $env{'user.noloadbalance'} = $lonhost;
                   16189:         }
                   16190: 
1.1075.2.120  raeburn  16191:         if ($form->{'noloadbalance'}) {
                   16192:             my @hosts = &Apache::lonnet::current_machine_ids();
                   16193:             my $hosthere = $form->{'noloadbalance'};
                   16194:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   16195:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   16196:                 $env{'user.noloadbalance'} = $hosthere;
                   16197:             }
                   16198:         }
                   16199: 
1.1016    raeburn  16200:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  16201:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   16202:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  16203: 
1.1075.2.125  raeburn  16204:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   16205:                 $userenv{'availabletools.'.$tool} = 
                   16206:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   16207:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   16208:             }
1.724     raeburn  16209: 
1.1075.2.125  raeburn  16210:             foreach my $crstype ('official','unofficial','community','textbook') {
                   16211:                 $userenv{'canrequest.'.$crstype} =
                   16212:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   16213:                                                       'reload','requestcourses',
                   16214:                                                       \%userenv,\%domdef,\%is_adv);
                   16215:             }
1.765     raeburn  16216: 
1.1075.2.125  raeburn  16217:             $userenv{'canrequest.author'} =
                   16218:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   16219:                                                   'reload','requestauthor',
                   16220:                                                   \%userenv,\%domdef,\%is_adv);
                   16221:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   16222:                                                  $domain,$username);
                   16223:             my $reqstatus = $reqauthor{'author_status'};
                   16224:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   16225:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   16226:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   16227:                                                       $reqauthor{'author'}{'timestamp'};
                   16228:                 }
1.1075.2.14  raeburn  16229:             }
                   16230:         }
                   16231: 
1.462     albertel 16232: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  16233: 
1.462     albertel 16234: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   16235: 		 &GDBM_WRCREAT(),0640)) {
                   16236: 	    &_add_to_env(\%disk_env,\%initial_env);
                   16237: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   16238: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  16239:             if (ref($firstaccenv) eq 'HASH') {
                   16240:                 &_add_to_env(\%disk_env,$firstaccenv);
                   16241:             }
                   16242:             if (ref($timerintenv) eq 'HASH') {
                   16243:                 &_add_to_env(\%disk_env,$timerintenv);
                   16244:             }
1.463     albertel 16245: 	    if (ref($args->{'extra_env'})) {
                   16246: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   16247: 	    }
1.462     albertel 16248: 	    untie(%disk_env);
                   16249: 	} else {
1.705     tempelho 16250: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   16251: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 16252: 	    return 'error: '.$!;
                   16253: 	}
                   16254:     }
                   16255:     $env{'request.role'}='cm';
                   16256:     $env{'request.role.adv'}=$env{'user.adv'};
                   16257:     $env{'browser.type'}=$clientbrowser;
                   16258: 
                   16259:     return $cookie;
                   16260: 
                   16261: }
                   16262: 
                   16263: sub _add_to_env {
                   16264:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  16265:     if (ref($env_data) eq 'HASH') {
                   16266:         while (my ($key,$value) = each(%$env_data)) {
                   16267: 	    $idf->{$prefix.$key} = $value;
                   16268: 	    $env{$prefix.$key}   = $value;
                   16269:         }
1.462     albertel 16270:     }
                   16271: }
                   16272: 
1.685     tempelho 16273: # --- Get the symbolic name of a problem and the url
                   16274: sub get_symb {
                   16275:     my ($request,$silent) = @_;
1.726     raeburn  16276:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 16277:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   16278:     if ($symb eq '') {
                   16279:         if (!$silent) {
1.1071    raeburn  16280:             if (ref($request)) { 
                   16281:                 $request->print("Unable to handle ambiguous references:$url:.");
                   16282:             }
1.685     tempelho 16283:             return ();
                   16284:         }
                   16285:     }
                   16286:     &Apache::lonenc::check_decrypt(\$symb);
                   16287:     return ($symb);
                   16288: }
                   16289: 
                   16290: # --------------------------------------------------------------Get annotation
                   16291: 
                   16292: sub get_annotation {
                   16293:     my ($symb,$enc) = @_;
                   16294: 
                   16295:     my $key = $symb;
                   16296:     if (!$enc) {
                   16297:         $key =
                   16298:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   16299:     }
                   16300:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   16301:     return $annotation{$key};
                   16302: }
                   16303: 
                   16304: sub clean_symb {
1.731     raeburn  16305:     my ($symb,$delete_enc) = @_;
1.685     tempelho 16306: 
                   16307:     &Apache::lonenc::check_decrypt(\$symb);
                   16308:     my $enc = $env{'request.enc'};
1.731     raeburn  16309:     if ($delete_enc) {
1.730     raeburn  16310:         delete($env{'request.enc'});
                   16311:     }
1.685     tempelho 16312: 
                   16313:     return ($symb,$enc);
                   16314: }
1.462     albertel 16315: 
1.1075.2.69  raeburn  16316: ############################################################
                   16317: ############################################################
                   16318: 
                   16319: =pod
                   16320: 
                   16321: =head1 Routines for building display used to search for courses
                   16322: 
                   16323: 
                   16324: =over 4
                   16325: 
                   16326: =item * &build_filters()
                   16327: 
                   16328: Create markup for a table used to set filters to use when selecting
                   16329: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   16330: and quotacheck.pl
                   16331: 
                   16332: 
                   16333: Inputs:
                   16334: 
                   16335: filterlist - anonymous array of fields to include as potential filters
                   16336: 
                   16337: crstype - course type
                   16338: 
                   16339: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   16340:               to pop-open a course selector (will contain "extra element").
                   16341: 
                   16342: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   16343: 
                   16344: filter - anonymous hash of criteria and their values
                   16345: 
                   16346: action - form action
                   16347: 
                   16348: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   16349: 
                   16350: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   16351: 
                   16352: cloneruname - username of owner of new course who wants to clone
                   16353: 
                   16354: clonerudom - domain of owner of new course who wants to clone
                   16355: 
                   16356: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   16357: 
                   16358: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   16359: 
                   16360: codedom - domain
                   16361: 
                   16362: formname - value of form element named "form".
                   16363: 
                   16364: fixeddom - domain, if fixed.
                   16365: 
                   16366: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   16367: 
                   16368: cnameelement - name of form element in form on opener page which will receive title of selected course
                   16369: 
                   16370: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   16371: 
                   16372: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   16373: 
                   16374: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   16375: 
                   16376: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   16377: 
                   16378: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   16379: 
                   16380: 
                   16381: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   16382: 
                   16383: 
                   16384: Side Effects: None
                   16385: 
                   16386: =cut
                   16387: 
                   16388: # ---------------------------------------------- search for courses based on last activity etc.
                   16389: 
                   16390: sub build_filters {
                   16391:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   16392:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   16393:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   16394:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   16395:         $clonetext,$clonewarning) = @_;
                   16396:     my ($list,$jscript);
                   16397:     my $onchange = 'javascript:updateFilters(this)';
                   16398:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   16399:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   16400:         $typeselectform,$instcodetitle);
                   16401:     if ($formname eq '') {
                   16402:         $formname = $caller;
                   16403:     }
                   16404:     foreach my $item (@{$filterlist}) {
                   16405:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   16406:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   16407:             if ($item eq 'domainfilter') {
                   16408:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   16409:             } elsif ($item eq 'coursefilter') {
                   16410:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   16411:             } elsif ($item eq 'ownerfilter') {
                   16412:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16413:             } elsif ($item eq 'ownerdomfilter') {
                   16414:                 $filter->{'ownerdomfilter'} =
                   16415:                     &LONCAPA::clean_domain($filter->{$item});
                   16416:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   16417:                                                        'ownerdomfilter',1);
                   16418:             } elsif ($item eq 'personfilter') {
                   16419:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16420:             } elsif ($item eq 'persondomfilter') {
                   16421:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   16422:                                                         'persondomfilter',1);
                   16423:             } else {
                   16424:                 $filter->{$item} =~ s/\W//g;
                   16425:             }
                   16426:             if (!$filter->{$item}) {
                   16427:                 $filter->{$item} = '';
                   16428:             }
                   16429:         }
                   16430:         if ($item eq 'domainfilter') {
                   16431:             my $allow_blank = 1;
                   16432:             if ($formname eq 'portform') {
                   16433:                 $allow_blank=0;
                   16434:             } elsif ($formname eq 'studentform') {
                   16435:                 $allow_blank=0;
                   16436:             }
                   16437:             if ($fixeddom) {
                   16438:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   16439:                                     ' value="'.$codedom.'" />'.
                   16440:                                     &Apache::lonnet::domain($codedom,'description');
                   16441:             } else {
                   16442:                 $domainselectform = &select_dom_form($filter->{$item},
                   16443:                                                      'domainfilter',
                   16444:                                                       $allow_blank,'',$onchange);
                   16445:             }
                   16446:         } else {
                   16447:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   16448:         }
                   16449:     }
                   16450: 
                   16451:     # last course activity filter and selection
                   16452:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   16453: 
                   16454:     # course created filter and selection
                   16455:     if (exists($filter->{'createdfilter'})) {
                   16456:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   16457:     }
                   16458: 
                   16459:     my %lt = &Apache::lonlocal::texthash(
                   16460:                 'cac' => "$crstype Activity",
                   16461:                 'ccr' => "$crstype Created",
                   16462:                 'cde' => "$crstype Title",
                   16463:                 'cdo' => "$crstype Domain",
                   16464:                 'ins' => 'Institutional Code',
                   16465:                 'inc' => 'Institutional Categorization',
                   16466:                 'cow' => "$crstype Owner/Co-owner",
                   16467:                 'cop' => "$crstype Personnel Includes",
                   16468:                 'cog' => 'Type',
                   16469:              );
                   16470: 
                   16471:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16472:         my $typeval = 'Course';
                   16473:         if ($crstype eq 'Community') {
                   16474:             $typeval = 'Community';
                   16475:         }
                   16476:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   16477:     } else {
                   16478:         $typeselectform =  '<select name="type" size="1"';
                   16479:         if ($onchange) {
                   16480:             $typeselectform .= ' onchange="'.$onchange.'"';
                   16481:         }
                   16482:         $typeselectform .= '>'."\n";
                   16483:         foreach my $posstype ('Course','Community') {
                   16484:             $typeselectform.='<option value="'.$posstype.'"'.
                   16485:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   16486:         }
                   16487:         $typeselectform.="</select>";
                   16488:     }
                   16489: 
                   16490:     my ($cloneableonlyform,$cloneabletitle);
                   16491:     if (exists($filter->{'cloneableonly'})) {
                   16492:         my $cloneableon = '';
                   16493:         my $cloneableoff = ' checked="checked"';
                   16494:         if ($filter->{'cloneableonly'}) {
                   16495:             $cloneableon = $cloneableoff;
                   16496:             $cloneableoff = '';
                   16497:         }
                   16498:         $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>';
                   16499:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  16500:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  16501:         } else {
                   16502:             $cloneabletitle = &mt('Cloneable by you');
                   16503:         }
                   16504:     }
                   16505:     my $officialjs;
                   16506:     if ($crstype eq 'Course') {
                   16507:         if (exists($filter->{'instcodefilter'})) {
                   16508: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   16509: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   16510:             if ($codedom) {
                   16511:                 $officialjs = 1;
                   16512:                 ($instcodeform,$jscript,$$numtitlesref) =
                   16513:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   16514:                                                                   $officialjs,$codetitlesref);
                   16515:                 if ($jscript) {
                   16516:                     $jscript = '<script type="text/javascript">'."\n".
                   16517:                                '// <![CDATA['."\n".
                   16518:                                $jscript."\n".
                   16519:                                '// ]]>'."\n".
                   16520:                                '</script>'."\n";
                   16521:                 }
                   16522:             }
                   16523:             if ($instcodeform eq '') {
                   16524:                 $instcodeform =
                   16525:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   16526:                     $list->{'instcodefilter'}.'" />';
                   16527:                 $instcodetitle = $lt{'ins'};
                   16528:             } else {
                   16529:                 $instcodetitle = $lt{'inc'};
                   16530:             }
                   16531:             if ($fixeddom) {
                   16532:                 $instcodetitle .= '<br />('.$codedom.')';
                   16533:             }
                   16534:         }
                   16535:     }
                   16536:     my $output = qq|
                   16537: <form method="post" name="filterpicker" action="$action">
                   16538: <input type="hidden" name="form" value="$formname" />
                   16539: |;
                   16540:     if ($formname eq 'modifycourse') {
                   16541:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   16542:                    '<input type="hidden" name="prevphase" value="'.
                   16543:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  16544:     } elsif ($formname eq 'quotacheck') {
                   16545:         $output .= qq|
                   16546: <input type="hidden" name="sortby" value="" />
                   16547: <input type="hidden" name="sortorder" value="" />
                   16548: |;
                   16549:     } else {
1.1075.2.69  raeburn  16550:         my $name_input;
                   16551:         if ($cnameelement ne '') {
                   16552:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   16553:                           $cnameelement.'" />';
                   16554:         }
                   16555:         $output .= qq|
                   16556: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   16557: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   16558: $name_input
                   16559: $roleelement
                   16560: $multelement
                   16561: $typeelement
                   16562: |;
                   16563:         if ($formname eq 'portform') {
                   16564:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   16565:         }
                   16566:     }
                   16567:     if ($fixeddom) {
                   16568:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   16569:     }
                   16570:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   16571:     if ($sincefilterform) {
                   16572:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   16573:                   .$sincefilterform
                   16574:                   .&Apache::lonhtmlcommon::row_closure();
                   16575:     }
                   16576:     if ($createdfilterform) {
                   16577:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   16578:                   .$createdfilterform
                   16579:                   .&Apache::lonhtmlcommon::row_closure();
                   16580:     }
                   16581:     if ($domainselectform) {
                   16582:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   16583:                   .$domainselectform
                   16584:                   .&Apache::lonhtmlcommon::row_closure();
                   16585:     }
                   16586:     if ($typeselectform) {
                   16587:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16588:             $output .= $typeselectform;
                   16589:         } else {
                   16590:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   16591:                       .$typeselectform
                   16592:                       .&Apache::lonhtmlcommon::row_closure();
                   16593:         }
                   16594:     }
                   16595:     if ($instcodeform) {
                   16596:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   16597:                   .$instcodeform
                   16598:                   .&Apache::lonhtmlcommon::row_closure();
                   16599:     }
                   16600:     if (exists($filter->{'ownerfilter'})) {
                   16601:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   16602:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16603:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   16604:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16605:                    $ownerdomselectform.'</td></tr></table>'.
                   16606:                    &Apache::lonhtmlcommon::row_closure();
                   16607:     }
                   16608:     if (exists($filter->{'personfilter'})) {
                   16609:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   16610:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16611:                    '<input type="text" name="personfilter" size="20" value="'.
                   16612:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16613:                    $persondomselectform.'</td></tr></table>'.
                   16614:                    &Apache::lonhtmlcommon::row_closure();
                   16615:     }
                   16616:     if (exists($filter->{'coursefilter'})) {
                   16617:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   16618:                   .'<input type="text" name="coursefilter" size="25" value="'
                   16619:                   .$list->{'coursefilter'}.'" />'
                   16620:                   .&Apache::lonhtmlcommon::row_closure();
                   16621:     }
                   16622:     if ($cloneableonlyform) {
                   16623:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   16624:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   16625:     }
                   16626:     if (exists($filter->{'descriptfilter'})) {
                   16627:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   16628:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   16629:                   .$list->{'descriptfilter'}.'" />'
                   16630:                   .&Apache::lonhtmlcommon::row_closure(1);
                   16631:     }
                   16632:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   16633:                '<input type="hidden" name="updater" value="" />'."\n".
                   16634:                '<input type="submit" name="gosearch" value="'.
                   16635:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   16636:     return $jscript.$clonewarning.$output;
                   16637: }
                   16638: 
                   16639: =pod
                   16640: 
                   16641: =item * &timebased_select_form()
                   16642: 
                   16643: Create markup for a dropdown list used to select a time-based
                   16644: filter e.g., Course Activity, Course Created, when searching for courses
                   16645: or communities
                   16646: 
                   16647: Inputs:
                   16648: 
                   16649: item - name of form element (sincefilter or createdfilter)
                   16650: 
                   16651: filter - anonymous hash of criteria and their values
                   16652: 
                   16653: Returns: HTML for a select box contained a blank, then six time selections,
                   16654:          with value set in incoming form variables currently selected.
                   16655: 
                   16656: Side Effects: None
                   16657: 
                   16658: =cut
                   16659: 
                   16660: sub timebased_select_form {
                   16661:     my ($item,$filter) = @_;
                   16662:     if (ref($filter) eq 'HASH') {
                   16663:         $filter->{$item} =~ s/[^\d-]//g;
                   16664:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   16665:         return &select_form(
                   16666:                             $filter->{$item},
                   16667:                             $item,
                   16668:                             {      '-1' => '',
                   16669:                                 '86400' => &mt('today'),
                   16670:                                '604800' => &mt('last week'),
                   16671:                               '2592000' => &mt('last month'),
                   16672:                               '7776000' => &mt('last three months'),
                   16673:                              '15552000' => &mt('last six months'),
                   16674:                              '31104000' => &mt('last year'),
                   16675:                     'select_form_order' =>
                   16676:                            ['-1','86400','604800','2592000','7776000',
                   16677:                             '15552000','31104000']});
                   16678:     }
                   16679: }
                   16680: 
                   16681: =pod
                   16682: 
                   16683: =item * &js_changer()
                   16684: 
                   16685: Create script tag containing Javascript used to submit course search form
                   16686: when course type or domain is changed, and also to hide 'Searching ...' on
                   16687: page load completion for page showing search result.
                   16688: 
                   16689: Inputs: None
                   16690: 
                   16691: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   16692: 
                   16693: Side Effects: None
                   16694: 
                   16695: =cut
                   16696: 
                   16697: sub js_changer {
                   16698:     return <<ENDJS;
                   16699: <script type="text/javascript">
                   16700: // <![CDATA[
                   16701: function updateFilters(caller) {
                   16702:     if (typeof(caller) != "undefined") {
                   16703:         document.filterpicker.updater.value = caller.name;
                   16704:     }
                   16705:     document.filterpicker.submit();
                   16706: }
                   16707: 
                   16708: function hideSearching() {
                   16709:     if (document.getElementById('searching')) {
                   16710:         document.getElementById('searching').style.display = 'none';
                   16711:     }
                   16712:     return;
                   16713: }
                   16714: 
                   16715: // ]]>
                   16716: </script>
                   16717: 
                   16718: ENDJS
                   16719: }
                   16720: 
                   16721: =pod
                   16722: 
                   16723: =item * &search_courses()
                   16724: 
                   16725: Process selected filters form course search form and pass to lonnet::courseiddump
                   16726: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   16727: 
                   16728: Inputs:
                   16729: 
                   16730: dom - domain being searched
                   16731: 
                   16732: type - course type ('Course' or 'Community' or '.' if any).
                   16733: 
                   16734: filter - anonymous hash of criteria and their values
                   16735: 
                   16736: numtitles - for institutional codes - number of categories
                   16737: 
                   16738: cloneruname - optional username of new course owner
                   16739: 
                   16740: clonerudom - optional domain of new course owner
                   16741: 
1.1075.2.95  raeburn  16742: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  16743:             (used when DC is using course creation form)
                   16744: 
                   16745: codetitles - reference to array of titles of components in institutional codes (official courses).
                   16746: 
1.1075.2.95  raeburn  16747: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   16748:            (and so can clone automatically)
                   16749: 
                   16750: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   16751: 
                   16752: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   16753:               courses to clone
1.1075.2.69  raeburn  16754: 
                   16755: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   16756: 
                   16757: 
                   16758: Side Effects: None
                   16759: 
                   16760: =cut
                   16761: 
                   16762: 
                   16763: sub search_courses {
1.1075.2.95  raeburn  16764:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   16765:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  16766:     my (%courses,%showcourses,$cloner);
                   16767:     if (($filter->{'ownerfilter'} ne '') ||
                   16768:         ($filter->{'ownerdomfilter'} ne '')) {
                   16769:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   16770:                                        $filter->{'ownerdomfilter'};
                   16771:     }
                   16772:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   16773:         if (!$filter->{$item}) {
                   16774:             $filter->{$item}='.';
                   16775:         }
                   16776:     }
                   16777:     my $now = time;
                   16778:     my $timefilter =
                   16779:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   16780:     my ($createdbefore,$createdafter);
                   16781:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   16782:         $createdbefore = $now;
                   16783:         $createdafter = $now-$filter->{'createdfilter'};
                   16784:     }
                   16785:     my ($instcodefilter,$regexpok);
                   16786:     if ($numtitles) {
                   16787:         if ($env{'form.official'} eq 'on') {
                   16788:             $instcodefilter =
                   16789:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16790:             $regexpok = 1;
                   16791:         } elsif ($env{'form.official'} eq 'off') {
                   16792:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16793:             unless ($instcodefilter eq '') {
                   16794:                 $regexpok = -1;
                   16795:             }
                   16796:         }
                   16797:     } else {
                   16798:         $instcodefilter = $filter->{'instcodefilter'};
                   16799:     }
                   16800:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   16801:     if ($type eq '') { $type = '.'; }
                   16802: 
                   16803:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   16804:         $cloner = $cloneruname.':'.$clonerudom;
                   16805:     }
                   16806:     %courses = &Apache::lonnet::courseiddump($dom,
                   16807:                                              $filter->{'descriptfilter'},
                   16808:                                              $timefilter,
                   16809:                                              $instcodefilter,
                   16810:                                              $filter->{'combownerfilter'},
                   16811:                                              $filter->{'coursefilter'},
                   16812:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  16813:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  16814:                                              $filter->{'cloneableonly'},
                   16815:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  16816:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  16817:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   16818:         my $ccrole;
                   16819:         if ($type eq 'Community') {
                   16820:             $ccrole = 'co';
                   16821:         } else {
                   16822:             $ccrole = 'cc';
                   16823:         }
                   16824:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   16825:                                                      $filter->{'persondomfilter'},
                   16826:                                                      'userroles',undef,
                   16827:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   16828:                                                      $dom);
                   16829:         foreach my $role (keys(%rolehash)) {
                   16830:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   16831:             my $cid = $cdom.'_'.$cnum;
                   16832:             if (exists($courses{$cid})) {
                   16833:                 if (ref($courses{$cid}) eq 'HASH') {
                   16834:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   16835:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  16836:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  16837:                         }
                   16838:                     } else {
                   16839:                         $courses{$cid}{roles} = [$courserole];
                   16840:                     }
                   16841:                     $showcourses{$cid} = $courses{$cid};
                   16842:                 }
                   16843:             }
                   16844:         }
                   16845:         %courses = %showcourses;
                   16846:     }
                   16847:     return %courses;
                   16848: }
                   16849: 
                   16850: =pod
                   16851: 
                   16852: =back
                   16853: 
1.1075.2.88  raeburn  16854: =head1 Routines for version requirements for current course.
                   16855: 
                   16856: =over 4
                   16857: 
                   16858: =item * &check_release_required()
                   16859: 
                   16860: Compares required LON-CAPA version with version on server, and
                   16861: if required version is newer looks for a server with the required version.
                   16862: 
                   16863: Looks first at servers in user's owen domain; if none suitable, looks at
                   16864: servers in course's domain are permitted to host sessions for user's domain.
                   16865: 
                   16866: Inputs:
                   16867: 
                   16868: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16869: 
                   16870: $courseid - Course ID of current course
                   16871: 
                   16872: $rolecode - User's current role in course (for switchserver query string).
                   16873: 
                   16874: $required - LON-CAPA version needed by course (format: Major.Minor).
                   16875: 
                   16876: 
                   16877: Returns:
                   16878: 
                   16879: $switchserver - query string tp append to /adm/switchserver call (if
                   16880:                 current server's LON-CAPA version is too old.
                   16881: 
                   16882: $warning - Message is displayed if no suitable server could be found.
                   16883: 
                   16884: =cut
                   16885: 
                   16886: sub check_release_required {
                   16887:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   16888:     my ($switchserver,$warning);
                   16889:     if ($required ne '') {
                   16890:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   16891:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16892:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   16893:             my $otherserver;
                   16894:             if (($major eq '' && $minor eq '') ||
                   16895:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   16896:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   16897:                 my $switchlcrev =
                   16898:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   16899:                                                            $userdomserver);
                   16900:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16901:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   16902:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   16903:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   16904:                     if ($cdom ne $env{'user.domain'}) {
                   16905:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   16906:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   16907:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   16908:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   16909:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   16910:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   16911:                         my $canhost =
                   16912:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   16913:                                                               $coursedomserver,
                   16914:                                                               $remoterev,
                   16915:                                                               $udomdefaults{'remotesessions'},
                   16916:                                                               $defdomdefaults{'hostedsessions'});
                   16917: 
                   16918:                         if ($canhost) {
                   16919:                             $otherserver = $coursedomserver;
                   16920:                         } else {
                   16921:                             $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.");
                   16922:                         }
                   16923:                     } else {
                   16924:                         $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).");
                   16925:                     }
                   16926:                 } else {
                   16927:                     $otherserver = $userdomserver;
                   16928:                 }
                   16929:             }
                   16930:             if ($otherserver ne '') {
                   16931:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   16932:             }
                   16933:         }
                   16934:     }
                   16935:     return ($switchserver,$warning);
                   16936: }
                   16937: 
                   16938: =pod
                   16939: 
                   16940: =item * &check_release_result()
                   16941: 
                   16942: Inputs:
                   16943: 
                   16944: $switchwarning - Warning message if no suitable server found to host session.
                   16945: 
                   16946: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16947:                 and current role.
                   16948: 
                   16949: Returns: HTML to display with information about requirement to switch server.
                   16950:          Either displaying warning with link to Roles/Courses screen or
                   16951:          display link to switchserver.
                   16952: 
1.1075.2.69  raeburn  16953: =cut
                   16954: 
1.1075.2.88  raeburn  16955: sub check_release_result {
                   16956:     my ($switchwarning,$switchserver) = @_;
                   16957:     my $output = &start_page('Selected course unavailable on this server').
                   16958:                  '<p class="LC_warning">';
                   16959:     if ($switchwarning) {
                   16960:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   16961:         if (&show_course()) {
                   16962:             $output .= &mt('Display courses');
                   16963:         } else {
                   16964:             $output .= &mt('Display roles');
                   16965:         }
                   16966:         $output .= '</a>';
                   16967:     } elsif ($switchserver) {
                   16968:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   16969:                    '<br />'.
                   16970:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   16971:                    &mt('Switch Server').
                   16972:                    '</a>';
                   16973:     }
                   16974:     $output .= '</p>'.&end_page();
                   16975:     return $output;
                   16976: }
                   16977: 
                   16978: =pod
                   16979: 
                   16980: =item * &needs_coursereinit()
                   16981: 
                   16982: Determine if course contents stored for user's session needs to be
                   16983: refreshed, because content has changed since "Big Hash" last tied.
                   16984: 
                   16985: Check for change is made if time last checked is more than 10 minutes ago
                   16986: (by default).
                   16987: 
                   16988: Inputs:
                   16989: 
                   16990: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16991: 
                   16992: $interval (optional) - Time which may elapse (in s) between last check for content
                   16993:                        change in current course. (default: 600 s).
                   16994: 
                   16995: Returns: an array; first element is:
                   16996: 
                   16997: =over 4
                   16998: 
                   16999: 'switch' - if content updates mean user's session
                   17000:            needs to be switched to a server running a newer LON-CAPA version
                   17001: 
                   17002: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   17003:            on current server hosting user's session
                   17004: 
                   17005: ''       - if no action required.
                   17006: 
                   17007: =back
                   17008: 
                   17009: If first item element is 'switch':
                   17010: 
                   17011: second item is $switchwarning - Warning message if no suitable server found to host session.
                   17012: 
                   17013: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   17014:                               and current role.
                   17015: 
                   17016: otherwise: no other elements returned.
                   17017: 
                   17018: =back
                   17019: 
                   17020: =cut
                   17021: 
                   17022: sub needs_coursereinit {
                   17023:     my ($loncaparev,$interval) = @_;
                   17024:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   17025:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   17026:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   17027:     my $now = time;
                   17028:     if ($interval eq '') {
                   17029:         $interval = 600;
                   17030:     }
                   17031:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   17032:         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   17033:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
                   17034:         if ($lastchange > $env{'request.course.tied'}) {
                   17035:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17036:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   17037:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   17038:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   17039:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   17040:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   17041:                     my ($switchserver,$switchwarning) =
                   17042:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   17043:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   17044:                     if ($switchwarning ne '' || $switchserver ne '') {
                   17045:                         return ('switch',$switchwarning,$switchserver);
                   17046:                     }
                   17047:                 }
                   17048:             }
                   17049:             return ('update');
                   17050:         }
                   17051:     }
                   17052:     return ();
                   17053: }
1.1075.2.69  raeburn  17054: 
1.1075.2.11  raeburn  17055: sub update_content_constraints {
                   17056:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17057:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17058:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   17059:     my %checkresponsetypes;
                   17060:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   17061:         my ($item,$name,$value) = split(/:/,$key);
                   17062:         if ($item eq 'resourcetag') {
                   17063:             if ($name eq 'responsetype') {
                   17064:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   17065:             }
                   17066:         }
                   17067:     }
                   17068:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17069:     if (defined($navmap)) {
                   17070:         my %allresponses;
                   17071:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   17072:             my %responses = $res->responseTypes();
                   17073:             foreach my $key (keys(%responses)) {
                   17074:                 next unless(exists($checkresponsetypes{$key}));
                   17075:                 $allresponses{$key} += $responses{$key};
                   17076:             }
                   17077:         }
                   17078:         foreach my $key (keys(%allresponses)) {
                   17079:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   17080:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   17081:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   17082:             }
                   17083:         }
                   17084:         undef($navmap);
                   17085:     }
                   17086:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   17087:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   17088:     }
                   17089:     return;
                   17090: }
                   17091: 
1.1075.2.27  raeburn  17092: sub allmaps_incourse {
                   17093:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17094:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   17095:         $cid = $env{'request.course.id'};
                   17096:         $cdom = $env{'course.'.$cid.'.domain'};
                   17097:         $cnum = $env{'course.'.$cid.'.num'};
                   17098:         $chome = $env{'course.'.$cid.'.home'};
                   17099:     }
                   17100:     my %allmaps = ();
                   17101:     my $lastchange =
                   17102:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   17103:     if ($lastchange > $env{'request.course.tied'}) {
                   17104:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   17105:         unless ($ferr) {
                   17106:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   17107:         }
                   17108:     }
                   17109:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17110:     if (defined($navmap)) {
                   17111:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   17112:             $allmaps{$res->src()} = 1;
                   17113:         }
                   17114:     }
                   17115:     return \%allmaps;
                   17116: }
                   17117: 
1.1075.2.11  raeburn  17118: sub parse_supplemental_title {
                   17119:     my ($title) = @_;
                   17120: 
                   17121:     my ($foldertitle,$renametitle);
                   17122:     if ($title =~ /&amp;&amp;&amp;/) {
                   17123:         $title = &HTML::Entites::decode($title);
                   17124:     }
                   17125:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   17126:         $renametitle=$4;
                   17127:         my ($time,$uname,$udom) = ($1,$2,$3);
                   17128:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   17129:         my $name =  &plainname($uname,$udom);
                   17130:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   17131:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   17132:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   17133:             $name.': <br />'.$foldertitle;
                   17134:     }
                   17135:     if (wantarray) {
                   17136:         return ($title,$foldertitle,$renametitle);
                   17137:     }
                   17138:     return $title;
                   17139: }
                   17140: 
1.1075.2.43  raeburn  17141: sub recurse_supplemental {
                   17142:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   17143:     if ($suppmap) {
                   17144:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   17145:         if ($fatal) {
                   17146:             $errors ++;
                   17147:         } else {
1.1075.2.167  raeburn  17148:             my @order = @LONCAPA::map::order;
                   17149:             if (@order > 0) {
                   17150:                 my @resources = @LONCAPA::map::resources;
                   17151:                 my @resparms = @LONCAPA::map::resparms;
                   17152:                 foreach my $idx (@order) {
                   17153:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1075.2.43  raeburn  17154:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  17155:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   17156:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  17157:                         } else {
                   17158:                             $numfiles ++;
                   17159:                         }
                   17160:                     }
                   17161:                 }
                   17162:             }
                   17163:         }
                   17164:     }
                   17165:     return ($numfiles,$errors);
                   17166: }
                   17167: 
1.1075.2.18  raeburn  17168: sub symb_to_docspath {
1.1075.2.119  raeburn  17169:     my ($symb,$navmapref) = @_;
                   17170:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  17171:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   17172:     if ($resurl=~/\.(sequence|page)$/) {
                   17173:         $mapurl=$resurl;
                   17174:     } elsif ($resurl eq 'adm/navmaps') {
                   17175:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   17176:     }
                   17177:     my $mapresobj;
1.1075.2.119  raeburn  17178:     unless (ref($$navmapref)) {
                   17179:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   17180:     }
                   17181:     if (ref($$navmapref)) {
                   17182:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  17183:     }
                   17184:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   17185:     my $type=$2;
                   17186:     my $path;
                   17187:     if (ref($mapresobj)) {
                   17188:         my $pcslist = $mapresobj->map_hierarchy();
                   17189:         if ($pcslist ne '') {
                   17190:             foreach my $pc (split(/,/,$pcslist)) {
                   17191:                 next if ($pc <= 1);
1.1075.2.119  raeburn  17192:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  17193:                 if (ref($res)) {
                   17194:                     my $thisurl = $res->src();
                   17195:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   17196:                     my $thistitle = $res->title();
                   17197:                     $path .= '&'.
                   17198:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  17199:                              &escape($thistitle).
1.1075.2.18  raeburn  17200:                              ':'.$res->randompick().
                   17201:                              ':'.$res->randomout().
                   17202:                              ':'.$res->encrypted().
                   17203:                              ':'.$res->randomorder().
                   17204:                              ':'.$res->is_page();
                   17205:                 }
                   17206:             }
                   17207:         }
                   17208:         $path =~ s/^\&//;
                   17209:         my $maptitle = $mapresobj->title();
                   17210:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17211:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17212:         }
                   17213:         $path .= (($path ne '')? '&' : '').
                   17214:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17215:                  &escape($maptitle).
1.1075.2.18  raeburn  17216:                  ':'.$mapresobj->randompick().
                   17217:                  ':'.$mapresobj->randomout().
                   17218:                  ':'.$mapresobj->encrypted().
                   17219:                  ':'.$mapresobj->randomorder().
                   17220:                  ':'.$mapresobj->is_page();
                   17221:     } else {
                   17222:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   17223:         my $ispage = (($type eq 'page')? 1 : '');
                   17224:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17225:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17226:         }
                   17227:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17228:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  17229:     }
                   17230:     unless ($mapurl eq 'default') {
                   17231:         $path = 'default&'.
1.1075.2.46  raeburn  17232:                 &escape('Main Content').
1.1075.2.18  raeburn  17233:                 ':::::&'.$path;
                   17234:     }
                   17235:     return $path;
                   17236: }
                   17237: 
1.1075.2.14  raeburn  17238: sub captcha_display {
1.1075.2.137  raeburn  17239:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17240:     my ($output,$error);
1.1075.2.107  raeburn  17241:     my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137  raeburn  17242:         &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17243:     if ($captcha eq 'original') {
                   17244:         $output = &create_captcha();
                   17245:         unless ($output) {
                   17246:             $error = 'captcha';
                   17247:         }
                   17248:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17249:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  17250:         unless ($output) {
                   17251:             $error = 'recaptcha';
                   17252:         }
                   17253:     }
1.1075.2.107  raeburn  17254:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  17255: }
                   17256: 
                   17257: sub captcha_response {
1.1075.2.137  raeburn  17258:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17259:     my ($captcha_chk,$captcha_error);
1.1075.2.137  raeburn  17260:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17261:     if ($captcha eq 'original') {
                   17262:         ($captcha_chk,$captcha_error) = &check_captcha();
                   17263:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17264:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  17265:     } else {
                   17266:         $captcha_chk = 1;
                   17267:     }
                   17268:     return ($captcha_chk,$captcha_error);
                   17269: }
                   17270: 
                   17271: sub get_captcha_config {
1.1075.2.137  raeburn  17272:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107  raeburn  17273:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  17274:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   17275:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   17276:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17277:     if ($context eq 'usercreation') {
                   17278:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   17279:         if (ref($domconfig{$context}) eq 'HASH') {
                   17280:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   17281:             if (ref($hashtocheck) eq 'HASH') {
                   17282:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   17283:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   17284:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   17285:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   17286:                     }
                   17287:                     if ($privkey && $pubkey) {
                   17288:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  17289:                         $version = $hashtocheck->{'recaptchaversion'};
                   17290:                         if ($version ne '2') {
                   17291:                             $version = 1;
                   17292:                         }
1.1075.2.14  raeburn  17293:                     } else {
                   17294:                         $captcha = 'original';
                   17295:                     }
                   17296:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   17297:                     $captcha = 'original';
                   17298:                 }
                   17299:             }
                   17300:         } else {
                   17301:             $captcha = 'captcha';
                   17302:         }
                   17303:     } elsif ($context eq 'login') {
                   17304:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   17305:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   17306:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   17307:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   17308:             if ($privkey && $pubkey) {
                   17309:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  17310:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   17311:                 if ($version ne '2') {
                   17312:                     $version = 1;
                   17313:                 }
1.1075.2.14  raeburn  17314:             } else {
                   17315:                 $captcha = 'original';
                   17316:             }
                   17317:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   17318:             $captcha = 'original';
                   17319:         }
1.1075.2.137  raeburn  17320:     } elsif ($context eq 'passwords') {
                   17321:         if ($dom_in_effect) {
                   17322:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   17323:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   17324:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   17325:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   17326:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   17327:                 }
                   17328:                 if ($privkey && $pubkey) {
                   17329:                     $captcha = 'recaptcha';
                   17330:                     $version = $passwdconf{'recaptchaversion'};
                   17331:                     if ($version ne '2') {
                   17332:                         $version = 1;
                   17333:                     }
                   17334:                 } else {
                   17335:                     $captcha = 'original';
                   17336:                 }
                   17337:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   17338:                 $captcha = 'original';
                   17339:             }
                   17340:         }
1.1075.2.14  raeburn  17341:     }
1.1075.2.107  raeburn  17342:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  17343: }
                   17344: 
                   17345: sub create_captcha {
                   17346:     my %captcha_params = &captcha_settings();
                   17347:     my ($output,$maxtries,$tries) = ('',10,0);
                   17348:     while ($tries < $maxtries) {
                   17349:         $tries ++;
                   17350:         my $captcha = Authen::Captcha->new (
                   17351:                                            output_folder => $captcha_params{'output_dir'},
                   17352:                                            data_folder   => $captcha_params{'db_dir'},
                   17353:                                           );
                   17354:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   17355: 
                   17356:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   17357:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1075.2.158  raeburn  17358:                       '<span class="LC_nobreak">'.
1.1075.2.14  raeburn  17359:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.167  raeburn  17360:                       '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1075.2.158  raeburn  17361:                       '</span><br />'.
1.1075.2.66  raeburn  17362:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  17363:             last;
                   17364:         }
                   17365:     }
1.1075.2.158  raeburn  17366:     if ($output eq '') {
                   17367:         &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
                   17368:     }
1.1075.2.14  raeburn  17369:     return $output;
                   17370: }
                   17371: 
                   17372: sub captcha_settings {
                   17373:     my %captcha_params = (
                   17374:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   17375:                            www_output_dir => "/captchaspool",
                   17376:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   17377:                            numchars       => '5',
                   17378:                          );
                   17379:     return %captcha_params;
                   17380: }
                   17381: 
                   17382: sub check_captcha {
                   17383:     my ($captcha_chk,$captcha_error);
                   17384:     my $code = $env{'form.code'};
                   17385:     my $md5sum = $env{'form.crypt'};
                   17386:     my %captcha_params = &captcha_settings();
                   17387:     my $captcha = Authen::Captcha->new(
                   17388:                       output_folder => $captcha_params{'output_dir'},
                   17389:                       data_folder   => $captcha_params{'db_dir'},
                   17390:                   );
1.1075.2.26  raeburn  17391:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  17392:     my %captcha_hash = (
                   17393:                         0       => 'Code not checked (file error)',
                   17394:                        -1      => 'Failed: code expired',
                   17395:                        -2      => 'Failed: invalid code (not in database)',
                   17396:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   17397:     );
                   17398:     if ($captcha_chk != 1) {
                   17399:         $captcha_error = $captcha_hash{$captcha_chk}
                   17400:     }
                   17401:     return ($captcha_chk,$captcha_error);
                   17402: }
                   17403: 
                   17404: sub create_recaptcha {
1.1075.2.107  raeburn  17405:     my ($pubkey,$version) = @_;
                   17406:     if ($version >= 2) {
1.1075.2.158  raeburn  17407:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
                   17408:                '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1075.2.107  raeburn  17409:     } else {
                   17410:         my $use_ssl;
                   17411:         if ($ENV{'SERVER_PORT'} == 443) {
                   17412:             $use_ssl = 1;
                   17413:         }
                   17414:         my $captcha = Captcha::reCAPTCHA->new;
                   17415:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   17416:                $captcha->get_html($pubkey,undef,$use_ssl).
                   17417:                &mt('If the text is hard to read, [_1] will replace them.',
                   17418:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   17419:                '<br /><br />';
                   17420:      }
1.1075.2.14  raeburn  17421: }
                   17422: 
                   17423: sub check_recaptcha {
1.1075.2.107  raeburn  17424:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  17425:     my $captcha_chk;
1.1075.2.150  raeburn  17426:     my $ip = &Apache::lonnet::get_requestor_ip(); 
1.1075.2.107  raeburn  17427:     if ($version >= 2) {
                   17428:         my $ua = LWP::UserAgent->new;
                   17429:         $ua->timeout(10);
                   17430:         my %info = (
                   17431:                      secret   => $privkey,
                   17432:                      response => $env{'form.g-recaptcha-response'},
1.1075.2.150  raeburn  17433:                      remoteip => $ip,
1.1075.2.107  raeburn  17434:                    );
                   17435:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   17436:         if ($response->is_success)  {
                   17437:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   17438:             if (ref($data) eq 'HASH') {
                   17439:                 if ($data->{'success'}) {
                   17440:                     $captcha_chk = 1;
                   17441:                 }
                   17442:             }
                   17443:         }
                   17444:     } else {
                   17445:         my $captcha = Captcha::reCAPTCHA->new;
                   17446:         my $captcha_result =
                   17447:             $captcha->check_answer(
                   17448:                                     $privkey,
1.1075.2.150  raeburn  17449:                                     $ip,
1.1075.2.107  raeburn  17450:                                     $env{'form.recaptcha_challenge_field'},
                   17451:                                     $env{'form.recaptcha_response_field'},
                   17452:                                   );
                   17453:         if ($captcha_result->{is_valid}) {
                   17454:             $captcha_chk = 1;
                   17455:         }
1.1075.2.14  raeburn  17456:     }
                   17457:     return $captcha_chk;
                   17458: }
                   17459: 
1.1075.2.64  raeburn  17460: sub emailusername_info {
1.1075.2.103  raeburn  17461:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  17462:     my %titles = &Apache::lonlocal::texthash (
                   17463:                      lastname      => 'Last Name',
                   17464:                      firstname     => 'First Name',
                   17465:                      institution   => 'School/college/university',
                   17466:                      location      => "School's city, state/province, country",
                   17467:                      web           => "School's web address",
                   17468:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  17469:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  17470:                  );
                   17471:     return (\@fields,\%titles);
                   17472: }
                   17473: 
1.1075.2.56  raeburn  17474: sub cleanup_html {
                   17475:     my ($incoming) = @_;
                   17476:     my $outgoing;
                   17477:     if ($incoming ne '') {
                   17478:         $outgoing = $incoming;
                   17479:         $outgoing =~ s/;/&#059;/g;
                   17480:         $outgoing =~ s/\#/&#035;/g;
                   17481:         $outgoing =~ s/\&/&#038;/g;
                   17482:         $outgoing =~ s/</&#060;/g;
                   17483:         $outgoing =~ s/>/&#062;/g;
                   17484:         $outgoing =~ s/\(/&#040/g;
                   17485:         $outgoing =~ s/\)/&#041;/g;
                   17486:         $outgoing =~ s/"/&#034;/g;
                   17487:         $outgoing =~ s/'/&#039;/g;
                   17488:         $outgoing =~ s/\$/&#036;/g;
                   17489:         $outgoing =~ s{/}{&#047;}g;
                   17490:         $outgoing =~ s/=/&#061;/g;
                   17491:         $outgoing =~ s/\\/&#092;/g
                   17492:     }
                   17493:     return $outgoing;
                   17494: }
                   17495: 
1.1075.2.74  raeburn  17496: # Checks for critical messages and returns a redirect url if one exists.
                   17497: # $interval indicates how often to check for messages.
                   17498: sub critical_redirect {
                   17499:     my ($interval) = @_;
1.1075.2.158  raeburn  17500:     unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   17501:         return ();
                   17502:     }
1.1075.2.74  raeburn  17503:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
                   17504:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   17505:                                         $env{'user.name'});
                   17506:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   17507:         my $redirecturl;
                   17508:         if ($what[0]) {
1.1075.2.158  raeburn  17509:             if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1075.2.74  raeburn  17510:                 $redirecturl='/adm/email?critical=display';
                   17511:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   17512:                 return (1, $url);
                   17513:             }
                   17514:         }
                   17515:     }
                   17516:     return ();
                   17517: }
                   17518: 
1.1075.2.64  raeburn  17519: # Use:
                   17520: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   17521: #
                   17522: ##################################################
                   17523: #          password associated functions         #
                   17524: ##################################################
                   17525: sub des_keys {
                   17526:     # Make a new key for DES encryption.
                   17527:     # Each key has two parts which are returned separately.
                   17528:     # Please note:  Each key must be passed through the &hex function
                   17529:     # before it is output to the web browser.  The hex versions cannot
                   17530:     # be used to decrypt.
                   17531:     my @hexstr=('0','1','2','3','4','5','6','7',
                   17532:                 '8','9','a','b','c','d','e','f');
                   17533:     my $lkey='';
                   17534:     for (0..7) {
                   17535:         $lkey.=$hexstr[rand(15)];
                   17536:     }
                   17537:     my $ukey='';
                   17538:     for (0..7) {
                   17539:         $ukey.=$hexstr[rand(15)];
                   17540:     }
                   17541:     return ($lkey,$ukey);
                   17542: }
                   17543: 
                   17544: sub des_decrypt {
                   17545:     my ($key,$cyphertext) = @_;
                   17546:     my $keybin=pack("H16",$key);
                   17547:     my $cypher;
                   17548:     if ($Crypt::DES::VERSION>=2.03) {
                   17549:         $cypher=new Crypt::DES $keybin;
                   17550:     } else {
                   17551:         $cypher=new DES $keybin;
                   17552:     }
1.1075.2.106  raeburn  17553:     my $plaintext='';
                   17554:     my $cypherlength = length($cyphertext);
                   17555:     my $numchunks = int($cypherlength/32);
                   17556:     for (my $j=0; $j<$numchunks; $j++) {
                   17557:         my $start = $j*32;
                   17558:         my $cypherblock = substr($cyphertext,$start,32);
                   17559:         my $chunk =
                   17560:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   17561:         $chunk .=
                   17562:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   17563:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   17564:         $plaintext .= $chunk;
                   17565:     }
1.1075.2.64  raeburn  17566:     return $plaintext;
                   17567: }
                   17568: 
1.1075.2.135  raeburn  17569: sub is_nonframeable {
                   17570:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   17571:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
                   17572:     return if (($remprotocol eq '') || ($remhost eq ''));
                   17573: 
                   17574:     $remprotocol = lc($remprotocol);
                   17575:     $remhost = lc($remhost);
                   17576:     my $remport = 80;
                   17577:     if ($remprotocol eq 'https') {
                   17578:         $remport = 443;
                   17579:     }
                   17580:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
                   17581:     if ($cached) {
                   17582:         unless ($nocache) {
                   17583:             if ($result) {
                   17584:                 return 1;
                   17585:             } else {
                   17586:                 return 0;
                   17587:             }
                   17588:         }
                   17589:     }
                   17590:     my $uselink;
                   17591:     my $request = new HTTP::Request('HEAD',$url);
1.1075.2.142  raeburn  17592:     my $ua = LWP::UserAgent->new;
                   17593:     $ua->timeout(5);
                   17594:     my $response=$ua->request($request);
1.1075.2.135  raeburn  17595:     if ($response->is_success()) {
                   17596:         my $secpolicy = lc($response->header('content-security-policy'));
                   17597:         my $xframeop = lc($response->header('x-frame-options'));
                   17598:         $secpolicy =~ s/^\s+|\s+$//g;
                   17599:         $xframeop =~ s/^\s+|\s+$//g;
                   17600:         if (($secpolicy ne '') || ($xframeop ne '')) {
                   17601:             my $remotehost = $remprotocol.'://'.$remhost;
                   17602:             my ($origin,$protocol,$port);
                   17603:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   17604:                 $port = $ENV{'SERVER_PORT'};
                   17605:             } else {
                   17606:                 $port = 80;
                   17607:             }
                   17608:             if ($absolute eq '') {
                   17609:                 $protocol = 'http:';
                   17610:                 if ($port == 443) {
                   17611:                     $protocol = 'https:';
                   17612:                 }
                   17613:                 $origin = $protocol.'//'.lc($hostname);
                   17614:             } else {
                   17615:                 $origin = lc($absolute);
                   17616:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   17617:             }
                   17618:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   17619:                 my $framepolicy = $1;
                   17620:                 $framepolicy =~ s/^\s+|\s+$//g;
                   17621:                 my @policies = split(/\s+/,$framepolicy);
                   17622:                 if (@policies) {
                   17623:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   17624:                         $uselink = 1;
                   17625:                     } else {
                   17626:                         $uselink = 1;
                   17627:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   17628:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   17629:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   17630:                             undef($uselink);
                   17631:                         }
                   17632:                         if ($uselink) {
                   17633:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   17634:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   17635:                                     undef($uselink);
                   17636:                                 }
                   17637:                             }
                   17638:                         }
                   17639:                         if ($uselink) {
                   17640:                             my @possok;
                   17641:                             if ($ip ne '') {
                   17642:                                 push(@possok,$ip);
                   17643:                             }
                   17644:                             my $hoststr = '';
                   17645:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   17646:                                 if ($hoststr eq '') {
                   17647:                                     $hoststr = $part;
                   17648:                                 } else {
                   17649:                                     $hoststr = "$part.$hoststr";
                   17650:                                 }
                   17651:                                 if ($hoststr eq $hostname) {
                   17652:                                     push(@possok,$hostname);
                   17653:                                 } else {
                   17654:                                     push(@possok,"*.$hoststr");
                   17655:                                 }
                   17656:                             }
                   17657:                             if (@possok) {
                   17658:                                 foreach my $poss (@possok) {
                   17659:                                     last if (!$uselink);
                   17660:                                     foreach my $policy (@policies) {
                   17661:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   17662:                                             undef($uselink);
                   17663:                                             last;
                   17664:                                         }
                   17665:                                     }
                   17666:                                 }
                   17667:                             }
                   17668:                         }
                   17669:                     }
                   17670:                 }
                   17671:             } elsif ($xframeop ne '') {
                   17672:                 $uselink = 1;
                   17673:                 my @policies = split(/\s*,\s*/,$xframeop);
                   17674:                 if (@policies) {
                   17675:                     unless (grep(/^deny$/,@policies)) {
                   17676:                         if ($origin ne '') {
                   17677:                             if (grep(/^sameorigin$/,@policies)) {
                   17678:                                 if ($remotehost eq $origin) {
                   17679:                                     undef($uselink);
                   17680:                                 }
                   17681:                             }
                   17682:                             if ($uselink) {
                   17683:                                 foreach my $policy (@policies) {
                   17684:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   17685:                                         my $allowfrom = $1;
                   17686:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   17687:                                             undef($uselink);
                   17688:                                             last;
                   17689:                                         }
                   17690:                                     }
                   17691:                                 }
                   17692:                             }
                   17693:                         }
                   17694:                     }
                   17695:                 }
                   17696:             }
                   17697:         }
                   17698:     }
                   17699:     if ($nocache) {
                   17700:         if ($cached) {
                   17701:             my $devalidate;
                   17702:             if ($uselink && !$result) {
                   17703:                 $devalidate = 1;
                   17704:             } elsif (!$uselink && $result) {
                   17705:                 $devalidate = 1;
                   17706:             }
                   17707:             if ($devalidate) {
                   17708:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   17709:             }
                   17710:         }
                   17711:     } else {
                   17712:         if ($uselink) {
                   17713:             $result = 1;
                   17714:         } else {
                   17715:             $result = 0;
                   17716:         }
                   17717:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   17718:     }
                   17719:     return $uselink;
                   17720: }
                   17721: 
1.112     bowersj2 17722: 1;
                   17723: __END__;
1.41      ng       17724: 

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