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

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.167! raeburn     4: # $Id: loncommon.pm,v 1.1075.2.166 2024/07/02 21:15:18 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.13  raeburn  5926:     if ($env{'request.state'} eq 'construct') {
                   5927:         if (!$public){
                   5928:             if ($env{'request.state'} eq 'construct') {
                   5929:                 $funclist = &Apache::lonhtmlcommon::scripttag(
1.1075.2.52  raeburn  5930:                                 &Apache::lonmenu::utilityfunctions($httphost), 'start').
1.1075.2.13  raeburn  5931:                             &Apache::lonhtmlcommon::scripttag('','end').
                   5932:                             &Apache::lonmenu::innerregister($forcereg,
                   5933:                                                             $args->{'bread_crumbs'});
                   5934:             }
                   5935:         }
                   5936:     }
1.1075.2.21  raeburn  5937:     return $bodytag."\n".$funclist;
1.182     matthew  5938: }
                   5939: 
1.917     raeburn  5940: sub dc_courseid_toggle {
                   5941:     my ($dc_info) = @_;
1.980     raeburn  5942:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  5943:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  5944:            &mt('(More ...)').'</a></span>'.
                   5945:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   5946: }
                   5947: 
1.330     albertel 5948: sub make_attr_string {
                   5949:     my ($register,$attr_ref) = @_;
                   5950: 
                   5951:     if ($attr_ref && !ref($attr_ref)) {
                   5952: 	die("addentries Must be a hash ref ".
                   5953: 	    join(':',caller(1))." ".
                   5954: 	    join(':',caller(0))." ");
                   5955:     }
                   5956: 
                   5957:     if ($register) {
1.339     albertel 5958: 	my ($on_load,$on_unload);
                   5959: 	foreach my $key (keys(%{$attr_ref})) {
                   5960: 	    if      (lc($key) eq 'onload') {
                   5961: 		$on_load.=$attr_ref->{$key}.';';
                   5962: 		delete($attr_ref->{$key});
                   5963: 
                   5964: 	    } elsif (lc($key) eq 'onunload') {
                   5965: 		$on_unload.=$attr_ref->{$key}.';';
                   5966: 		delete($attr_ref->{$key});
                   5967: 	    }
                   5968: 	}
1.1075.2.12  raeburn  5969:         if ($env{'environment.remote'} eq 'on') {
                   5970:             $attr_ref->{'onload'}  =
                   5971:                 &Apache::lonmenu::loadevents().  $on_load;
                   5972:             $attr_ref->{'onunload'}=
                   5973:                 &Apache::lonmenu::unloadevents().$on_unload;
                   5974:         } else {  
                   5975: 	    $attr_ref->{'onload'}  = $on_load;
                   5976: 	    $attr_ref->{'onunload'}= $on_unload;
                   5977:         }
1.330     albertel 5978:     }
1.339     albertel 5979: 
1.330     albertel 5980:     my $attr_string;
1.1075.2.56  raeburn  5981:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 5982: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   5983:     }
                   5984:     return $attr_string;
                   5985: }
                   5986: 
                   5987: 
1.182     matthew  5988: ###############################################
1.251     albertel 5989: ###############################################
                   5990: 
                   5991: =pod
                   5992: 
                   5993: =item * &endbodytag()
                   5994: 
                   5995: Returns a uniform footer for LON-CAPA web pages.
                   5996: 
1.635     raeburn  5997: Inputs: 1 - optional reference to an args hash
                   5998: If in the hash, key for noredirectlink has a value which evaluates to true,
                   5999: a 'Continue' link is not displayed if the page contains an
                   6000: internal redirect in the <head></head> section,
                   6001: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 6002: 
                   6003: =cut
                   6004: 
                   6005: sub endbodytag {
1.635     raeburn  6006:     my ($args) = @_;
1.1075.2.6  raeburn  6007:     my $endbodytag;
                   6008:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   6009:         $endbodytag='</body>';
                   6010:     }
1.315     albertel 6011:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  6012:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   6013: 	    $endbodytag=
                   6014: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   6015: 	        &mt('Continue').'</a>'.
                   6016: 	        $endbodytag;
                   6017:         }
1.315     albertel 6018:     }
1.1075.2.165  raeburn  6019:     if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
                   6020:         $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
                   6021:     }
1.251     albertel 6022:     return $endbodytag;
                   6023: }
                   6024: 
1.352     albertel 6025: =pod
                   6026: 
                   6027: =item * &standard_css()
                   6028: 
                   6029: Returns a style sheet
                   6030: 
                   6031: Inputs: (all optional)
                   6032:             domain         -> force to color decorate a page for a specific
                   6033:                                domain
                   6034:             function       -> force usage of a specific rolish color scheme
                   6035:             bgcolor        -> override the default page bgcolor
                   6036: 
                   6037: =cut
                   6038: 
1.343     albertel 6039: sub standard_css {
1.345     albertel 6040:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 6041:     $function  = &get_users_function() if (!$function);
                   6042:     my $img    = &designparm($function.'.img',   $domain);
                   6043:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   6044:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 6045:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 6046: #second colour for later usage
1.345     albertel 6047:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 6048:     my $pgbg_or_bgcolor =
                   6049: 	         $bgcolor ||
1.352     albertel 6050: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 6051:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 6052:     my $alink  = &designparm($function.'.alink', $domain);
                   6053:     my $vlink  = &designparm($function.'.vlink', $domain);
                   6054:     my $link   = &designparm($function.'.link',  $domain);
                   6055: 
1.602     albertel 6056:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 6057:     my $mono                 = 'monospace';
1.850     bisitz   6058:     my $data_table_head      = $sidebg;
                   6059:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   6060:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 6061:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 6062:     my $data_table_highlight = '#FFFF00';
1.352     albertel 6063:     my $mail_new             = '#FFBB77';
                   6064:     my $mail_new_hover       = '#DD9955';
                   6065:     my $mail_read            = '#BBBB77';
                   6066:     my $mail_read_hover      = '#999944';
                   6067:     my $mail_replied         = '#AAAA88';
                   6068:     my $mail_replied_hover   = '#888855';
                   6069:     my $mail_other           = '#99BBBB';
                   6070:     my $mail_other_hover     = '#669999';
1.391     albertel 6071:     my $table_header         = '#DDDDDD';
1.489     raeburn  6072:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   6073:     my $lg_border_color      = '#C8C8C8';
1.952     onken    6074:     my $button_hover         = '#BF2317';
1.392     albertel 6075: 
1.608     albertel 6076:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   6077:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   6078:                                              : '0 3px 0 4px';
1.448     albertel 6079: 
1.523     albertel 6080: 
1.343     albertel 6081:     return <<END;
1.947     droeschl 6082: 
                   6083: /* needed for iframe to allow 100% height in FF */
                   6084: body, html { 
                   6085:     margin: 0;
                   6086:     padding: 0 0.5%;
                   6087:     height: 99%; /* to avoid scrollbars */
                   6088: }
                   6089: 
1.795     www      6090: body {
1.911     bisitz   6091:   font-family: $sans;
                   6092:   line-height:130%;
                   6093:   font-size:0.83em;
                   6094:   color:$font;
1.795     www      6095: }
                   6096: 
1.959     onken    6097: a:focus,
                   6098: a:focus img {
1.795     www      6099:   color: red;
                   6100: }
1.698     harmsja  6101: 
1.911     bisitz   6102: form, .inline {
                   6103:   display: inline;
1.795     www      6104: }
1.721     harmsja  6105: 
1.795     www      6106: .LC_right {
1.911     bisitz   6107:   text-align:right;
1.795     www      6108: }
                   6109: 
                   6110: .LC_middle {
1.911     bisitz   6111:   vertical-align:middle;
1.795     www      6112: }
1.721     harmsja  6113: 
1.1075.2.38  raeburn  6114: .LC_floatleft {
                   6115:   float: left;
                   6116: }
                   6117: 
                   6118: .LC_floatright {
                   6119:   float: right;
                   6120: }
                   6121: 
1.911     bisitz   6122: .LC_400Box {
                   6123:   width:400px;
                   6124: }
1.721     harmsja  6125: 
1.947     droeschl 6126: .LC_iframecontainer {
                   6127:     width: 98%;
                   6128:     margin: 0;
                   6129:     position: fixed;
                   6130:     top: 8.5em;
                   6131:     bottom: 0;
                   6132: }
                   6133: 
                   6134: .LC_iframecontainer iframe{
                   6135:     border: none;
                   6136:     width: 100%;
                   6137:     height: 100%;
                   6138: }
                   6139: 
1.778     bisitz   6140: .LC_filename {
                   6141:   font-family: $mono;
                   6142:   white-space:pre;
1.921     bisitz   6143:   font-size: 120%;
1.778     bisitz   6144: }
                   6145: 
                   6146: .LC_fileicon {
                   6147:   border: none;
                   6148:   height: 1.3em;
                   6149:   vertical-align: text-bottom;
                   6150:   margin-right: 0.3em;
                   6151:   text-decoration:none;
                   6152: }
                   6153: 
1.1008    www      6154: .LC_setting {
                   6155:   text-decoration:underline;
                   6156: }
                   6157: 
1.350     albertel 6158: .LC_error {
                   6159:   color: red;
                   6160: }
1.795     www      6161: 
1.1075.2.15  raeburn  6162: .LC_warning {
                   6163:   color: darkorange;
                   6164: }
                   6165: 
1.457     albertel 6166: .LC_diff_removed {
1.733     bisitz   6167:   color: red;
1.394     albertel 6168: }
1.532     albertel 6169: 
                   6170: .LC_info,
1.457     albertel 6171: .LC_success,
                   6172: .LC_diff_added {
1.350     albertel 6173:   color: green;
                   6174: }
1.795     www      6175: 
1.802     bisitz   6176: div.LC_confirm_box {
                   6177:   background-color: #FAFAFA;
                   6178:   border: 1px solid $lg_border_color;
                   6179:   margin-right: 0;
                   6180:   padding: 5px;
                   6181: }
                   6182: 
                   6183: div.LC_confirm_box .LC_error img,
                   6184: div.LC_confirm_box .LC_success img {
                   6185:   vertical-align: middle;
                   6186: }
                   6187: 
1.1075.2.108  raeburn  6188: .LC_maxwidth {
                   6189:   max-width: 100%;
                   6190:   height: auto;
                   6191: }
                   6192: 
                   6193: .LC_textsize_mobile {
                   6194:   \@media only screen and (max-device-width: 480px) {
                   6195:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   6196:   }
                   6197: }
                   6198: 
1.440     albertel 6199: .LC_icon {
1.771     droeschl 6200:   border: none;
1.790     droeschl 6201:   vertical-align: middle;
1.771     droeschl 6202: }
                   6203: 
1.543     albertel 6204: .LC_docs_spacer {
                   6205:   width: 25px;
                   6206:   height: 1px;
1.771     droeschl 6207:   border: none;
1.543     albertel 6208: }
1.346     albertel 6209: 
1.532     albertel 6210: .LC_internal_info {
1.735     bisitz   6211:   color: #999999;
1.532     albertel 6212: }
                   6213: 
1.794     www      6214: .LC_discussion {
1.1050    www      6215:   background: $data_table_dark;
1.911     bisitz   6216:   border: 1px solid black;
                   6217:   margin: 2px;
1.794     www      6218: }
                   6219: 
                   6220: .LC_disc_action_left {
1.1050    www      6221:   background: $sidebg;
1.911     bisitz   6222:   text-align: left;
1.1050    www      6223:   padding: 4px;
                   6224:   margin: 2px;
1.794     www      6225: }
                   6226: 
                   6227: .LC_disc_action_right {
1.1050    www      6228:   background: $sidebg;
1.911     bisitz   6229:   text-align: right;
1.1050    www      6230:   padding: 4px;
                   6231:   margin: 2px;
1.794     www      6232: }
                   6233: 
                   6234: .LC_disc_new_item {
1.911     bisitz   6235:   background: white;
                   6236:   border: 2px solid red;
1.1050    www      6237:   margin: 4px;
                   6238:   padding: 4px;
1.794     www      6239: }
                   6240: 
                   6241: .LC_disc_old_item {
1.911     bisitz   6242:   background: white;
1.1050    www      6243:   margin: 4px;
                   6244:   padding: 4px;
1.794     www      6245: }
                   6246: 
1.458     albertel 6247: table.LC_pastsubmission {
                   6248:   border: 1px solid black;
                   6249:   margin: 2px;
                   6250: }
                   6251: 
1.924     bisitz   6252: table#LC_menubuttons {
1.345     albertel 6253:   width: 100%;
                   6254:   background: $pgbg;
1.392     albertel 6255:   border: 2px;
1.402     albertel 6256:   border-collapse: separate;
1.803     bisitz   6257:   padding: 0;
1.345     albertel 6258: }
1.392     albertel 6259: 
1.801     tempelho 6260: table#LC_title_bar a {
                   6261:   color: $fontmenu;
                   6262: }
1.836     bisitz   6263: 
1.807     droeschl 6264: table#LC_title_bar {
1.819     tempelho 6265:   clear: both;
1.836     bisitz   6266:   display: none;
1.807     droeschl 6267: }
                   6268: 
1.795     www      6269: table#LC_title_bar,
1.933     droeschl 6270: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 6271: table#LC_title_bar.LC_with_remote {
1.359     albertel 6272:   width: 100%;
1.392     albertel 6273:   border-color: $pgbg;
                   6274:   border-style: solid;
                   6275:   border-width: $border;
1.379     albertel 6276:   background: $pgbg;
1.801     tempelho 6277:   color: $fontmenu;
1.392     albertel 6278:   border-collapse: collapse;
1.803     bisitz   6279:   padding: 0;
1.819     tempelho 6280:   margin: 0;
1.359     albertel 6281: }
1.795     www      6282: 
1.933     droeschl 6283: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 6284:     margin: 0;
                   6285:     padding: 0;
1.933     droeschl 6286:     position: relative;
                   6287:     list-style: none;
1.913     droeschl 6288: }
1.933     droeschl 6289: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 6290:     display: inline;
                   6291: }
1.933     droeschl 6292: 
                   6293: .LC_breadcrumb_tools_navigation {
1.913     droeschl 6294:     padding: 0;
1.933     droeschl 6295:     margin: 0;
                   6296:     float: left;
1.913     droeschl 6297: }
1.933     droeschl 6298: .LC_breadcrumb_tools_tools {
                   6299:     padding: 0;
                   6300:     margin: 0;
1.913     droeschl 6301:     float: right;
                   6302: }
                   6303: 
1.359     albertel 6304: table#LC_title_bar td {
                   6305:   background: $tabbg;
                   6306: }
1.795     www      6307: 
1.911     bisitz   6308: table#LC_menubuttons img {
1.803     bisitz   6309:   border: none;
1.346     albertel 6310: }
1.795     www      6311: 
1.842     droeschl 6312: .LC_breadcrumbs_component {
1.911     bisitz   6313:   float: right;
                   6314:   margin: 0 1em;
1.357     albertel 6315: }
1.842     droeschl 6316: .LC_breadcrumbs_component img {
1.911     bisitz   6317:   vertical-align: middle;
1.777     tempelho 6318: }
1.795     www      6319: 
1.1075.2.108  raeburn  6320: .LC_breadcrumbs_hoverable {
                   6321:   background: $sidebg;
                   6322: }
                   6323: 
1.383     albertel 6324: td.LC_table_cell_checkbox {
                   6325:   text-align: center;
                   6326: }
1.795     www      6327: 
                   6328: .LC_fontsize_small {
1.911     bisitz   6329:   font-size: 70%;
1.705     tempelho 6330: }
                   6331: 
1.844     bisitz   6332: #LC_breadcrumbs {
1.911     bisitz   6333:   clear:both;
                   6334:   background: $sidebg;
                   6335:   border-bottom: 1px solid $lg_border_color;
                   6336:   line-height: 2.5em;
1.933     droeschl 6337:   overflow: hidden;
1.911     bisitz   6338:   margin: 0;
                   6339:   padding: 0;
1.995     raeburn  6340:   text-align: left;
1.819     tempelho 6341: }
1.862     bisitz   6342: 
1.1075.2.16  raeburn  6343: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   6344:   clear:both;
                   6345:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 6346:   border: 1px solid $sidebg;
1.1075.2.16  raeburn  6347:   margin: 0 0 10px 0;
1.966     bisitz   6348:   padding: 3px;
1.995     raeburn  6349:   text-align: left;
1.822     bisitz   6350: }
                   6351: 
1.795     www      6352: .LC_fontsize_medium {
1.911     bisitz   6353:   font-size: 85%;
1.705     tempelho 6354: }
                   6355: 
1.795     www      6356: .LC_fontsize_large {
1.911     bisitz   6357:   font-size: 120%;
1.705     tempelho 6358: }
                   6359: 
1.346     albertel 6360: .LC_menubuttons_inline_text {
                   6361:   color: $font;
1.698     harmsja  6362:   font-size: 90%;
1.701     harmsja  6363:   padding-left:3px;
1.346     albertel 6364: }
                   6365: 
1.934     droeschl 6366: .LC_menubuttons_inline_text img{
                   6367:   vertical-align: middle;
                   6368: }
                   6369: 
1.1051    www      6370: li.LC_menubuttons_inline_text img {
1.951     onken    6371:   cursor:pointer;
1.1002    droeschl 6372:   text-decoration: none;
1.951     onken    6373: }
                   6374: 
1.526     www      6375: .LC_menubuttons_link {
                   6376:   text-decoration: none;
                   6377: }
1.795     www      6378: 
1.522     albertel 6379: .LC_menubuttons_category {
1.521     www      6380:   color: $font;
1.526     www      6381:   background: $pgbg;
1.521     www      6382:   font-size: larger;
                   6383:   font-weight: bold;
                   6384: }
                   6385: 
1.346     albertel 6386: td.LC_menubuttons_text {
1.911     bisitz   6387:   color: $font;
1.346     albertel 6388: }
1.706     harmsja  6389: 
1.346     albertel 6390: .LC_current_location {
                   6391:   background: $tabbg;
                   6392: }
1.795     www      6393: 
1.1075.2.134  raeburn  6394: td.LC_zero_height {
                   6395:   line-height: 0;
                   6396:   cellpadding: 0;
                   6397: }
                   6398: 
1.938     bisitz   6399: table.LC_data_table {
1.347     albertel 6400:   border: 1px solid #000000;
1.402     albertel 6401:   border-collapse: separate;
1.426     albertel 6402:   border-spacing: 1px;
1.610     albertel 6403:   background: $pgbg;
1.347     albertel 6404: }
1.795     www      6405: 
1.422     albertel 6406: .LC_data_table_dense {
                   6407:   font-size: small;
                   6408: }
1.795     www      6409: 
1.507     raeburn  6410: table.LC_nested_outer {
                   6411:   border: 1px solid #000000;
1.589     raeburn  6412:   border-collapse: collapse;
1.803     bisitz   6413:   border-spacing: 0;
1.507     raeburn  6414:   width: 100%;
                   6415: }
1.795     www      6416: 
1.879     raeburn  6417: table.LC_innerpickbox,
1.507     raeburn  6418: table.LC_nested {
1.803     bisitz   6419:   border: none;
1.589     raeburn  6420:   border-collapse: collapse;
1.803     bisitz   6421:   border-spacing: 0;
1.507     raeburn  6422:   width: 100%;
                   6423: }
1.795     www      6424: 
1.911     bisitz   6425: table.LC_data_table tr th,
                   6426: table.LC_calendar tr th,
1.879     raeburn  6427: table.LC_prior_tries tr th,
                   6428: table.LC_innerpickbox tr th {
1.349     albertel 6429:   font-weight: bold;
                   6430:   background-color: $data_table_head;
1.801     tempelho 6431:   color:$fontmenu;
1.701     harmsja  6432:   font-size:90%;
1.347     albertel 6433: }
1.795     www      6434: 
1.879     raeburn  6435: table.LC_innerpickbox tr th,
                   6436: table.LC_innerpickbox tr td {
                   6437:   vertical-align: top;
                   6438: }
                   6439: 
1.711     raeburn  6440: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   6441:   background-color: #CCCCCC;
1.711     raeburn  6442:   font-weight: bold;
                   6443:   text-align: left;
                   6444: }
1.795     www      6445: 
1.912     bisitz   6446: table.LC_data_table tr.LC_odd_row > td {
                   6447:   background-color: $data_table_light;
                   6448:   padding: 2px;
                   6449:   vertical-align: top;
                   6450: }
                   6451: 
1.809     bisitz   6452: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 6453:   background-color: $data_table_light;
1.912     bisitz   6454:   vertical-align: top;
                   6455: }
                   6456: 
                   6457: table.LC_data_table tr.LC_even_row > td {
                   6458:   background-color: $data_table_dark;
1.425     albertel 6459:   padding: 2px;
1.900     bisitz   6460:   vertical-align: top;
1.347     albertel 6461: }
1.795     www      6462: 
1.809     bisitz   6463: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 6464:   background-color: $data_table_dark;
1.900     bisitz   6465:   vertical-align: top;
1.347     albertel 6466: }
1.795     www      6467: 
1.425     albertel 6468: table.LC_data_table tr.LC_data_table_highlight td {
                   6469:   background-color: $data_table_darker;
                   6470: }
1.795     www      6471: 
1.639     raeburn  6472: table.LC_data_table tr td.LC_leftcol_header {
                   6473:   background-color: $data_table_head;
                   6474:   font-weight: bold;
                   6475: }
1.795     www      6476: 
1.451     albertel 6477: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  6478: table.LC_nested tr.LC_empty_row td {
1.421     albertel 6479:   font-weight: bold;
                   6480:   font-style: italic;
                   6481:   text-align: center;
                   6482:   padding: 8px;
1.347     albertel 6483: }
1.795     www      6484: 
1.1075.2.30  raeburn  6485: table.LC_data_table tr.LC_empty_row td,
                   6486: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   6487:   background-color: $sidebg;
                   6488: }
                   6489: 
                   6490: table.LC_nested tr.LC_empty_row td {
                   6491:   background-color: #FFFFFF;
                   6492: }
                   6493: 
1.890     droeschl 6494: table.LC_caption {
                   6495: }
                   6496: 
1.507     raeburn  6497: table.LC_nested tr.LC_empty_row td {
1.465     albertel 6498:   padding: 4ex
                   6499: }
1.795     www      6500: 
1.507     raeburn  6501: table.LC_nested_outer tr th {
                   6502:   font-weight: bold;
1.801     tempelho 6503:   color:$fontmenu;
1.507     raeburn  6504:   background-color: $data_table_head;
1.701     harmsja  6505:   font-size: small;
1.507     raeburn  6506:   border-bottom: 1px solid #000000;
                   6507: }
1.795     www      6508: 
1.507     raeburn  6509: table.LC_nested_outer tr td.LC_subheader {
                   6510:   background-color: $data_table_head;
                   6511:   font-weight: bold;
                   6512:   font-size: small;
                   6513:   border-bottom: 1px solid #000000;
                   6514:   text-align: right;
1.451     albertel 6515: }
1.795     www      6516: 
1.507     raeburn  6517: table.LC_nested tr.LC_info_row td {
1.735     bisitz   6518:   background-color: #CCCCCC;
1.451     albertel 6519:   font-weight: bold;
                   6520:   font-size: small;
1.507     raeburn  6521:   text-align: center;
                   6522: }
1.795     www      6523: 
1.589     raeburn  6524: table.LC_nested tr.LC_info_row td.LC_left_item,
                   6525: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  6526:   text-align: left;
1.451     albertel 6527: }
1.795     www      6528: 
1.507     raeburn  6529: table.LC_nested td {
1.735     bisitz   6530:   background-color: #FFFFFF;
1.451     albertel 6531:   font-size: small;
1.507     raeburn  6532: }
1.795     www      6533: 
1.507     raeburn  6534: table.LC_nested_outer tr th.LC_right_item,
                   6535: table.LC_nested tr.LC_info_row td.LC_right_item,
                   6536: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   6537: table.LC_nested tr td.LC_right_item {
1.451     albertel 6538:   text-align: right;
                   6539: }
                   6540: 
1.507     raeburn  6541: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   6542:   background-color: #EEEEEE;
1.451     albertel 6543: }
                   6544: 
1.473     raeburn  6545: table.LC_createuser {
                   6546: }
                   6547: 
                   6548: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  6549:   font-size: small;
1.473     raeburn  6550: }
                   6551: 
                   6552: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   6553:   background-color: #CCCCCC;
1.473     raeburn  6554:   font-weight: bold;
                   6555:   text-align: center;
                   6556: }
                   6557: 
1.349     albertel 6558: table.LC_calendar {
                   6559:   border: 1px solid #000000;
                   6560:   border-collapse: collapse;
1.917     raeburn  6561:   width: 98%;
1.349     albertel 6562: }
1.795     www      6563: 
1.349     albertel 6564: table.LC_calendar_pickdate {
                   6565:   font-size: xx-small;
                   6566: }
1.795     www      6567: 
1.349     albertel 6568: table.LC_calendar tr td {
                   6569:   border: 1px solid #000000;
                   6570:   vertical-align: top;
1.917     raeburn  6571:   width: 14%;
1.349     albertel 6572: }
1.795     www      6573: 
1.349     albertel 6574: table.LC_calendar tr td.LC_calendar_day_empty {
                   6575:   background-color: $data_table_dark;
                   6576: }
1.795     www      6577: 
1.779     bisitz   6578: table.LC_calendar tr td.LC_calendar_day_current {
                   6579:   background-color: $data_table_highlight;
1.777     tempelho 6580: }
1.795     www      6581: 
1.938     bisitz   6582: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 6583:   background-color: $mail_new;
                   6584: }
1.795     www      6585: 
1.938     bisitz   6586: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 6587:   background-color: $mail_new_hover;
                   6588: }
1.795     www      6589: 
1.938     bisitz   6590: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 6591:   background-color: $mail_read;
                   6592: }
1.795     www      6593: 
1.938     bisitz   6594: /*
                   6595: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 6596:   background-color: $mail_read_hover;
                   6597: }
1.938     bisitz   6598: */
1.795     www      6599: 
1.938     bisitz   6600: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 6601:   background-color: $mail_replied;
                   6602: }
1.795     www      6603: 
1.938     bisitz   6604: /*
                   6605: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 6606:   background-color: $mail_replied_hover;
                   6607: }
1.938     bisitz   6608: */
1.795     www      6609: 
1.938     bisitz   6610: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 6611:   background-color: $mail_other;
                   6612: }
1.795     www      6613: 
1.938     bisitz   6614: /*
                   6615: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 6616:   background-color: $mail_other_hover;
                   6617: }
1.938     bisitz   6618: */
1.494     raeburn  6619: 
1.777     tempelho 6620: table.LC_data_table tr > td.LC_browser_file,
                   6621: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   6622:   background: #AAEE77;
1.389     albertel 6623: }
1.795     www      6624: 
1.777     tempelho 6625: table.LC_data_table tr > td.LC_browser_file_locked,
                   6626: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 6627:   background: #FFAA99;
1.387     albertel 6628: }
1.795     www      6629: 
1.777     tempelho 6630: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   6631:   background: #888888;
1.779     bisitz   6632: }
1.795     www      6633: 
1.777     tempelho 6634: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   6635: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   6636:   background: #F8F866;
1.777     tempelho 6637: }
1.795     www      6638: 
1.696     bisitz   6639: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   6640:   background: #E0E8FF;
1.387     albertel 6641: }
1.696     bisitz   6642: 
1.707     bisitz   6643: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   6644:   /* background: #77FF77; */
1.707     bisitz   6645: }
1.795     www      6646: 
1.707     bisitz   6647: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   6648:   border-right: 8px solid #FFFF77;
1.707     bisitz   6649: }
1.795     www      6650: 
1.707     bisitz   6651: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   6652:   border-right: 8px solid #FFAA77;
1.707     bisitz   6653: }
1.795     www      6654: 
1.707     bisitz   6655: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   6656:   border-right: 8px solid #FF7777;
1.707     bisitz   6657: }
1.795     www      6658: 
1.707     bisitz   6659: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   6660:   border-right: 8px solid #AAFF77;
1.707     bisitz   6661: }
1.795     www      6662: 
1.707     bisitz   6663: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   6664:   border-right: 8px solid #11CC55;
1.707     bisitz   6665: }
                   6666: 
1.388     albertel 6667: span.LC_current_location {
1.701     harmsja  6668:   font-size:larger;
1.388     albertel 6669:   background: $pgbg;
                   6670: }
1.387     albertel 6671: 
1.1029    www      6672: span.LC_current_nav_location {
                   6673:   font-weight:bold;
                   6674:   background: $sidebg;
                   6675: }
                   6676: 
1.395     albertel 6677: span.LC_parm_menu_item {
                   6678:   font-size: larger;
                   6679: }
1.795     www      6680: 
1.395     albertel 6681: span.LC_parm_scope_all {
                   6682:   color: red;
                   6683: }
1.795     www      6684: 
1.395     albertel 6685: span.LC_parm_scope_folder {
                   6686:   color: green;
                   6687: }
1.795     www      6688: 
1.395     albertel 6689: span.LC_parm_scope_resource {
                   6690:   color: orange;
                   6691: }
1.795     www      6692: 
1.395     albertel 6693: span.LC_parm_part {
                   6694:   color: blue;
                   6695: }
1.795     www      6696: 
1.911     bisitz   6697: span.LC_parm_folder,
                   6698: span.LC_parm_symb {
1.395     albertel 6699:   font-size: x-small;
                   6700:   font-family: $mono;
                   6701:   color: #AAAAAA;
                   6702: }
                   6703: 
1.977     bisitz   6704: ul.LC_parm_parmlist li {
                   6705:   display: inline-block;
                   6706:   padding: 0.3em 0.8em;
                   6707:   vertical-align: top;
                   6708:   width: 150px;
                   6709:   border-top:1px solid $lg_border_color;
                   6710: }
                   6711: 
1.795     www      6712: td.LC_parm_overview_level_menu,
                   6713: td.LC_parm_overview_map_menu,
                   6714: td.LC_parm_overview_parm_selectors,
                   6715: td.LC_parm_overview_restrictions  {
1.396     albertel 6716:   border: 1px solid black;
                   6717:   border-collapse: collapse;
                   6718: }
1.795     www      6719: 
1.396     albertel 6720: table.LC_parm_overview_restrictions td {
                   6721:   border-width: 1px 4px 1px 4px;
                   6722:   border-style: solid;
                   6723:   border-color: $pgbg;
                   6724:   text-align: center;
                   6725: }
1.795     www      6726: 
1.396     albertel 6727: table.LC_parm_overview_restrictions th {
                   6728:   background: $tabbg;
                   6729:   border-width: 1px 4px 1px 4px;
                   6730:   border-style: solid;
                   6731:   border-color: $pgbg;
                   6732: }
1.795     www      6733: 
1.398     albertel 6734: table#LC_helpmenu {
1.803     bisitz   6735:   border: none;
1.398     albertel 6736:   height: 55px;
1.803     bisitz   6737:   border-spacing: 0;
1.398     albertel 6738: }
                   6739: 
                   6740: table#LC_helpmenu fieldset legend {
                   6741:   font-size: larger;
                   6742: }
1.795     www      6743: 
1.397     albertel 6744: table#LC_helpmenu_links {
                   6745:   width: 100%;
                   6746:   border: 1px solid black;
                   6747:   background: $pgbg;
1.803     bisitz   6748:   padding: 0;
1.397     albertel 6749:   border-spacing: 1px;
                   6750: }
1.795     www      6751: 
1.397     albertel 6752: table#LC_helpmenu_links tr td {
                   6753:   padding: 1px;
                   6754:   background: $tabbg;
1.399     albertel 6755:   text-align: center;
                   6756:   font-weight: bold;
1.397     albertel 6757: }
1.396     albertel 6758: 
1.795     www      6759: table#LC_helpmenu_links a:link,
                   6760: table#LC_helpmenu_links a:visited,
1.397     albertel 6761: table#LC_helpmenu_links a:active {
                   6762:   text-decoration: none;
                   6763:   color: $font;
                   6764: }
1.795     www      6765: 
1.397     albertel 6766: table#LC_helpmenu_links a:hover {
                   6767:   text-decoration: underline;
                   6768:   color: $vlink;
                   6769: }
1.396     albertel 6770: 
1.417     albertel 6771: .LC_chrt_popup_exists {
                   6772:   border: 1px solid #339933;
                   6773:   margin: -1px;
                   6774: }
1.795     www      6775: 
1.417     albertel 6776: .LC_chrt_popup_up {
                   6777:   border: 1px solid yellow;
                   6778:   margin: -1px;
                   6779: }
1.795     www      6780: 
1.417     albertel 6781: .LC_chrt_popup {
                   6782:   border: 1px solid #8888FF;
                   6783:   background: #CCCCFF;
                   6784: }
1.795     www      6785: 
1.421     albertel 6786: table.LC_pick_box {
                   6787:   border-collapse: separate;
                   6788:   background: white;
                   6789:   border: 1px solid black;
                   6790:   border-spacing: 1px;
                   6791: }
1.795     www      6792: 
1.421     albertel 6793: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   6794:   background: $sidebg;
1.421     albertel 6795:   font-weight: bold;
1.900     bisitz   6796:   text-align: left;
1.740     bisitz   6797:   vertical-align: top;
1.421     albertel 6798:   width: 184px;
                   6799:   padding: 8px;
                   6800: }
1.795     www      6801: 
1.579     raeburn  6802: table.LC_pick_box td.LC_pick_box_value {
                   6803:   text-align: left;
                   6804:   padding: 8px;
                   6805: }
1.795     www      6806: 
1.579     raeburn  6807: table.LC_pick_box td.LC_pick_box_select {
                   6808:   text-align: left;
                   6809:   padding: 8px;
                   6810: }
1.795     www      6811: 
1.424     albertel 6812: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   6813:   padding: 0;
1.421     albertel 6814:   height: 1px;
                   6815:   background: black;
                   6816: }
1.795     www      6817: 
1.421     albertel 6818: table.LC_pick_box td.LC_pick_box_submit {
                   6819:   text-align: right;
                   6820: }
1.795     www      6821: 
1.579     raeburn  6822: table.LC_pick_box td.LC_evenrow_value {
                   6823:   text-align: left;
                   6824:   padding: 8px;
                   6825:   background-color: $data_table_light;
                   6826: }
1.795     www      6827: 
1.579     raeburn  6828: table.LC_pick_box td.LC_oddrow_value {
                   6829:   text-align: left;
                   6830:   padding: 8px;
                   6831:   background-color: $data_table_light;
                   6832: }
1.795     www      6833: 
1.579     raeburn  6834: span.LC_helpform_receipt_cat {
                   6835:   font-weight: bold;
                   6836: }
1.795     www      6837: 
1.424     albertel 6838: table.LC_group_priv_box {
                   6839:   background: white;
                   6840:   border: 1px solid black;
                   6841:   border-spacing: 1px;
                   6842: }
1.795     www      6843: 
1.424     albertel 6844: table.LC_group_priv_box td.LC_pick_box_title {
                   6845:   background: $tabbg;
                   6846:   font-weight: bold;
                   6847:   text-align: right;
                   6848:   width: 184px;
                   6849: }
1.795     www      6850: 
1.424     albertel 6851: table.LC_group_priv_box td.LC_groups_fixed {
                   6852:   background: $data_table_light;
                   6853:   text-align: center;
                   6854: }
1.795     www      6855: 
1.424     albertel 6856: table.LC_group_priv_box td.LC_groups_optional {
                   6857:   background: $data_table_dark;
                   6858:   text-align: center;
                   6859: }
1.795     www      6860: 
1.424     albertel 6861: table.LC_group_priv_box td.LC_groups_functionality {
                   6862:   background: $data_table_darker;
                   6863:   text-align: center;
                   6864:   font-weight: bold;
                   6865: }
1.795     www      6866: 
1.424     albertel 6867: table.LC_group_priv td {
                   6868:   text-align: left;
1.803     bisitz   6869:   padding: 0;
1.424     albertel 6870: }
                   6871: 
                   6872: .LC_navbuttons {
                   6873:   margin: 2ex 0ex 2ex 0ex;
                   6874: }
1.795     www      6875: 
1.423     albertel 6876: .LC_topic_bar {
                   6877:   font-weight: bold;
                   6878:   background: $tabbg;
1.918     wenzelju 6879:   margin: 1em 0em 1em 2em;
1.805     bisitz   6880:   padding: 3px;
1.918     wenzelju 6881:   font-size: 1.2em;
1.423     albertel 6882: }
1.795     www      6883: 
1.423     albertel 6884: .LC_topic_bar span {
1.918     wenzelju 6885:   left: 0.5em;
                   6886:   position: absolute;
1.423     albertel 6887:   vertical-align: middle;
1.918     wenzelju 6888:   font-size: 1.2em;
1.423     albertel 6889: }
1.795     www      6890: 
1.423     albertel 6891: table.LC_course_group_status {
                   6892:   margin: 20px;
                   6893: }
1.795     www      6894: 
1.423     albertel 6895: table.LC_status_selector td {
                   6896:   vertical-align: top;
                   6897:   text-align: center;
1.424     albertel 6898:   padding: 4px;
                   6899: }
1.795     www      6900: 
1.599     albertel 6901: div.LC_feedback_link {
1.616     albertel 6902:   clear: both;
1.829     kalberla 6903:   background: $sidebg;
1.779     bisitz   6904:   width: 100%;
1.829     kalberla 6905:   padding-bottom: 10px;
                   6906:   border: 1px $tabbg solid;
1.833     kalberla 6907:   height: 22px;
                   6908:   line-height: 22px;
                   6909:   padding-top: 5px;
                   6910: }
                   6911: 
                   6912: div.LC_feedback_link img {
                   6913:   height: 22px;
1.867     kalberla 6914:   vertical-align:middle;
1.829     kalberla 6915: }
                   6916: 
1.911     bisitz   6917: div.LC_feedback_link a {
1.829     kalberla 6918:   text-decoration: none;
1.489     raeburn  6919: }
1.795     www      6920: 
1.867     kalberla 6921: div.LC_comblock {
1.911     bisitz   6922:   display:inline;
1.867     kalberla 6923:   color:$font;
                   6924:   font-size:90%;
                   6925: }
                   6926: 
                   6927: div.LC_feedback_link div.LC_comblock {
                   6928:   padding-left:5px;
                   6929: }
                   6930: 
                   6931: div.LC_feedback_link div.LC_comblock a {
                   6932:   color:$font;
                   6933: }
                   6934: 
1.489     raeburn  6935: span.LC_feedback_link {
1.858     bisitz   6936:   /* background: $feedback_link_bg; */
1.599     albertel 6937:   font-size: larger;
                   6938: }
1.795     www      6939: 
1.599     albertel 6940: span.LC_message_link {
1.858     bisitz   6941:   /* background: $feedback_link_bg; */
1.599     albertel 6942:   font-size: larger;
                   6943:   position: absolute;
                   6944:   right: 1em;
1.489     raeburn  6945: }
1.421     albertel 6946: 
1.515     albertel 6947: table.LC_prior_tries {
1.524     albertel 6948:   border: 1px solid #000000;
                   6949:   border-collapse: separate;
                   6950:   border-spacing: 1px;
1.515     albertel 6951: }
1.523     albertel 6952: 
1.515     albertel 6953: table.LC_prior_tries td {
1.524     albertel 6954:   padding: 2px;
1.515     albertel 6955: }
1.523     albertel 6956: 
                   6957: .LC_answer_correct {
1.795     www      6958:   background: lightgreen;
                   6959:   color: darkgreen;
                   6960:   padding: 6px;
1.523     albertel 6961: }
1.795     www      6962: 
1.523     albertel 6963: .LC_answer_charged_try {
1.797     www      6964:   background: #FFAAAA;
1.795     www      6965:   color: darkred;
                   6966:   padding: 6px;
1.523     albertel 6967: }
1.795     www      6968: 
1.779     bisitz   6969: .LC_answer_not_charged_try,
1.523     albertel 6970: .LC_answer_no_grade,
                   6971: .LC_answer_late {
1.795     www      6972:   background: lightyellow;
1.523     albertel 6973:   color: black;
1.795     www      6974:   padding: 6px;
1.523     albertel 6975: }
1.795     www      6976: 
1.523     albertel 6977: .LC_answer_previous {
1.795     www      6978:   background: lightblue;
                   6979:   color: darkblue;
                   6980:   padding: 6px;
1.523     albertel 6981: }
1.795     www      6982: 
1.779     bisitz   6983: .LC_answer_no_message {
1.777     tempelho 6984:   background: #FFFFFF;
                   6985:   color: black;
1.795     www      6986:   padding: 6px;
1.779     bisitz   6987: }
1.795     www      6988: 
1.1075.2.140  raeburn  6989: .LC_answer_unknown,
                   6990: .LC_answer_warning {
1.779     bisitz   6991:   background: orange;
                   6992:   color: black;
1.795     www      6993:   padding: 6px;
1.777     tempelho 6994: }
1.795     www      6995: 
1.529     albertel 6996: span.LC_prior_numerical,
                   6997: span.LC_prior_string,
                   6998: span.LC_prior_custom,
                   6999: span.LC_prior_reaction,
                   7000: span.LC_prior_math {
1.925     bisitz   7001:   font-family: $mono;
1.523     albertel 7002:   white-space: pre;
                   7003: }
                   7004: 
1.525     albertel 7005: span.LC_prior_string {
1.925     bisitz   7006:   font-family: $mono;
1.525     albertel 7007:   white-space: pre;
                   7008: }
                   7009: 
1.523     albertel 7010: table.LC_prior_option {
                   7011:   width: 100%;
                   7012:   border-collapse: collapse;
                   7013: }
1.795     www      7014: 
1.911     bisitz   7015: table.LC_prior_rank,
1.795     www      7016: table.LC_prior_match {
1.528     albertel 7017:   border-collapse: collapse;
                   7018: }
1.795     www      7019: 
1.528     albertel 7020: table.LC_prior_option tr td,
                   7021: table.LC_prior_rank tr td,
                   7022: table.LC_prior_match tr td {
1.524     albertel 7023:   border: 1px solid #000000;
1.515     albertel 7024: }
                   7025: 
1.855     bisitz   7026: .LC_nobreak {
1.544     albertel 7027:   white-space: nowrap;
1.519     raeburn  7028: }
                   7029: 
1.576     raeburn  7030: span.LC_cusr_emph {
                   7031:   font-style: italic;
                   7032: }
                   7033: 
1.633     raeburn  7034: span.LC_cusr_subheading {
                   7035:   font-weight: normal;
                   7036:   font-size: 85%;
                   7037: }
                   7038: 
1.861     bisitz   7039: div.LC_docs_entry_move {
1.859     bisitz   7040:   border: 1px solid #BBBBBB;
1.545     albertel 7041:   background: #DDDDDD;
1.861     bisitz   7042:   width: 22px;
1.859     bisitz   7043:   padding: 1px;
                   7044:   margin: 0;
1.545     albertel 7045: }
                   7046: 
1.861     bisitz   7047: table.LC_data_table tr > td.LC_docs_entry_commands,
                   7048: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 7049:   font-size: x-small;
                   7050: }
1.795     www      7051: 
1.861     bisitz   7052: .LC_docs_entry_parameter {
                   7053:   white-space: nowrap;
                   7054: }
                   7055: 
1.544     albertel 7056: .LC_docs_copy {
1.545     albertel 7057:   color: #000099;
1.544     albertel 7058: }
1.795     www      7059: 
1.544     albertel 7060: .LC_docs_cut {
1.545     albertel 7061:   color: #550044;
1.544     albertel 7062: }
1.795     www      7063: 
1.544     albertel 7064: .LC_docs_rename {
1.545     albertel 7065:   color: #009900;
1.544     albertel 7066: }
1.795     www      7067: 
1.544     albertel 7068: .LC_docs_remove {
1.545     albertel 7069:   color: #990000;
                   7070: }
                   7071: 
1.1075.2.134  raeburn  7072: .LC_domprefs_email,
1.547     albertel 7073: .LC_docs_reinit_warn,
                   7074: .LC_docs_ext_edit {
                   7075:   font-size: x-small;
                   7076: }
                   7077: 
1.545     albertel 7078: table.LC_docs_adddocs td,
                   7079: table.LC_docs_adddocs th {
                   7080:   border: 1px solid #BBBBBB;
                   7081:   padding: 4px;
                   7082:   background: #DDDDDD;
1.543     albertel 7083: }
                   7084: 
1.584     albertel 7085: table.LC_sty_begin {
                   7086:   background: #BBFFBB;
                   7087: }
1.795     www      7088: 
1.584     albertel 7089: table.LC_sty_end {
                   7090:   background: #FFBBBB;
                   7091: }
                   7092: 
1.589     raeburn  7093: table.LC_double_column {
1.803     bisitz   7094:   border-width: 0;
1.589     raeburn  7095:   border-collapse: collapse;
                   7096:   width: 100%;
                   7097:   padding: 2px;
                   7098: }
                   7099: 
                   7100: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  7101:   top: 2px;
1.589     raeburn  7102:   left: 2px;
                   7103:   width: 47%;
                   7104:   vertical-align: top;
                   7105: }
                   7106: 
                   7107: table.LC_double_column tr td.LC_right_col {
                   7108:   top: 2px;
1.779     bisitz   7109:   right: 2px;
1.589     raeburn  7110:   width: 47%;
                   7111:   vertical-align: top;
                   7112: }
                   7113: 
1.591     raeburn  7114: div.LC_left_float {
                   7115:   float: left;
                   7116:   padding-right: 5%;
1.597     albertel 7117:   padding-bottom: 4px;
1.591     raeburn  7118: }
                   7119: 
                   7120: div.LC_clear_float_header {
1.597     albertel 7121:   padding-bottom: 2px;
1.591     raeburn  7122: }
                   7123: 
                   7124: div.LC_clear_float_footer {
1.597     albertel 7125:   padding-top: 10px;
1.591     raeburn  7126:   clear: both;
                   7127: }
                   7128: 
1.597     albertel 7129: div.LC_grade_show_user {
1.941     bisitz   7130: /*  border-left: 5px solid $sidebg; */
                   7131:   border-top: 5px solid #000000;
                   7132:   margin: 50px 0 0 0;
1.936     bisitz   7133:   padding: 15px 0 5px 10px;
1.597     albertel 7134: }
1.795     www      7135: 
1.936     bisitz   7136: div.LC_grade_show_user_odd_row {
1.941     bisitz   7137: /*  border-left: 5px solid #000000; */
                   7138: }
                   7139: 
                   7140: div.LC_grade_show_user div.LC_Box {
                   7141:   margin-right: 50px;
1.597     albertel 7142: }
                   7143: 
                   7144: div.LC_grade_submissions,
                   7145: div.LC_grade_message_center,
1.936     bisitz   7146: div.LC_grade_info_links {
1.597     albertel 7147:   margin: 5px;
                   7148:   width: 99%;
                   7149:   background: #FFFFFF;
                   7150: }
1.795     www      7151: 
1.597     albertel 7152: div.LC_grade_submissions_header,
1.936     bisitz   7153: div.LC_grade_message_center_header {
1.705     tempelho 7154:   font-weight: bold;
                   7155:   font-size: large;
1.597     albertel 7156: }
1.795     www      7157: 
1.597     albertel 7158: div.LC_grade_submissions_body,
1.936     bisitz   7159: div.LC_grade_message_center_body {
1.597     albertel 7160:   border: 1px solid black;
                   7161:   width: 99%;
                   7162:   background: #FFFFFF;
                   7163: }
1.795     www      7164: 
1.613     albertel 7165: table.LC_scantron_action {
                   7166:   width: 100%;
                   7167: }
1.795     www      7168: 
1.613     albertel 7169: table.LC_scantron_action tr th {
1.698     harmsja  7170:   font-weight:bold;
                   7171:   font-style:normal;
1.613     albertel 7172: }
1.795     www      7173: 
1.779     bisitz   7174: .LC_edit_problem_header,
1.614     albertel 7175: div.LC_edit_problem_footer {
1.705     tempelho 7176:   font-weight: normal;
                   7177:   font-size:  medium;
1.602     albertel 7178:   margin: 2px;
1.1060    bisitz   7179:   background-color: $sidebg;
1.600     albertel 7180: }
1.795     www      7181: 
1.600     albertel 7182: div.LC_edit_problem_header,
1.602     albertel 7183: div.LC_edit_problem_header div,
1.614     albertel 7184: div.LC_edit_problem_footer,
                   7185: div.LC_edit_problem_footer div,
1.602     albertel 7186: div.LC_edit_problem_editxml_header,
                   7187: div.LC_edit_problem_editxml_header div {
1.1075.2.112  raeburn  7188:   z-index: 100;
1.600     albertel 7189: }
1.795     www      7190: 
1.600     albertel 7191: div.LC_edit_problem_header_title {
1.705     tempelho 7192:   font-weight: bold;
                   7193:   font-size: larger;
1.602     albertel 7194:   background: $tabbg;
                   7195:   padding: 3px;
1.1060    bisitz   7196:   margin: 0 0 5px 0;
1.602     albertel 7197: }
1.795     www      7198: 
1.602     albertel 7199: table.LC_edit_problem_header_title {
                   7200:   width: 100%;
1.600     albertel 7201:   background: $tabbg;
1.602     albertel 7202: }
                   7203: 
1.1075.2.112  raeburn  7204: div.LC_edit_actionbar {
                   7205:     background-color: $sidebg;
                   7206:     margin: 0;
                   7207:     padding: 0;
                   7208:     line-height: 200%;
1.602     albertel 7209: }
1.795     www      7210: 
1.1075.2.112  raeburn  7211: div.LC_edit_actionbar div{
                   7212:     padding: 0;
                   7213:     margin: 0;
                   7214:     display: inline-block;
1.600     albertel 7215: }
1.795     www      7216: 
1.1075.2.34  raeburn  7217: .LC_edit_opt {
                   7218:   padding-left: 1em;
                   7219:   white-space: nowrap;
                   7220: }
                   7221: 
1.1075.2.57  raeburn  7222: .LC_edit_problem_latexhelper{
                   7223:     text-align: right;
                   7224: }
                   7225: 
                   7226: #LC_edit_problem_colorful div{
                   7227:     margin-left: 40px;
                   7228: }
                   7229: 
1.1075.2.112  raeburn  7230: #LC_edit_problem_codemirror div{
                   7231:     margin-left: 0px;
                   7232: }
                   7233: 
1.911     bisitz   7234: img.stift {
1.803     bisitz   7235:   border-width: 0;
                   7236:   vertical-align: middle;
1.677     riegler  7237: }
1.680     riegler  7238: 
1.923     bisitz   7239: table td.LC_mainmenu_col_fieldset {
1.680     riegler  7240:   vertical-align: top;
1.777     tempelho 7241: }
1.795     www      7242: 
1.716     raeburn  7243: div.LC_createcourse {
1.911     bisitz   7244:   margin: 10px 10px 10px 10px;
1.716     raeburn  7245: }
                   7246: 
1.917     raeburn  7247: .LC_dccid {
1.1075.2.38  raeburn  7248:   float: right;
1.917     raeburn  7249:   margin: 0.2em 0 0 0;
                   7250:   padding: 0;
                   7251:   font-size: 90%;
                   7252:   display:none;
                   7253: }
                   7254: 
1.897     wenzelju 7255: ol.LC_primary_menu a:hover,
1.721     harmsja  7256: ol#LC_MenuBreadcrumbs a:hover,
                   7257: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 7258: ul#LC_secondary_menu a:hover,
1.721     harmsja  7259: .LC_FormSectionClearButton input:hover
1.795     www      7260: ul.LC_TabContent   li:hover a {
1.952     onken    7261:   color:$button_hover;
1.911     bisitz   7262:   text-decoration:none;
1.693     droeschl 7263: }
                   7264: 
1.779     bisitz   7265: h1 {
1.911     bisitz   7266:   padding: 0;
                   7267:   line-height:130%;
1.693     droeschl 7268: }
1.698     harmsja  7269: 
1.911     bisitz   7270: h2,
                   7271: h3,
                   7272: h4,
                   7273: h5,
                   7274: h6 {
                   7275:   margin: 5px 0 5px 0;
                   7276:   padding: 0;
                   7277:   line-height:130%;
1.693     droeschl 7278: }
1.795     www      7279: 
                   7280: .LC_hcell {
1.911     bisitz   7281:   padding:3px 15px 3px 15px;
                   7282:   margin: 0;
                   7283:   background-color:$tabbg;
                   7284:   color:$fontmenu;
                   7285:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 7286: }
1.795     www      7287: 
1.840     bisitz   7288: .LC_Box > .LC_hcell {
1.911     bisitz   7289:   margin: 0 -10px 10px -10px;
1.835     bisitz   7290: }
                   7291: 
1.721     harmsja  7292: .LC_noBorder {
1.911     bisitz   7293:   border: 0;
1.698     harmsja  7294: }
1.693     droeschl 7295: 
1.721     harmsja  7296: .LC_FormSectionClearButton input {
1.911     bisitz   7297:   background-color:transparent;
                   7298:   border: none;
                   7299:   cursor:pointer;
                   7300:   text-decoration:underline;
1.693     droeschl 7301: }
1.763     bisitz   7302: 
                   7303: .LC_help_open_topic {
1.911     bisitz   7304:   color: #FFFFFF;
                   7305:   background-color: #EEEEFF;
                   7306:   margin: 1px;
                   7307:   padding: 4px;
                   7308:   border: 1px solid #000033;
                   7309:   white-space: nowrap;
                   7310:   /* vertical-align: middle; */
1.759     neumanie 7311: }
1.693     droeschl 7312: 
1.911     bisitz   7313: dl,
                   7314: ul,
                   7315: div,
                   7316: fieldset {
                   7317:   margin: 10px 10px 10px 0;
                   7318:   /* overflow: hidden; */
1.693     droeschl 7319: }
1.795     www      7320: 
1.1075.2.90  raeburn  7321: article.geogebraweb div {
                   7322:     margin: 0;
                   7323: }
                   7324: 
1.838     bisitz   7325: fieldset > legend {
1.911     bisitz   7326:   font-weight: bold;
                   7327:   padding: 0 5px 0 5px;
1.838     bisitz   7328: }
                   7329: 
1.813     bisitz   7330: #LC_nav_bar {
1.911     bisitz   7331:   float: left;
1.995     raeburn  7332:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   7333:   margin: 0 0 2px 0;
1.807     droeschl 7334: }
                   7335: 
1.916     droeschl 7336: #LC_realm {
                   7337:   margin: 0.2em 0 0 0;
                   7338:   padding: 0;
                   7339:   font-weight: bold;
                   7340:   text-align: center;
1.995     raeburn  7341:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 7342: }
                   7343: 
1.911     bisitz   7344: #LC_nav_bar em {
                   7345:   font-weight: bold;
                   7346:   font-style: normal;
1.807     droeschl 7347: }
                   7348: 
1.897     wenzelju 7349: ol.LC_primary_menu {
1.934     droeschl 7350:   margin: 0;
1.1075.2.2  raeburn  7351:   padding: 0;
1.807     droeschl 7352: }
                   7353: 
1.852     droeschl 7354: ol#LC_PathBreadcrumbs {
1.911     bisitz   7355:   margin: 0;
1.693     droeschl 7356: }
                   7357: 
1.897     wenzelju 7358: ol.LC_primary_menu li {
1.1075.2.2  raeburn  7359:   color: RGB(80, 80, 80);
                   7360:   vertical-align: middle;
                   7361:   text-align: left;
                   7362:   list-style: none;
1.1075.2.112  raeburn  7363:   position: relative;
1.1075.2.2  raeburn  7364:   float: left;
1.1075.2.112  raeburn  7365:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   7366:   line-height: 1.5em;
1.1075.2.2  raeburn  7367: }
                   7368: 
1.1075.2.113  raeburn  7369: ol.LC_primary_menu li a, 
1.1075.2.112  raeburn  7370: ol.LC_primary_menu li p {
1.1075.2.2  raeburn  7371:   display: block;
                   7372:   margin: 0;
                   7373:   padding: 0 5px 0 10px;
                   7374:   text-decoration: none;
                   7375: }
                   7376: 
1.1075.2.112  raeburn  7377: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   7378:   display: inline-block;
                   7379:   width: 95%;
                   7380:   text-align: left;
                   7381: }
                   7382: 
                   7383: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   7384:   display: inline-block;
                   7385:   width: 5%;
                   7386:   float: right;
                   7387:   text-align: right;
                   7388:   font-size: 70%;
                   7389: }
                   7390: 
                   7391: ol.LC_primary_menu ul {
1.1075.2.2  raeburn  7392:   display: none;
1.1075.2.112  raeburn  7393:   width: 15em;
1.1075.2.2  raeburn  7394:   background-color: $data_table_light;
1.1075.2.112  raeburn  7395:   position: absolute;
                   7396:   top: 100%;
                   7397: }
                   7398: 
                   7399: ol.LC_primary_menu ul ul {
                   7400:   left: 100%;
                   7401:   top: 0;
1.1075.2.2  raeburn  7402: }
                   7403: 
1.1075.2.112  raeburn  7404: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1075.2.2  raeburn  7405:   display: block;
                   7406:   position: absolute;
                   7407:   margin: 0;
                   7408:   padding: 0;
1.1075.2.5  raeburn  7409:   z-index: 2;
1.1075.2.2  raeburn  7410: }
                   7411: 
                   7412: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1075.2.112  raeburn  7413: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1075.2.2  raeburn  7414:   font-size: 90%;
1.911     bisitz   7415:   vertical-align: top;
1.1075.2.2  raeburn  7416:   float: none;
1.1075.2.5  raeburn  7417:   border-left: 1px solid black;
                   7418:   border-right: 1px solid black;
1.1075.2.112  raeburn  7419: /* A dark bottom border to visualize different menu options;
                   7420: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   7421:   border-bottom: 1px solid $data_table_dark;
1.1075.2.2  raeburn  7422: }
                   7423: 
1.1075.2.112  raeburn  7424: ol.LC_primary_menu li li p:hover {
                   7425:   color:$button_hover;
                   7426:   text-decoration:none;
                   7427:   background-color:$data_table_dark;
1.1075.2.2  raeburn  7428: }
                   7429: 
                   7430: ol.LC_primary_menu li li a:hover {
                   7431:    color:$button_hover;
                   7432:    background-color:$data_table_dark;
1.693     droeschl 7433: }
                   7434: 
1.1075.2.112  raeburn  7435: /* Font-size equal to the size of the predecessors*/
                   7436: ol.LC_primary_menu li:hover li li {
                   7437:   font-size: 100%;
                   7438: }
                   7439: 
1.897     wenzelju 7440: ol.LC_primary_menu li img {
1.911     bisitz   7441:   vertical-align: bottom;
1.934     droeschl 7442:   height: 1.1em;
1.1075.2.3  raeburn  7443:   margin: 0.2em 0 0 0;
1.693     droeschl 7444: }
                   7445: 
1.897     wenzelju 7446: ol.LC_primary_menu a {
1.911     bisitz   7447:   color: RGB(80, 80, 80);
                   7448:   text-decoration: none;
1.693     droeschl 7449: }
1.795     www      7450: 
1.949     droeschl 7451: ol.LC_primary_menu a.LC_new_message {
                   7452:   font-weight:bold;
                   7453:   color: darkred;
                   7454: }
                   7455: 
1.975     raeburn  7456: ol.LC_docs_parameters {
                   7457:   margin-left: 0;
                   7458:   padding: 0;
                   7459:   list-style: none;
                   7460: }
                   7461: 
                   7462: ol.LC_docs_parameters li {
                   7463:   margin: 0;
                   7464:   padding-right: 20px;
                   7465:   display: inline;
                   7466: }
                   7467: 
1.976     raeburn  7468: ol.LC_docs_parameters li:before {
                   7469:   content: "\\002022 \\0020";
                   7470: }
                   7471: 
                   7472: li.LC_docs_parameters_title {
                   7473:   font-weight: bold;
                   7474: }
                   7475: 
                   7476: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   7477:   content: "";
                   7478: }
                   7479: 
1.897     wenzelju 7480: ul#LC_secondary_menu {
1.1075.2.23  raeburn  7481:   clear: right;
1.911     bisitz   7482:   color: $fontmenu;
                   7483:   background: $tabbg;
                   7484:   list-style: none;
                   7485:   padding: 0;
                   7486:   margin: 0;
                   7487:   width: 100%;
1.995     raeburn  7488:   text-align: left;
1.1075.2.4  raeburn  7489:   float: left;
1.808     droeschl 7490: }
                   7491: 
1.897     wenzelju 7492: ul#LC_secondary_menu li {
1.911     bisitz   7493:   font-weight: bold;
                   7494:   line-height: 1.8em;
                   7495:   border-right: 1px solid black;
1.1075.2.4  raeburn  7496:   float: left;
                   7497: }
                   7498: 
                   7499: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   7500:   background-color: $data_table_light;
                   7501: }
                   7502: 
                   7503: ul#LC_secondary_menu li a {
                   7504:   padding: 0 0.8em;
                   7505: }
                   7506: 
                   7507: ul#LC_secondary_menu li ul {
                   7508:   display: none;
                   7509: }
                   7510: 
                   7511: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   7512:   display: block;
                   7513:   position: absolute;
                   7514:   margin: 0;
                   7515:   padding: 0;
                   7516:   list-style:none;
                   7517:   float: none;
                   7518:   background-color: $data_table_light;
1.1075.2.5  raeburn  7519:   z-index: 2;
1.1075.2.10  raeburn  7520:   margin-left: -1px;
1.1075.2.4  raeburn  7521: }
                   7522: 
                   7523: ul#LC_secondary_menu li ul li {
                   7524:   font-size: 90%;
                   7525:   vertical-align: top;
                   7526:   border-left: 1px solid black;
                   7527:   border-right: 1px solid black;
1.1075.2.33  raeburn  7528:   background-color: $data_table_light;
1.1075.2.4  raeburn  7529:   list-style:none;
                   7530:   float: none;
                   7531: }
                   7532: 
                   7533: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   7534:   background-color: $data_table_dark;
1.807     droeschl 7535: }
                   7536: 
1.847     tempelho 7537: ul.LC_TabContent {
1.911     bisitz   7538:   display:block;
                   7539:   background: $sidebg;
                   7540:   border-bottom: solid 1px $lg_border_color;
                   7541:   list-style:none;
1.1020    raeburn  7542:   margin: -1px -10px 0 -10px;
1.911     bisitz   7543:   padding: 0;
1.693     droeschl 7544: }
                   7545: 
1.795     www      7546: ul.LC_TabContent li,
                   7547: ul.LC_TabContentBigger li {
1.911     bisitz   7548:   float:left;
1.741     harmsja  7549: }
1.795     www      7550: 
1.897     wenzelju 7551: ul#LC_secondary_menu li a {
1.911     bisitz   7552:   color: $fontmenu;
                   7553:   text-decoration: none;
1.693     droeschl 7554: }
1.795     www      7555: 
1.721     harmsja  7556: ul.LC_TabContent {
1.952     onken    7557:   min-height:20px;
1.721     harmsja  7558: }
1.795     www      7559: 
                   7560: ul.LC_TabContent li {
1.911     bisitz   7561:   vertical-align:middle;
1.959     onken    7562:   padding: 0 16px 0 10px;
1.911     bisitz   7563:   background-color:$tabbg;
                   7564:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  7565:   border-left: solid 1px $font;
1.721     harmsja  7566: }
1.795     www      7567: 
1.847     tempelho 7568: ul.LC_TabContent .right {
1.911     bisitz   7569:   float:right;
1.847     tempelho 7570: }
                   7571: 
1.911     bisitz   7572: ul.LC_TabContent li a,
                   7573: ul.LC_TabContent li {
                   7574:   color:rgb(47,47,47);
                   7575:   text-decoration:none;
                   7576:   font-size:95%;
                   7577:   font-weight:bold;
1.952     onken    7578:   min-height:20px;
                   7579: }
                   7580: 
1.959     onken    7581: ul.LC_TabContent li a:hover,
                   7582: ul.LC_TabContent li a:focus {
1.952     onken    7583:   color: $button_hover;
1.959     onken    7584:   background:none;
                   7585:   outline:none;
1.952     onken    7586: }
                   7587: 
                   7588: ul.LC_TabContent li:hover {
                   7589:   color: $button_hover;
                   7590:   cursor:pointer;
1.721     harmsja  7591: }
1.795     www      7592: 
1.911     bisitz   7593: ul.LC_TabContent li.active {
1.952     onken    7594:   color: $font;
1.911     bisitz   7595:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    7596:   border-bottom:solid 1px #FFFFFF;
                   7597:   cursor: default;
1.744     ehlerst  7598: }
1.795     www      7599: 
1.959     onken    7600: ul.LC_TabContent li.active a {
                   7601:   color:$font;
                   7602:   background:#FFFFFF;
                   7603:   outline: none;
                   7604: }
1.1047    raeburn  7605: 
                   7606: ul.LC_TabContent li.goback {
                   7607:   float: left;
                   7608:   border-left: none;
                   7609: }
                   7610: 
1.870     tempelho 7611: #maincoursedoc {
1.911     bisitz   7612:   clear:both;
1.870     tempelho 7613: }
                   7614: 
                   7615: ul.LC_TabContentBigger {
1.911     bisitz   7616:   display:block;
                   7617:   list-style:none;
                   7618:   padding: 0;
1.870     tempelho 7619: }
                   7620: 
1.795     www      7621: ul.LC_TabContentBigger li {
1.911     bisitz   7622:   vertical-align:bottom;
                   7623:   height: 30px;
                   7624:   font-size:110%;
                   7625:   font-weight:bold;
                   7626:   color: #737373;
1.841     tempelho 7627: }
                   7628: 
1.957     onken    7629: ul.LC_TabContentBigger li.active {
                   7630:   position: relative;
                   7631:   top: 1px;
                   7632: }
                   7633: 
1.870     tempelho 7634: ul.LC_TabContentBigger li a {
1.911     bisitz   7635:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   7636:   height: 30px;
                   7637:   line-height: 30px;
                   7638:   text-align: center;
                   7639:   display: block;
                   7640:   text-decoration: none;
1.958     onken    7641:   outline: none;  
1.741     harmsja  7642: }
1.795     www      7643: 
1.870     tempelho 7644: ul.LC_TabContentBigger li.active a {
1.911     bisitz   7645:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   7646:   color:$font;
1.744     ehlerst  7647: }
1.795     www      7648: 
1.870     tempelho 7649: ul.LC_TabContentBigger li b {
1.911     bisitz   7650:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   7651:   display: block;
                   7652:   float: left;
                   7653:   padding: 0 30px;
1.957     onken    7654:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 7655: }
                   7656: 
1.956     onken    7657: ul.LC_TabContentBigger li:hover b {
                   7658:   color:$button_hover;
                   7659: }
                   7660: 
1.870     tempelho 7661: ul.LC_TabContentBigger li.active b {
1.911     bisitz   7662:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   7663:   color:$font;
1.957     onken    7664:   border: 0;
1.741     harmsja  7665: }
1.693     droeschl 7666: 
1.870     tempelho 7667: 
1.862     bisitz   7668: ul.LC_CourseBreadcrumbs {
                   7669:   background: $sidebg;
1.1020    raeburn  7670:   height: 2em;
1.862     bisitz   7671:   padding-left: 10px;
1.1020    raeburn  7672:   margin: 0;
1.862     bisitz   7673:   list-style-position: inside;
                   7674: }
                   7675: 
1.911     bisitz   7676: ol#LC_MenuBreadcrumbs,
1.862     bisitz   7677: ol#LC_PathBreadcrumbs {
1.911     bisitz   7678:   padding-left: 10px;
                   7679:   margin: 0;
1.933     droeschl 7680:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 7681: }
                   7682: 
1.911     bisitz   7683: ol#LC_MenuBreadcrumbs li,
                   7684: ol#LC_PathBreadcrumbs li,
1.862     bisitz   7685: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   7686:   display: inline;
1.933     droeschl 7687:   white-space: normal;  
1.693     droeschl 7688: }
                   7689: 
1.823     bisitz   7690: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   7691: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   7692:   text-decoration: none;
                   7693:   font-size:90%;
1.693     droeschl 7694: }
1.795     www      7695: 
1.969     droeschl 7696: ol#LC_MenuBreadcrumbs h1 {
                   7697:   display: inline;
                   7698:   font-size: 90%;
                   7699:   line-height: 2.5em;
                   7700:   margin: 0;
                   7701:   padding: 0;
                   7702: }
                   7703: 
1.795     www      7704: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   7705:   text-decoration:none;
                   7706:   font-size:100%;
                   7707:   font-weight:bold;
1.693     droeschl 7708: }
1.795     www      7709: 
1.840     bisitz   7710: .LC_Box {
1.911     bisitz   7711:   border: solid 1px $lg_border_color;
                   7712:   padding: 0 10px 10px 10px;
1.746     neumanie 7713: }
1.795     www      7714: 
1.1020    raeburn  7715: .LC_DocsBox {
                   7716:   border: solid 1px $lg_border_color;
                   7717:   padding: 0 0 10px 10px;
                   7718: }
                   7719: 
1.795     www      7720: .LC_AboutMe_Image {
1.911     bisitz   7721:   float:left;
                   7722:   margin-right:10px;
1.747     neumanie 7723: }
1.795     www      7724: 
                   7725: .LC_Clear_AboutMe_Image {
1.911     bisitz   7726:   clear:left;
1.747     neumanie 7727: }
1.795     www      7728: 
1.721     harmsja  7729: dl.LC_ListStyleClean dt {
1.911     bisitz   7730:   padding-right: 5px;
                   7731:   display: table-header-group;
1.693     droeschl 7732: }
                   7733: 
1.721     harmsja  7734: dl.LC_ListStyleClean dd {
1.911     bisitz   7735:   display: table-row;
1.693     droeschl 7736: }
                   7737: 
1.721     harmsja  7738: .LC_ListStyleClean,
                   7739: .LC_ListStyleSimple,
                   7740: .LC_ListStyleNormal,
1.795     www      7741: .LC_ListStyleSpecial {
1.911     bisitz   7742:   /* display:block; */
                   7743:   list-style-position: inside;
                   7744:   list-style-type: none;
                   7745:   overflow: hidden;
                   7746:   padding: 0;
1.693     droeschl 7747: }
                   7748: 
1.721     harmsja  7749: .LC_ListStyleSimple li,
                   7750: .LC_ListStyleSimple dd,
                   7751: .LC_ListStyleNormal li,
                   7752: .LC_ListStyleNormal dd,
                   7753: .LC_ListStyleSpecial li,
1.795     www      7754: .LC_ListStyleSpecial dd {
1.911     bisitz   7755:   margin: 0;
                   7756:   padding: 5px 5px 5px 10px;
                   7757:   clear: both;
1.693     droeschl 7758: }
                   7759: 
1.721     harmsja  7760: .LC_ListStyleClean li,
                   7761: .LC_ListStyleClean dd {
1.911     bisitz   7762:   padding-top: 0;
                   7763:   padding-bottom: 0;
1.693     droeschl 7764: }
                   7765: 
1.721     harmsja  7766: .LC_ListStyleSimple dd,
1.795     www      7767: .LC_ListStyleSimple li {
1.911     bisitz   7768:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 7769: }
                   7770: 
1.721     harmsja  7771: .LC_ListStyleSpecial li,
                   7772: .LC_ListStyleSpecial dd {
1.911     bisitz   7773:   list-style-type: none;
                   7774:   background-color: RGB(220, 220, 220);
                   7775:   margin-bottom: 4px;
1.693     droeschl 7776: }
                   7777: 
1.721     harmsja  7778: table.LC_SimpleTable {
1.911     bisitz   7779:   margin:5px;
                   7780:   border:solid 1px $lg_border_color;
1.795     www      7781: }
1.693     droeschl 7782: 
1.721     harmsja  7783: table.LC_SimpleTable tr {
1.911     bisitz   7784:   padding: 0;
                   7785:   border:solid 1px $lg_border_color;
1.693     droeschl 7786: }
1.795     www      7787: 
                   7788: table.LC_SimpleTable thead {
1.911     bisitz   7789:   background:rgb(220,220,220);
1.693     droeschl 7790: }
                   7791: 
1.721     harmsja  7792: div.LC_columnSection {
1.911     bisitz   7793:   display: block;
                   7794:   clear: both;
                   7795:   overflow: hidden;
                   7796:   margin: 0;
1.693     droeschl 7797: }
                   7798: 
1.721     harmsja  7799: div.LC_columnSection>* {
1.911     bisitz   7800:   float: left;
                   7801:   margin: 10px 20px 10px 0;
                   7802:   overflow:hidden;
1.693     droeschl 7803: }
1.721     harmsja  7804: 
1.795     www      7805: table em {
1.911     bisitz   7806:   font-weight: bold;
                   7807:   font-style: normal;
1.748     schulted 7808: }
1.795     www      7809: 
1.779     bisitz   7810: table.LC_tableBrowseRes,
1.795     www      7811: table.LC_tableOfContent {
1.911     bisitz   7812:   border:none;
                   7813:   border-spacing: 1px;
                   7814:   padding: 3px;
                   7815:   background-color: #FFFFFF;
                   7816:   font-size: 90%;
1.753     droeschl 7817: }
1.789     droeschl 7818: 
1.911     bisitz   7819: table.LC_tableOfContent {
                   7820:   border-collapse: collapse;
1.789     droeschl 7821: }
                   7822: 
1.771     droeschl 7823: table.LC_tableBrowseRes a,
1.768     schulted 7824: table.LC_tableOfContent a {
1.911     bisitz   7825:   background-color: transparent;
                   7826:   text-decoration: none;
1.753     droeschl 7827: }
                   7828: 
1.795     www      7829: table.LC_tableOfContent img {
1.911     bisitz   7830:   border: none;
                   7831:   height: 1.3em;
                   7832:   vertical-align: text-bottom;
                   7833:   margin-right: 0.3em;
1.753     droeschl 7834: }
1.757     schulted 7835: 
1.795     www      7836: a#LC_content_toolbar_firsthomework {
1.911     bisitz   7837:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  7838: }
                   7839: 
1.795     www      7840: a#LC_content_toolbar_everything {
1.911     bisitz   7841:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  7842: }
                   7843: 
1.795     www      7844: a#LC_content_toolbar_uncompleted {
1.911     bisitz   7845:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  7846: }
                   7847: 
1.795     www      7848: #LC_content_toolbar_clearbubbles {
1.911     bisitz   7849:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  7850: }
                   7851: 
1.795     www      7852: a#LC_content_toolbar_changefolder {
1.911     bisitz   7853:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 7854: }
                   7855: 
1.795     www      7856: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   7857:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 7858: }
                   7859: 
1.1043    raeburn  7860: a#LC_content_toolbar_edittoplevel {
                   7861:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   7862: }
                   7863: 
1.795     www      7864: ul#LC_toolbar li a:hover {
1.911     bisitz   7865:   background-position: bottom center;
1.757     schulted 7866: }
                   7867: 
1.795     www      7868: ul#LC_toolbar {
1.911     bisitz   7869:   padding: 0;
                   7870:   margin: 2px;
                   7871:   list-style:none;
                   7872:   position:relative;
                   7873:   background-color:white;
1.1075.2.9  raeburn  7874:   overflow: auto;
1.757     schulted 7875: }
                   7876: 
1.795     www      7877: ul#LC_toolbar li {
1.911     bisitz   7878:   border:1px solid white;
                   7879:   padding: 0;
                   7880:   margin: 0;
                   7881:   float: left;
                   7882:   display:inline;
                   7883:   vertical-align:middle;
1.1075.2.9  raeburn  7884:   white-space: nowrap;
1.911     bisitz   7885: }
1.757     schulted 7886: 
1.783     amueller 7887: 
1.795     www      7888: a.LC_toolbarItem {
1.911     bisitz   7889:   display:block;
                   7890:   padding: 0;
                   7891:   margin: 0;
                   7892:   height: 32px;
                   7893:   width: 32px;
                   7894:   color:white;
                   7895:   border: none;
                   7896:   background-repeat:no-repeat;
                   7897:   background-color:transparent;
1.757     schulted 7898: }
                   7899: 
1.915     droeschl 7900: ul.LC_funclist {
                   7901:     margin: 0;
                   7902:     padding: 0.5em 1em 0.5em 0;
                   7903: }
                   7904: 
1.933     droeschl 7905: ul.LC_funclist > li:first-child {
                   7906:     font-weight:bold; 
                   7907:     margin-left:0.8em;
                   7908: }
                   7909: 
1.915     droeschl 7910: ul.LC_funclist + ul.LC_funclist {
                   7911:     /* 
                   7912:        left border as a seperator if we have more than
                   7913:        one list 
                   7914:     */
                   7915:     border-left: 1px solid $sidebg;
                   7916:     /* 
                   7917:        this hides the left border behind the border of the 
                   7918:        outer box if element is wrapped to the next 'line' 
                   7919:     */
                   7920:     margin-left: -1px;
                   7921: }
                   7922: 
1.843     bisitz   7923: ul.LC_funclist li {
1.915     droeschl 7924:   display: inline;
1.782     bisitz   7925:   white-space: nowrap;
1.915     droeschl 7926:   margin: 0 0 0 25px;
                   7927:   line-height: 150%;
1.782     bisitz   7928: }
                   7929: 
1.974     wenzelju 7930: .LC_hidden {
                   7931:   display: none;
                   7932: }
                   7933: 
1.1030    www      7934: .LCmodal-overlay {
                   7935: 		position:fixed;
                   7936: 		top:0;
                   7937: 		right:0;
                   7938: 		bottom:0;
                   7939: 		left:0;
                   7940: 		height:100%;
                   7941: 		width:100%;
                   7942: 		margin:0;
                   7943: 		padding:0;
                   7944: 		background:#999;
                   7945: 		opacity:.75;
                   7946: 		filter: alpha(opacity=75);
                   7947: 		-moz-opacity: 0.75;
                   7948: 		z-index:101;
                   7949: }
                   7950: 
                   7951: * html .LCmodal-overlay {   
                   7952: 		position: absolute;
                   7953: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   7954: }
                   7955: 
                   7956: .LCmodal-window {
                   7957: 		position:fixed;
                   7958: 		top:50%;
                   7959: 		left:50%;
                   7960: 		margin:0;
                   7961: 		padding:0;
                   7962: 		z-index:102;
                   7963: 	}
                   7964: 
                   7965: * html .LCmodal-window {
                   7966: 		position:absolute;
                   7967: }
                   7968: 
                   7969: .LCclose-window {
                   7970: 		position:absolute;
                   7971: 		width:32px;
                   7972: 		height:32px;
                   7973: 		right:8px;
                   7974: 		top:8px;
                   7975: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   7976: 		text-indent:-99999px;
                   7977: 		overflow:hidden;
                   7978: 		cursor:pointer;
                   7979: }
                   7980: 
1.1075.2.158  raeburn  7981: .LCisDisabled {
                   7982:   cursor: not-allowed;
                   7983:   opacity: 0.5;
                   7984: }
                   7985: 
                   7986: a[aria-disabled="true"] {
                   7987:   color: currentColor;
                   7988:   display: inline-block;  /* For IE11/ MS Edge bug */
                   7989:   pointer-events: none;
                   7990:   text-decoration: none;
                   7991: }
                   7992: 
1.1075.2.141  raeburn  7993: pre.LC_wordwrap {
                   7994:   white-space: pre-wrap;
                   7995:   white-space: -moz-pre-wrap;
                   7996:   white-space: -pre-wrap;
                   7997:   white-space: -o-pre-wrap;
                   7998:   word-wrap: break-word;
                   7999: }
                   8000: 
1.1075.2.17  raeburn  8001: /*
                   8002:   styles used by TTH when "Default set of options to pass to tth/m
                   8003:   when converting TeX" in course settings has been set
                   8004: 
                   8005:   option passed: -t
                   8006: 
                   8007: */
                   8008: 
                   8009: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   8010: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   8011: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   8012: td div.norm {line-height:normal;}
                   8013: 
                   8014: /*
                   8015:   option passed -y3
                   8016: */
                   8017: 
                   8018: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   8019: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   8020: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   8021: 
1.1075.2.121  raeburn  8022: #LC_minitab_header {
                   8023:   float:left;
                   8024:   width:100%;
                   8025:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   8026:   font-size:93%;
                   8027:   line-height:normal;
                   8028:   margin: 0.5em 0 0.5em 0;
                   8029: }
                   8030: #LC_minitab_header ul {
                   8031:   margin:0;
                   8032:   padding:10px 10px 0;
                   8033:   list-style:none;
                   8034: }
                   8035: #LC_minitab_header li {
                   8036:   float:left;
                   8037:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   8038:   margin:0;
                   8039:   padding:0 0 0 9px;
                   8040: }
                   8041: #LC_minitab_header a {
                   8042:   display:block;
                   8043:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   8044:   padding:5px 15px 4px 6px;
                   8045: }
                   8046: #LC_minitab_header #LC_current_minitab {
                   8047:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   8048: }
                   8049: #LC_minitab_header #LC_current_minitab a {
                   8050:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   8051:   padding-bottom:5px;
                   8052: }
                   8053: 
                   8054: 
1.343     albertel 8055: END
                   8056: }
                   8057: 
1.306     albertel 8058: =pod
                   8059: 
                   8060: =item * &headtag()
                   8061: 
                   8062: Returns a uniform footer for LON-CAPA web pages.
                   8063: 
1.307     albertel 8064: Inputs: $title - optional title for the head
                   8065:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 8066:         $args - optional arguments
1.319     albertel 8067:             force_register - if is true call registerurl so the remote is 
                   8068:                              informed
1.415     albertel 8069:             redirect       -> array ref of
                   8070:                                    1- seconds before redirect occurs
                   8071:                                    2- url to redirect to
                   8072:                                    3- whether the side effect should occur
1.315     albertel 8073:                            (side effect of setting 
                   8074:                                $env{'internal.head.redirect'} to the url 
                   8075:                                redirected too)
1.1075.2.166  raeburn  8076:                                    4- whether encrypt check should be skipped
1.352     albertel 8077:             domain         -> force to color decorate a page for a specific
                   8078:                                domain
                   8079:             function       -> force usage of a specific rolish color scheme
                   8080:             bgcolor        -> override the default page bgcolor
1.460     albertel 8081:             no_auto_mt_title
                   8082:                            -> prevent &mt()ing the title arg
1.464     albertel 8083: 
1.306     albertel 8084: =cut
                   8085: 
                   8086: sub headtag {
1.313     albertel 8087:     my ($title,$head_extra,$args) = @_;
1.306     albertel 8088:     
1.363     albertel 8089:     my $function = $args->{'function'} || &get_users_function();
                   8090:     my $domain   = $args->{'domain'}   || &determinedomain();
                   8091:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1075.2.52  raeburn  8092:     my $httphost = $args->{'use_absolute'};
1.418     albertel 8093:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 8094: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 8095: 		   #time(),
1.418     albertel 8096: 		   $env{'environment.color.timestamp'},
1.363     albertel 8097: 		   $function,$domain,$bgcolor);
                   8098: 
1.369     www      8099:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 8100: 
1.308     albertel 8101:     my $result =
                   8102: 	'<head>'.
1.1075.2.56  raeburn  8103: 	&font_settings($args);
1.319     albertel 8104: 
1.1075.2.72  raeburn  8105:     my $inhibitprint;
                   8106:     if ($args->{'print_suppress'}) {
                   8107:         $inhibitprint = &print_suppression();
                   8108:     }
1.1064    raeburn  8109: 
1.461     albertel 8110:     if (!$args->{'frameset'}) {
                   8111: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   8112:     }
1.1075.2.12  raeburn  8113:     if ($args->{'force_register'}) {
                   8114:         $result .= &Apache::lonmenu::registerurl(1);
1.319     albertel 8115:     }
1.436     albertel 8116:     if (!$args->{'no_nav_bar'} 
                   8117: 	&& !$args->{'only_body'}
                   8118: 	&& !$args->{'frameset'}) {
1.1075.2.52  raeburn  8119: 	$result .= &help_menu_js($httphost);
1.1032    www      8120:         $result.=&modal_window();
1.1038    www      8121:         $result.=&togglebox_script();
1.1034    www      8122:         $result.=&wishlist_window();
1.1041    www      8123:         $result.=&LCprogressbarUpdate_script();
1.1034    www      8124:     } else {
                   8125:         if ($args->{'add_modal'}) {
                   8126:            $result.=&modal_window();
                   8127:         }
                   8128:         if ($args->{'add_wishlist'}) {
                   8129:            $result.=&wishlist_window();
                   8130:         }
1.1038    www      8131:         if ($args->{'add_togglebox'}) {
                   8132:            $result.=&togglebox_script();
                   8133:         }
1.1041    www      8134:         if ($args->{'add_progressbar'}) {
                   8135:            $result.=&LCprogressbarUpdate_script();
                   8136:         }
1.436     albertel 8137:     }
1.314     albertel 8138:     if (ref($args->{'redirect'})) {
1.1075.2.166  raeburn  8139: 	my ($time,$url,$inhibit_continue,$skip_enc_check) = @{$args->{'redirect'}};
                   8140:         if (!$skip_enc_check) {
                   8141:             $url = &Apache::lonenc::check_encrypt($url);
                   8142:         }
1.414     albertel 8143: 	if (!$inhibit_continue) {
                   8144: 	    $env{'internal.head.redirect'} = $url;
                   8145: 	}
1.313     albertel 8146: 	$result.=<<ADDMETA
                   8147: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 8148: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 8149: ADDMETA
1.1075.2.89  raeburn  8150:     } else {
                   8151:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   8152:             my $requrl = $env{'request.uri'};
                   8153:             if ($requrl eq '') {
                   8154:                 $requrl = $ENV{'REQUEST_URI'};
                   8155:                 $requrl =~ s/\?.+$//;
                   8156:             }
                   8157:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   8158:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   8159:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   8160:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   8161:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   8162:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1075.2.145  raeburn  8163:                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1075.2.151  raeburn  8164:                     my ($offload,$offloadoth);
1.1075.2.89  raeburn  8165:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   8166:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1075.2.145  raeburn  8167:                             $offload = 1;
1.1075.2.151  raeburn  8168:                             if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8169:                                 (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8170:                                 unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8171:                                     $offloadoth = 1;
                   8172:                                     $dom_in_use = $env{'user.domain'};
                   8173:                                 }
                   8174:                             }
1.1075.2.145  raeburn  8175:                         }
                   8176:                     }
                   8177:                     unless ($offload) {
                   8178:                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   8179:                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   8180:                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   8181:                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   8182:                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   8183:                                         $offload = 1;
1.1075.2.151  raeburn  8184:                                         $offloadoth = 1;
1.1075.2.145  raeburn  8185:                                         $dom_in_use = $env{'user.domain'};
                   8186:                                     }
1.1075.2.89  raeburn  8187:                                 }
1.1075.2.145  raeburn  8188:                             }
                   8189:                         }
                   8190:                     }
                   8191:                     if ($offload) {
1.1075.2.158  raeburn  8192:                         my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1075.2.151  raeburn  8193:                         if (($newserver eq '') && ($offloadoth)) {
                   8194:                             my @domains = &Apache::lonnet::current_machine_domains();
                   8195:                             if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) { 
                   8196:                                 ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
                   8197:                             }
                   8198:                         }
1.1075.2.145  raeburn  8199:                         if (($newserver) && ($newserver ne $lonhost)) {
                   8200:                             my $numsec = 5;
                   8201:                             my $timeout = $numsec * 1000;
                   8202:                             my ($newurl,$locknum,%locks,$msg);
                   8203:                             if ($env{'request.role.adv'}) {
                   8204:                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   8205:                             }
                   8206:                             my $disable_submit = 0;
                   8207:                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   8208:                                 $disable_submit = 1;
                   8209:                             }
                   8210:                             if ($locknum) {
                   8211:                                 my @lockinfo = sort(values(%locks));
1.1075.2.153  raeburn  8212:                                 $msg = &mt('Once the following tasks are complete:')." \n".
1.1075.2.145  raeburn  8213:                                        join(", ",sort(values(%locks)))."\n";
                   8214:                                 if (&show_course()) {
                   8215:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
1.1075.2.89  raeburn  8216:                                 } else {
1.1075.2.145  raeburn  8217:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
                   8218:                                 }
                   8219:                             } else {
                   8220:                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   8221:                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   8222:                                 }
                   8223:                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   8224:                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   8225:                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   8226:                                     $newurl .= '&role='.$env{'request.role'};
                   8227:                                 }
                   8228:                                 if ($env{'request.symb'}) {
                   8229:                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   8230:                                     if ($shownsymb =~ m{^/enc/}) {
                   8231:                                         my $reqdmajor = 2;
                   8232:                                         my $reqdminor = 11;
                   8233:                                         my $reqdsubminor = 3;
                   8234:                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   8235:                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   8236:                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   8237:                                         if (($major eq '' && $minor eq '') ||
                   8238:                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   8239:                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   8240:                                              ($reqdsubminor > $subminor))))) {
                   8241:                                             undef($shownsymb);
                   8242:                                         }
1.1075.2.89  raeburn  8243:                                     }
1.1075.2.145  raeburn  8244:                                     if ($shownsymb) {
                   8245:                                         &js_escape(\$shownsymb);
                   8246:                                         $newurl .= '&symb='.$shownsymb;
1.1075.2.89  raeburn  8247:                                     }
1.1075.2.145  raeburn  8248:                                 } else {
                   8249:                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   8250:                                     &js_escape(\$shownurl);
                   8251:                                     $newurl .= '&origurl='.$shownurl;
1.1075.2.89  raeburn  8252:                                 }
1.1075.2.145  raeburn  8253:                             }
                   8254:                             &js_escape(\$msg);
                   8255:                             $result.=<<OFFLOAD
1.1075.2.89  raeburn  8256: <meta http-equiv="pragma" content="no-cache" />
                   8257: <script type="text/javascript">
1.1075.2.92  raeburn  8258: // <![CDATA[
1.1075.2.89  raeburn  8259: function LC_Offload_Now() {
                   8260:     var dest = "$newurl";
                   8261:     if (dest != '') {
                   8262:         window.location.href="$newurl";
                   8263:     }
                   8264: }
1.1075.2.92  raeburn  8265: \$(document).ready(function () {
                   8266:     window.alert('$msg');
                   8267:     if ($disable_submit) {
1.1075.2.89  raeburn  8268:         \$(".LC_hwk_submit").prop("disabled", true);
                   8269:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1075.2.92  raeburn  8270:     }
                   8271:     setTimeout('LC_Offload_Now()', $timeout);
                   8272: });
                   8273: // ]]>
1.1075.2.89  raeburn  8274: </script>
                   8275: OFFLOAD
                   8276:                         }
                   8277:                     }
                   8278:                 }
                   8279:             }
                   8280:         }
1.313     albertel 8281:     }
1.306     albertel 8282:     if (!defined($title)) {
                   8283: 	$title = 'The LearningOnline Network with CAPA';
                   8284:     }
1.460     albertel 8285:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   8286:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.1075.2.61  raeburn  8287: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'"';
                   8288:     if (!$args->{'frameset'}) {
                   8289:         $result .= ' /';
                   8290:     }
                   8291:     $result .= '>'
1.1064    raeburn  8292:         .$inhibitprint
1.414     albertel 8293: 	.$head_extra;
1.1075.2.108  raeburn  8294:     my $clientmobile;
                   8295:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   8296:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   8297:     } else {
                   8298:         $clientmobile = $env{'browser.mobile'};
                   8299:     }
                   8300:     if ($clientmobile) {
1.1075.2.42  raeburn  8301:         $result .= '
                   8302: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   8303: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   8304:     }
1.1075.2.126  raeburn  8305:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 8306:     return $result.'</head>';
1.306     albertel 8307: }
                   8308: 
                   8309: =pod
                   8310: 
1.340     albertel 8311: =item * &font_settings()
                   8312: 
                   8313: Returns neccessary <meta> to set the proper encoding
                   8314: 
1.1075.2.56  raeburn  8315: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 8316: 
                   8317: =cut
                   8318: 
                   8319: sub font_settings {
1.1075.2.56  raeburn  8320:     my ($args) = @_;
1.340     albertel 8321:     my $headerstring='';
1.1075.2.56  raeburn  8322:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   8323:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.340     albertel 8324: 	$headerstring.=
1.1075.2.61  raeburn  8325: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   8326:         if (!$args->{'frameset'}) {
                   8327:             $headerstring.= ' /';
                   8328:         }
                   8329:         $headerstring .= '>'."\n";
1.340     albertel 8330:     }
                   8331:     return $headerstring;
                   8332: }
                   8333: 
1.341     albertel 8334: =pod
                   8335: 
1.1064    raeburn  8336: =item * &print_suppression()
                   8337: 
                   8338: In course context returns css which causes the body to be blank when media="print",
                   8339: if printout generation is unavailable for the current resource.
                   8340: 
                   8341: This could be because:
                   8342: 
                   8343: (a) printstartdate is in the future
                   8344: 
                   8345: (b) printenddate is in the past
                   8346: 
                   8347: (c) there is an active exam block with "printout"
                   8348: functionality blocked
                   8349: 
                   8350: Users with pav, pfo or evb privileges are exempt.
                   8351: 
                   8352: Inputs: none
                   8353: 
                   8354: =cut
                   8355: 
                   8356: 
                   8357: sub print_suppression {
                   8358:     my $noprint;
                   8359:     if ($env{'request.course.id'}) {
                   8360:         my $scope = $env{'request.course.id'};
                   8361:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8362:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   8363:             return;
                   8364:         }
                   8365:         if ($env{'request.course.sec'} ne '') {
                   8366:             $scope .= "/$env{'request.course.sec'}";
                   8367:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   8368:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  8369:                 return;
1.1064    raeburn  8370:             }
                   8371:         }
                   8372:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   8373:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.158  raeburn  8374:         my $clientip = &Apache::lonnet::get_requestor_ip();
                   8375:         my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064    raeburn  8376:         if ($blocked) {
                   8377:             my $checkrole = "cm./$cdom/$cnum";
                   8378:             if ($env{'request.course.sec'} ne '') {
                   8379:                 $checkrole .= "/$env{'request.course.sec'}";
                   8380:             }
                   8381:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   8382:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   8383:                 $noprint = 1;
                   8384:             }
                   8385:         }
                   8386:         unless ($noprint) {
                   8387:             my $symb = &Apache::lonnet::symbread();
                   8388:             if ($symb ne '') {
                   8389:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   8390:                 if (ref($navmap)) {
                   8391:                     my $res = $navmap->getBySymb($symb);
                   8392:                     if (ref($res)) {
                   8393:                         if (!$res->resprintable()) {
                   8394:                             $noprint = 1;
                   8395:                         }
                   8396:                     }
                   8397:                 }
                   8398:             }
                   8399:         }
                   8400:         if ($noprint) {
                   8401:             return <<"ENDSTYLE";
                   8402: <style type="text/css" media="print">
                   8403:     body { display:none }
                   8404: </style>
                   8405: ENDSTYLE
                   8406:         }
                   8407:     }
                   8408:     return;
                   8409: }
                   8410: 
                   8411: =pod
                   8412: 
1.341     albertel 8413: =item * &xml_begin()
                   8414: 
                   8415: Returns the needed doctype and <html>
                   8416: 
                   8417: Inputs: none
                   8418: 
                   8419: =cut
                   8420: 
                   8421: sub xml_begin {
1.1075.2.61  raeburn  8422:     my ($is_frameset) = @_;
1.341     albertel 8423:     my $output='';
                   8424: 
                   8425:     if ($env{'browser.mathml'}) {
                   8426: 	$output='<?xml version="1.0"?>'
                   8427:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   8428: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   8429:             
                   8430: #	    .'<!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">] >'
                   8431: 	    .'<!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">'
                   8432:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   8433: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1075.2.61  raeburn  8434:     } elsif ($is_frameset) {
                   8435:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   8436:                 '<html>'."\n";
1.341     albertel 8437:     } else {
1.1075.2.61  raeburn  8438: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   8439:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 8440:     }
                   8441:     return $output;
                   8442: }
1.340     albertel 8443: 
                   8444: =pod
                   8445: 
1.306     albertel 8446: =item * &start_page()
                   8447: 
                   8448: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   8449: 
1.648     raeburn  8450: Inputs:
                   8451: 
                   8452: =over 4
                   8453: 
                   8454: $title - optional title for the page
                   8455: 
                   8456: $head_extra - optional extra HTML to incude inside the <head>
                   8457: 
                   8458: $args - additional optional args supported are:
                   8459: 
                   8460: =over 8
                   8461: 
                   8462:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 8463:                                     arg on
1.814     bisitz   8464:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  8465:              add_entries    -> additional attributes to add to the  <body>
                   8466:              domain         -> force to color decorate a page for a 
1.317     albertel 8467:                                     specific domain
1.648     raeburn  8468:              function       -> force usage of a specific rolish color
1.317     albertel 8469:                                     scheme
1.648     raeburn  8470:              redirect       -> see &headtag()
                   8471:              bgcolor        -> override the default page bg color
                   8472:              js_ready       -> return a string ready for being used in 
1.317     albertel 8473:                                     a javascript writeln
1.648     raeburn  8474:              html_encode    -> return a string ready for being used in 
1.320     albertel 8475:                                     a html attribute
1.648     raeburn  8476:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 8477:                                     $forcereg arg
1.648     raeburn  8478:              frameset       -> if true will start with a <frameset>
1.330     albertel 8479:                                     rather than <body>
1.648     raeburn  8480:              skip_phases    -> hash ref of 
1.338     albertel 8481:                                     head -> skip the <html><head> generation
                   8482:                                     body -> skip all <body> generation
1.1075.2.12  raeburn  8483:              no_inline_link -> if true and in remote mode, don't show the
                   8484:                                     'Switch To Inline Menu' link
1.648     raeburn  8485:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 8486:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  8487:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1075.2.123  raeburn  8488:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   8489:                                     to lonhtmlcommon::breadcrumbs
1.1075.2.15  raeburn  8490:              group          -> includes the current group, if page is for a
                   8491:                                specific group
1.1075.2.133  raeburn  8492:              use_absolute   -> for request for external resource or syllabus, this
                   8493:                                will contain https://<hostname> if server uses
                   8494:                                https (as per hosts.tab), but request is for http
                   8495:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.1075.2.158  raeburn  8496:              links_disabled -> Links in primary and secondary menus are disabled
                   8497:                                (Can enable them once page has loaded - see lonroles.pm
                   8498:                                for an example).
1.361     albertel 8499: 
1.648     raeburn  8500: =back
1.460     albertel 8501: 
1.648     raeburn  8502: =back
1.562     albertel 8503: 
1.306     albertel 8504: =cut
                   8505: 
                   8506: sub start_page {
1.309     albertel 8507:     my ($title,$head_extra,$args) = @_;
1.318     albertel 8508:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 8509: 
1.315     albertel 8510:     $env{'internal.start_page'}++;
1.1075.2.15  raeburn  8511:     my ($result,@advtools);
1.964     droeschl 8512: 
1.338     albertel 8513:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1075.2.62  raeburn  8514:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 8515:     }
                   8516:     
                   8517:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   8518: 	if ($args->{'frameset'}) {
                   8519: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   8520: 						$args->{'add_entries'});
                   8521: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   8522:         } else {
                   8523:             $result .=
                   8524:                 &bodytag($title, 
                   8525:                          $args->{'function'},       $args->{'add_entries'},
                   8526:                          $args->{'only_body'},      $args->{'domain'},
                   8527:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1075.2.12  raeburn  8528:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
1.1075.2.15  raeburn  8529:                          $args,                     \@advtools);
1.831     bisitz   8530:         }
1.330     albertel 8531:     }
1.338     albertel 8532: 
1.315     albertel 8533:     if ($args->{'js_ready'}) {
1.713     kaisler  8534: 		$result = &js_ready($result);
1.315     albertel 8535:     }
1.320     albertel 8536:     if ($args->{'html_encode'}) {
1.713     kaisler  8537: 		$result = &html_encode($result);
                   8538:     }
                   8539: 
1.813     bisitz   8540:     # Preparation for new and consistent functionlist at top of screen
                   8541:     # if ($args->{'functionlist'}) {
                   8542:     #            $result .= &build_functionlist();
                   8543:     #}
                   8544: 
1.964     droeschl 8545:     # Don't add anything more if only_body wanted or in const space
                   8546:     return $result if    $args->{'only_body'} 
                   8547:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   8548: 
                   8549:     #Breadcrumbs
1.758     kaisler  8550:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   8551: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   8552: 		#if any br links exists, add them to the breadcrumbs
                   8553: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   8554: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   8555: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   8556: 			}
                   8557: 		}
1.1075.2.19  raeburn  8558:                 # if @advtools array contains items add then to the breadcrumbs
                   8559:                 if (@advtools > 0) {
                   8560:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   8561:                 }
1.1075.2.123  raeburn  8562:                 my $menulink;
                   8563:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   8564:                 if (exists($args->{'bread_crumbs_nomenu'})) {
                   8565:                     $menulink = 0;
                   8566:                 } else {
                   8567:                     undef($menulink);
                   8568:                 }
1.758     kaisler  8569: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   8570: 		if(exists($args->{'bread_crumbs_component'})){
1.1075.2.123  raeburn  8571: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.758     kaisler  8572: 		}else{
1.1075.2.123  raeburn  8573: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  8574: 		}
1.1075.2.24  raeburn  8575:     } elsif (($env{'environment.remote'} eq 'on') &&
                   8576:              ($env{'form.inhibitmenu'} ne 'yes') &&
                   8577:              ($env{'request.noversionuri'} =~ m{^/res/}) &&
                   8578:              ($env{'request.noversionuri'} !~ m{^/res/adm/pages/})) {
1.1075.2.21  raeburn  8579:         $result .= '<div style="padding:0;margin:0;clear:both"><hr /></div>';
1.320     albertel 8580:     }
1.315     albertel 8581:     return $result;
1.306     albertel 8582: }
                   8583: 
                   8584: sub end_page {
1.315     albertel 8585:     my ($args) = @_;
                   8586:     $env{'internal.end_page'}++;
1.330     albertel 8587:     my $result;
1.335     albertel 8588:     if ($args->{'discussion'}) {
                   8589: 	my ($target,$parser);
                   8590: 	if (ref($args->{'discussion'})) {
                   8591: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   8592: 				$args->{'discussion'}{'parser'});
                   8593: 	}
                   8594: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   8595:     }
1.330     albertel 8596:     if ($args->{'frameset'}) {
                   8597: 	$result .= '</frameset>';
                   8598:     } else {
1.635     raeburn  8599: 	$result .= &endbodytag($args);
1.330     albertel 8600:     }
1.1075.2.6  raeburn  8601:     unless ($args->{'notbody'}) {
                   8602:         $result .= "\n</html>";
                   8603:     }
1.330     albertel 8604: 
1.315     albertel 8605:     if ($args->{'js_ready'}) {
1.317     albertel 8606: 	$result = &js_ready($result);
1.315     albertel 8607:     }
1.335     albertel 8608: 
1.320     albertel 8609:     if ($args->{'html_encode'}) {
                   8610: 	$result = &html_encode($result);
                   8611:     }
1.335     albertel 8612: 
1.315     albertel 8613:     return $result;
                   8614: }
                   8615: 
1.1034    www      8616: sub wishlist_window {
                   8617:     return(<<'ENDWISHLIST');
1.1046    raeburn  8618: <script type="text/javascript">
1.1034    www      8619: // <![CDATA[
                   8620: // <!-- BEGIN LON-CAPA Internal
                   8621: function set_wishlistlink(title, path) {
                   8622:     if (!title) {
                   8623:         title = document.title;
                   8624:         title = title.replace(/^LON-CAPA /,'');
                   8625:     }
1.1075.2.65  raeburn  8626:     title = encodeURIComponent(title);
1.1075.2.83  raeburn  8627:     title = title.replace("'","\\\'");
1.1034    www      8628:     if (!path) {
                   8629:         path = location.pathname;
                   8630:     }
1.1075.2.65  raeburn  8631:     path = encodeURIComponent(path);
1.1075.2.83  raeburn  8632:     path = path.replace("'","\\\'");
1.1034    www      8633:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   8634:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   8635: }
                   8636: // END LON-CAPA Internal -->
                   8637: // ]]>
                   8638: </script>
                   8639: ENDWISHLIST
                   8640: }
                   8641: 
1.1030    www      8642: sub modal_window {
                   8643:     return(<<'ENDMODAL');
1.1046    raeburn  8644: <script type="text/javascript">
1.1030    www      8645: // <![CDATA[
                   8646: // <!-- BEGIN LON-CAPA Internal
                   8647: var modalWindow = {
                   8648: 	parent:"body",
                   8649: 	windowId:null,
                   8650: 	content:null,
                   8651: 	width:null,
                   8652: 	height:null,
                   8653: 	close:function()
                   8654: 	{
                   8655: 	        $(".LCmodal-window").remove();
                   8656: 	        $(".LCmodal-overlay").remove();
                   8657: 	},
                   8658: 	open:function()
                   8659: 	{
                   8660: 		var modal = "";
                   8661: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   8662: 		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;\">";
                   8663: 		modal += this.content;
                   8664: 		modal += "</div>";	
                   8665: 
                   8666: 		$(this.parent).append(modal);
                   8667: 
                   8668: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   8669: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   8670: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   8671: 	}
                   8672: };
1.1075.2.42  raeburn  8673: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      8674: 	{
1.1075.2.119  raeburn  8675:                 source = source.replace(/'/g,"&#39;");
1.1030    www      8676: 		modalWindow.windowId = "myModal";
                   8677: 		modalWindow.width = width;
                   8678: 		modalWindow.height = height;
1.1075.2.80  raeburn  8679: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      8680: 		modalWindow.open();
1.1075.2.87  raeburn  8681: 	};
1.1030    www      8682: // END LON-CAPA Internal -->
                   8683: // ]]>
                   8684: </script>
                   8685: ENDMODAL
                   8686: }
                   8687: 
                   8688: sub modal_link {
1.1075.2.42  raeburn  8689:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      8690:     unless ($width) { $width=480; }
                   8691:     unless ($height) { $height=400; }
1.1031    www      8692:     unless ($scrolling) { $scrolling='yes'; }
1.1075.2.42  raeburn  8693:     unless ($transparency) { $transparency='true'; }
                   8694: 
1.1074    raeburn  8695:     my $target_attr;
                   8696:     if (defined($target)) {
                   8697:         $target_attr = 'target="'.$target.'"';
                   8698:     }
                   8699:     return <<"ENDLINK";
1.1075.2.143  raeburn  8700: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  8701: ENDLINK
1.1030    www      8702: }
                   8703: 
1.1032    www      8704: sub modal_adhoc_script {
1.1075.2.155  raeburn  8705:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
                   8706:     my $mathjax;
                   8707:     if ($possmathjax) {
                   8708:         $mathjax = <<'ENDJAX';
                   8709:                if (typeof MathJax == 'object') {
                   8710:                    MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
                   8711:                }
                   8712: ENDJAX
                   8713:     }
1.1032    www      8714:     return (<<ENDADHOC);
1.1046    raeburn  8715: <script type="text/javascript">
1.1032    www      8716: // <![CDATA[
                   8717:         var $funcname = function()
                   8718:         {
                   8719:                 modalWindow.windowId = "myModal";
                   8720:                 modalWindow.width = $width;
                   8721:                 modalWindow.height = $height;
                   8722:                 modalWindow.content = '$content';
                   8723:                 modalWindow.open();
1.1075.2.155  raeburn  8724:                 $mathjax
1.1032    www      8725:         };  
                   8726: // ]]>
                   8727: </script>
                   8728: ENDADHOC
                   8729: }
                   8730: 
1.1041    www      8731: sub modal_adhoc_inner {
1.1075.2.155  raeburn  8732:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041    www      8733:     my $innerwidth=$width-20;
                   8734:     $content=&js_ready(
1.1042    www      8735:                &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
1.1075.2.42  raeburn  8736:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   8737:                  $content.
1.1041    www      8738:                  &end_scrollbox().
1.1075.2.42  raeburn  8739:                  &end_page()
1.1041    www      8740:              );
1.1075.2.155  raeburn  8741:     return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041    www      8742: }
                   8743: 
                   8744: sub modal_adhoc_window {
1.1075.2.155  raeburn  8745:     my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
                   8746:     return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041    www      8747:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   8748: }
                   8749: 
                   8750: sub modal_adhoc_launch {
                   8751:     my ($funcname,$width,$height,$content)=@_;
                   8752:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   8753: <script type="text/javascript">
                   8754: // <![CDATA[
                   8755: $funcname();
                   8756: // ]]>
                   8757: </script>
                   8758: ENDLAUNCH
                   8759: }
                   8760: 
                   8761: sub modal_adhoc_close {
                   8762:     return (<<ENDCLOSE);
                   8763: <script type="text/javascript">
                   8764: // <![CDATA[
                   8765: modalWindow.close();
                   8766: // ]]>
                   8767: </script>
                   8768: ENDCLOSE
                   8769: }
                   8770: 
1.1038    www      8771: sub togglebox_script {
                   8772:    return(<<ENDTOGGLE);
                   8773: <script type="text/javascript"> 
                   8774: // <![CDATA[
                   8775: function LCtoggleDisplay(id,hidetext,showtext) {
                   8776:    link = document.getElementById(id + "link").childNodes[0];
                   8777:    with (document.getElementById(id).style) {
                   8778:       if (display == "none" ) {
                   8779:           display = "inline";
                   8780:           link.nodeValue = hidetext;
                   8781:         } else {
                   8782:           display = "none";
                   8783:           link.nodeValue = showtext;
                   8784:        }
                   8785:    }
                   8786: }
                   8787: // ]]>
                   8788: </script>
                   8789: ENDTOGGLE
                   8790: }
                   8791: 
1.1039    www      8792: sub start_togglebox {
                   8793:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   8794:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   8795:     unless ($showtext) { $showtext=&mt('show'); }
                   8796:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   8797:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   8798:     return &start_data_table().
                   8799:            &start_data_table_header_row().
                   8800:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   8801:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   8802:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   8803:            &end_data_table_header_row().
                   8804:            '<tr id="'.$id.'" style="display:none""><td>';
                   8805: }
                   8806: 
                   8807: sub end_togglebox {
                   8808:     return '</td></tr>'.&end_data_table();
                   8809: }
                   8810: 
1.1041    www      8811: sub LCprogressbar_script {
1.1075.2.130  raeburn  8812:    my ($id,$number_to_do)=@_;
                   8813:    if ($number_to_do) {
                   8814:        return(<<ENDPROGRESS);
1.1041    www      8815: <script type="text/javascript">
                   8816: // <![CDATA[
1.1045    www      8817: \$('#progressbar$id').progressbar({
1.1041    www      8818:   value: 0,
                   8819:   change: function(event, ui) {
                   8820:     var newVal = \$(this).progressbar('option', 'value');
                   8821:     \$('.pblabel', this).text(LCprogressTxt);
                   8822:   }
                   8823: });
                   8824: // ]]>
                   8825: </script>
                   8826: ENDPROGRESS
1.1075.2.130  raeburn  8827:    } else {
                   8828:        return(<<ENDPROGRESS);
                   8829: <script type="text/javascript">
                   8830: // <![CDATA[
                   8831: \$('#progressbar$id').progressbar({
                   8832:   value: false,
                   8833:   create: function(event, ui) {
                   8834:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   8835:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   8836:   }
                   8837: });
                   8838: // ]]>
                   8839: </script>
                   8840: ENDPROGRESS
                   8841:    }
1.1041    www      8842: }
                   8843: 
                   8844: sub LCprogressbarUpdate_script {
                   8845:    return(<<ENDPROGRESSUPDATE);
                   8846: <style type="text/css">
                   8847: .ui-progressbar { position:relative; }
1.1075.2.130  raeburn  8848: .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      8849: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   8850: </style>
                   8851: <script type="text/javascript">
                   8852: // <![CDATA[
1.1045    www      8853: var LCprogressTxt='---';
                   8854: 
1.1075.2.130  raeburn  8855: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      8856:    LCprogressTxt=progresstext;
1.1075.2.130  raeburn  8857:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   8858:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   8859:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
                   8860:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   8861:    } else {
                   8862:        \$('#progressbar'+id).progressbar('value',percent);
                   8863:    }
1.1041    www      8864: }
                   8865: // ]]>
                   8866: </script>
                   8867: ENDPROGRESSUPDATE
                   8868: }
                   8869: 
1.1042    www      8870: my $LClastpercent;
1.1045    www      8871: my $LCidcnt;
                   8872: my $LCcurrentid;
1.1042    www      8873: 
1.1041    www      8874: sub LCprogressbar {
1.1075.2.130  raeburn  8875:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      8876:     $LClastpercent=0;
1.1045    www      8877:     $LCidcnt++;
                   8878:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1075.2.130  raeburn  8879:     my ($starting,$content);
                   8880:     if ($number_to_do) {
                   8881:         $starting=&mt('Starting');
                   8882:         $content=(<<ENDPROGBAR);
                   8883: $preamble
1.1045    www      8884:   <div id="progressbar$LCcurrentid">
1.1041    www      8885:     <span class="pblabel">$starting</span>
                   8886:   </div>
                   8887: ENDPROGBAR
1.1075.2.130  raeburn  8888:     } else {
                   8889:         $starting=&mt('Loading...');
                   8890:         $LClastpercent='false';
                   8891:         $content=(<<ENDPROGBAR);
                   8892: $preamble
                   8893:   <div id="progressbar$LCcurrentid">
                   8894:       <div class="progress-label">$starting</div>
                   8895:   </div>
                   8896: ENDPROGBAR
                   8897:     }
                   8898:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      8899: }
                   8900: 
                   8901: sub LCprogressbarUpdate {
1.1075.2.130  raeburn  8902:     my ($r,$val,$text,$number_to_do)=@_;
                   8903:     if ($number_to_do) {
                   8904:         unless ($val) { 
                   8905:             if ($LClastpercent) {
                   8906:                 $val=$LClastpercent;
                   8907:             } else {
                   8908:                 $val=0;
                   8909:             }
                   8910:         }
                   8911:         if ($val<0) { $val=0; }
                   8912:         if ($val>100) { $val=0; }
                   8913:         $LClastpercent=$val;
                   8914:         unless ($text) { $text=$val.'%'; }
                   8915:     } else {
                   8916:         $val = 'false';
1.1042    www      8917:     }
1.1041    www      8918:     $text=&js_ready($text);
1.1044    www      8919:     &r_print($r,<<ENDUPDATE);
1.1041    www      8920: <script type="text/javascript">
                   8921: // <![CDATA[
1.1075.2.130  raeburn  8922: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      8923: // ]]>
                   8924: </script>
                   8925: ENDUPDATE
1.1035    www      8926: }
                   8927: 
1.1042    www      8928: sub LCprogressbarClose {
                   8929:     my ($r)=@_;
                   8930:     $LClastpercent=0;
1.1044    www      8931:     &r_print($r,<<ENDCLOSE);
1.1042    www      8932: <script type="text/javascript">
                   8933: // <![CDATA[
1.1045    www      8934: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      8935: // ]]>
                   8936: </script>
                   8937: ENDCLOSE
1.1044    www      8938: }
                   8939: 
                   8940: sub r_print {
                   8941:     my ($r,$to_print)=@_;
                   8942:     if ($r) {
                   8943:       $r->print($to_print);
                   8944:       $r->rflush();
                   8945:     } else {
                   8946:       print($to_print);
                   8947:     }
1.1042    www      8948: }
                   8949: 
1.320     albertel 8950: sub html_encode {
                   8951:     my ($result) = @_;
                   8952: 
1.322     albertel 8953:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 8954:     
                   8955:     return $result;
                   8956: }
1.1044    www      8957: 
1.317     albertel 8958: sub js_ready {
                   8959:     my ($result) = @_;
                   8960: 
1.323     albertel 8961:     $result =~ s/[\n\r]/ /xmsg;
                   8962:     $result =~ s/\\/\\\\/xmsg;
                   8963:     $result =~ s/'/\\'/xmsg;
1.372     albertel 8964:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 8965:     
                   8966:     return $result;
                   8967: }
                   8968: 
1.315     albertel 8969: sub validate_page {
                   8970:     if (  exists($env{'internal.start_page'})
1.316     albertel 8971: 	  &&     $env{'internal.start_page'} > 1) {
                   8972: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 8973: 				 $env{'internal.start_page'}.' '.
1.316     albertel 8974: 				 $ENV{'request.filename'});
1.315     albertel 8975:     }
                   8976:     if (  exists($env{'internal.end_page'})
1.316     albertel 8977: 	  &&     $env{'internal.end_page'} > 1) {
                   8978: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 8979: 				 $env{'internal.end_page'}.' '.
1.316     albertel 8980: 				 $env{'request.filename'});
1.315     albertel 8981:     }
                   8982:     if (     exists($env{'internal.start_page'})
                   8983: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 8984: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   8985: 				 $env{'request.filename'});
1.315     albertel 8986:     }
                   8987:     if (   ! exists($env{'internal.start_page'})
                   8988: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 8989: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   8990: 				 $env{'request.filename'});
1.315     albertel 8991:     }
1.306     albertel 8992: }
1.315     albertel 8993: 
1.996     www      8994: 
                   8995: sub start_scrollbox {
1.1075.2.56  raeburn  8996:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  8997:     unless ($outerwidth) { $outerwidth='520px'; }
                   8998:     unless ($width) { $width='500px'; }
                   8999:     unless ($height) { $height='200px'; }
1.1075    raeburn  9000:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  9001:     if ($id ne '') {
1.1075.2.42  raeburn  9002:         $table_id = ' id="table_'.$id.'"';
                   9003:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  9004:     }
1.1075    raeburn  9005:     if ($bgcolor ne '') {
                   9006:         $tdcol = "background-color: $bgcolor;";
                   9007:     }
1.1075.2.42  raeburn  9008:     my $nicescroll_js;
                   9009:     if ($env{'browser.mobile'}) {
                   9010:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   9011:     }
1.1075    raeburn  9012:     return <<"END";
1.1075.2.42  raeburn  9013: $nicescroll_js
                   9014: 
                   9015: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
1.1075.2.56  raeburn  9016: <div style="overflow:auto; width:$width; height:$height;"$div_id>
1.1075    raeburn  9017: END
1.996     www      9018: }
                   9019: 
                   9020: sub end_scrollbox {
1.1036    www      9021:     return '</div></td></tr></table>';
1.996     www      9022: }
                   9023: 
1.1075.2.42  raeburn  9024: sub nicescroll_javascript {
                   9025:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   9026:     my %options;
                   9027:     if (ref($cursor) eq 'HASH') {
                   9028:         %options = %{$cursor};
                   9029:     }
                   9030:     unless ($options{'railalign'} =~ /^left|right$/) {
                   9031:         $options{'railalign'} = 'left';
                   9032:     }
                   9033:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9034:         my $function  = &get_users_function();
                   9035:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
                   9036:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   9037:             $options{'cursorcolor'} = '#00F';
                   9038:         }
                   9039:     }
                   9040:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   9041:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
                   9042:             $options{'cursoropacity'}='1.0';
                   9043:         }
                   9044:     } else {
                   9045:         $options{'cursoropacity'}='1.0';
                   9046:     }
                   9047:     if ($options{'cursorfixedheight'} eq 'none') {
                   9048:         delete($options{'cursorfixedheight'});
                   9049:     } else {
                   9050:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   9051:     }
                   9052:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   9053:         delete($options{'railoffset'});
                   9054:     }
                   9055:     my @niceoptions;
                   9056:     while (my($key,$value) = each(%options)) {
                   9057:         if ($value =~ /^\{.+\}$/) {
                   9058:             push(@niceoptions,$key.':'.$value);
                   9059:         } else {
                   9060:             push(@niceoptions,$key.':"'.$value.'"');
                   9061:         }
                   9062:     }
                   9063:     my $nicescroll_js = '
                   9064: $(document).ready(
                   9065:       function() {
                   9066:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   9067:       }
                   9068: );
                   9069: ';
                   9070:     if ($framecheck) {
                   9071:         $nicescroll_js .= '
                   9072: function expand_div(caller) {
                   9073:     if (top === self) {
                   9074:         document.getElementById("'.$id.'").style.width = "auto";
                   9075:         document.getElementById("'.$id.'").style.height = "auto";
                   9076:     } else {
                   9077:         try {
                   9078:             if (parent.frames) {
                   9079:                 if (parent.frames.length > 1) {
                   9080:                     var framesrc = parent.frames[1].location.href;
                   9081:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   9082:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   9083:                         document.getElementById("'.$id.'").style.width = "auto";
                   9084:                         document.getElementById("'.$id.'").style.height = "auto";
                   9085:                     }
                   9086:                 }
                   9087:             }
                   9088:         } catch (e) {
                   9089:             return;
                   9090:         }
                   9091:     }
                   9092:     return;
                   9093: }
                   9094: ';
                   9095:     }
                   9096:     if ($needjsready) {
                   9097:         $nicescroll_js = '
                   9098: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   9099:     } else {
                   9100:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   9101:     }
                   9102:     return $nicescroll_js;
                   9103: }
                   9104: 
1.318     albertel 9105: sub simple_error_page {
1.1075.2.49  raeburn  9106:     my ($r,$title,$msg,$args) = @_;
                   9107:     if (ref($args) eq 'HASH') {
                   9108:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
                   9109:     } else {
                   9110:         $msg = &mt($msg);
                   9111:     }
                   9112: 
1.318     albertel 9113:     my $page =
                   9114: 	&Apache::loncommon::start_page($title).
1.1075.2.49  raeburn  9115: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 9116: 	&Apache::loncommon::end_page();
                   9117:     if (ref($r)) {
                   9118: 	$r->print($page);
1.327     albertel 9119: 	return;
1.318     albertel 9120:     }
                   9121:     return $page;
                   9122: }
1.347     albertel 9123: 
                   9124: {
1.610     albertel 9125:     my @row_count;
1.961     onken    9126: 
                   9127:     sub start_data_table_count {
                   9128:         unshift(@row_count, 0);
                   9129:         return;
                   9130:     }
                   9131: 
                   9132:     sub end_data_table_count {
                   9133:         shift(@row_count);
                   9134:         return;
                   9135:     }
                   9136: 
1.347     albertel 9137:     sub start_data_table {
1.1018    raeburn  9138: 	my ($add_class,$id) = @_;
1.422     albertel 9139: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  9140:         my $table_id;
                   9141:         if (defined($id)) {
                   9142:             $table_id = ' id="'.$id.'"';
                   9143:         }
1.961     onken    9144: 	&start_data_table_count();
1.1018    raeburn  9145: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 9146:     }
                   9147: 
                   9148:     sub end_data_table {
1.961     onken    9149: 	&end_data_table_count();
1.389     albertel 9150: 	return '</table>'."\n";;
1.347     albertel 9151:     }
                   9152: 
                   9153:     sub start_data_table_row {
1.974     wenzelju 9154: 	my ($add_class, $id) = @_;
1.610     albertel 9155: 	$row_count[0]++;
                   9156: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   9157: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 9158:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9159:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 9160:     }
1.471     banghart 9161:     
                   9162:     sub continue_data_table_row {
1.974     wenzelju 9163: 	my ($add_class, $id) = @_;
1.610     albertel 9164: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 9165: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   9166:         $id = (' id="'.$id.'"') unless ($id eq '');
                   9167:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 9168:     }
1.347     albertel 9169: 
                   9170:     sub end_data_table_row {
1.389     albertel 9171: 	return '</tr>'."\n";;
1.347     albertel 9172:     }
1.367     www      9173: 
1.421     albertel 9174:     sub start_data_table_empty_row {
1.707     bisitz   9175: #	$row_count[0]++;
1.421     albertel 9176: 	return  '<tr class="LC_empty_row" >'."\n";;
                   9177:     }
                   9178: 
                   9179:     sub end_data_table_empty_row {
                   9180: 	return '</tr>'."\n";;
                   9181:     }
                   9182: 
1.367     www      9183:     sub start_data_table_header_row {
1.389     albertel 9184: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      9185:     }
                   9186: 
                   9187:     sub end_data_table_header_row {
1.389     albertel 9188: 	return '</tr>'."\n";;
1.367     www      9189:     }
1.890     droeschl 9190: 
                   9191:     sub data_table_caption {
                   9192:         my $caption = shift;
                   9193:         return "<caption class=\"LC_caption\">$caption</caption>";
                   9194:     }
1.347     albertel 9195: }
                   9196: 
1.548     albertel 9197: =pod
                   9198: 
                   9199: =item * &inhibit_menu_check($arg)
                   9200: 
                   9201: Checks for a inhibitmenu state and generates output to preserve it
                   9202: 
                   9203: Inputs:         $arg - can be any of
                   9204:                      - undef - in which case the return value is a string 
                   9205:                                to add  into arguments list of a uri
                   9206:                      - 'input' - in which case the return value is a HTML
                   9207:                                  <form> <input> field of type hidden to
                   9208:                                  preserve the value
                   9209:                      - a url - in which case the return value is the url with
                   9210:                                the neccesary cgi args added to preserve the
                   9211:                                inhibitmenu state
                   9212:                      - a ref to a url - no return value, but the string is
                   9213:                                         updated to include the neccessary cgi
                   9214:                                         args to preserve the inhibitmenu state
                   9215: 
                   9216: =cut
                   9217: 
                   9218: sub inhibit_menu_check {
                   9219:     my ($arg) = @_;
                   9220:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   9221:     if ($arg eq 'input') {
                   9222: 	if ($env{'form.inhibitmenu'}) {
                   9223: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   9224: 	} else {
                   9225: 	    return
                   9226: 	}
                   9227:     }
                   9228:     if ($env{'form.inhibitmenu'}) {
                   9229: 	if (ref($arg)) {
                   9230: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9231: 	} elsif ($arg eq '') {
                   9232: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   9233: 	} else {
                   9234: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   9235: 	}
                   9236:     }
                   9237:     if (!ref($arg)) {
                   9238: 	return $arg;
                   9239:     }
                   9240: }
                   9241: 
1.251     albertel 9242: ###############################################
1.182     matthew  9243: 
                   9244: =pod
                   9245: 
1.549     albertel 9246: =back
                   9247: 
                   9248: =head1 User Information Routines
                   9249: 
                   9250: =over 4
                   9251: 
1.405     albertel 9252: =item * &get_users_function()
1.182     matthew  9253: 
                   9254: Used by &bodytag to determine the current users primary role.
                   9255: Returns either 'student','coordinator','admin', or 'author'.
                   9256: 
                   9257: =cut
                   9258: 
                   9259: ###############################################
                   9260: sub get_users_function {
1.815     tempelho 9261:     my $function = 'norole';
1.818     tempelho 9262:     if ($env{'request.role'}=~/^(st)/) {
                   9263:         $function='student';
                   9264:     }
1.907     raeburn  9265:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  9266:         $function='coordinator';
                   9267:     }
1.258     albertel 9268:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  9269:         $function='admin';
                   9270:     }
1.826     bisitz   9271:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  9272:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  9273:         $function='author';
                   9274:     }
                   9275:     return $function;
1.54      www      9276: }
1.99      www      9277: 
                   9278: ###############################################
                   9279: 
1.233     raeburn  9280: =pod
                   9281: 
1.821     raeburn  9282: =item * &show_course()
                   9283: 
                   9284: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   9285: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   9286: 
                   9287: Inputs:
                   9288: None
                   9289: 
                   9290: Outputs:
                   9291: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   9292: 
                   9293: =cut
                   9294: 
                   9295: ###############################################
                   9296: sub show_course {
                   9297:     my $course = !$env{'user.adv'};
                   9298:     if (!$env{'user.adv'}) {
                   9299:         foreach my $env (keys(%env)) {
                   9300:             next if ($env !~ m/^user\.priv\./);
                   9301:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   9302:                 $course = 0;
                   9303:                 last;
                   9304:             }
                   9305:         }
                   9306:     }
                   9307:     return $course;
                   9308: }
                   9309: 
                   9310: ###############################################
                   9311: 
                   9312: =pod
                   9313: 
1.542     raeburn  9314: =item * &check_user_status()
1.274     raeburn  9315: 
                   9316: Determines current status of supplied role for a
                   9317: specific user. Roles can be active, previous or future.
                   9318: 
                   9319: Inputs: 
                   9320: user's domain, user's username, course's domain,
1.375     raeburn  9321: course's number, optional section ID.
1.274     raeburn  9322: 
                   9323: Outputs:
                   9324: role status: active, previous or future. 
                   9325: 
                   9326: =cut
                   9327: 
                   9328: sub check_user_status {
1.412     raeburn  9329:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  9330:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1075.2.85  raeburn  9331:     my @uroles = keys(%userinfo);
1.274     raeburn  9332:     my $srchstr;
                   9333:     my $active_chk = 'none';
1.412     raeburn  9334:     my $now = time;
1.274     raeburn  9335:     if (@uroles > 0) {
1.908     raeburn  9336:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  9337:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   9338:         } else {
1.412     raeburn  9339:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   9340:         }
                   9341:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  9342:             my $role_end = 0;
                   9343:             my $role_start = 0;
                   9344:             $active_chk = 'active';
1.412     raeburn  9345:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   9346:                 $role_end = $1;
                   9347:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   9348:                     $role_start = $1;
1.274     raeburn  9349:                 }
                   9350:             }
                   9351:             if ($role_start > 0) {
1.412     raeburn  9352:                 if ($now < $role_start) {
1.274     raeburn  9353:                     $active_chk = 'future';
                   9354:                 }
                   9355:             }
                   9356:             if ($role_end > 0) {
1.412     raeburn  9357:                 if ($now > $role_end) {
1.274     raeburn  9358:                     $active_chk = 'previous';
                   9359:                 }
                   9360:             }
                   9361:         }
                   9362:     }
                   9363:     return $active_chk;
                   9364: }
                   9365: 
                   9366: ###############################################
                   9367: 
                   9368: =pod
                   9369: 
1.405     albertel 9370: =item * &get_sections()
1.233     raeburn  9371: 
                   9372: Determines all the sections for a course including
                   9373: sections with students and sections containing other roles.
1.419     raeburn  9374: Incoming parameters: 
                   9375: 
                   9376: 1. domain
                   9377: 2. course number 
                   9378: 3. reference to array containing roles for which sections should 
                   9379: be gathered (optional).
                   9380: 4. reference to array containing status types for which sections 
                   9381: should be gathered (optional).
                   9382: 
                   9383: If the third argument is undefined, sections are gathered for any role. 
                   9384: If the fourth argument is undefined, sections are gathered for any status.
                   9385: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  9386:  
1.374     raeburn  9387: Returns section hash (keys are section IDs, values are
                   9388: number of users in each section), subject to the
1.419     raeburn  9389: optional roles filter, optional status filter 
1.233     raeburn  9390: 
                   9391: =cut
                   9392: 
                   9393: ###############################################
                   9394: sub get_sections {
1.419     raeburn  9395:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 9396:     if (!defined($cdom) || !defined($cnum)) {
                   9397:         my $cid =  $env{'request.course.id'};
                   9398: 
                   9399: 	return if (!defined($cid));
                   9400: 
                   9401:         $cdom = $env{'course.'.$cid.'.domain'};
                   9402:         $cnum = $env{'course.'.$cid.'.num'};
                   9403:     }
                   9404: 
                   9405:     my %sectioncount;
1.419     raeburn  9406:     my $now = time;
1.240     albertel 9407: 
1.1075.2.33  raeburn  9408:     my $check_students = 1;
                   9409:     my $only_students = 0;
                   9410:     if (ref($possible_roles) eq 'ARRAY') {
                   9411:         if (grep(/^st$/,@{$possible_roles})) {
                   9412:             if (@{$possible_roles} == 1) {
                   9413:                 $only_students = 1;
                   9414:             }
                   9415:         } else {
                   9416:             $check_students = 0;
                   9417:         }
                   9418:     }
                   9419: 
                   9420:     if ($check_students) {
1.276     albertel 9421: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 9422: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   9423: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  9424:         my $start_index = &Apache::loncoursedata::CL_START();
                   9425:         my $end_index = &Apache::loncoursedata::CL_END();
                   9426:         my $status;
1.366     albertel 9427: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  9428: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   9429: 				                     $data->[$status_index],
                   9430:                                                      $data->[$start_index],
                   9431:                                                      $data->[$end_index]);
                   9432:             if ($stu_status eq 'Active') {
                   9433:                 $status = 'active';
                   9434:             } elsif ($end < $now) {
                   9435:                 $status = 'previous';
                   9436:             } elsif ($start > $now) {
                   9437:                 $status = 'future';
                   9438:             } 
                   9439: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   9440:                 if ((!defined($possible_status)) || (($status ne '') && 
                   9441:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   9442: 		    $sectioncount{$section}++;
                   9443:                 }
1.240     albertel 9444: 	    }
                   9445: 	}
                   9446:     }
1.1075.2.33  raeburn  9447:     if ($only_students) {
                   9448:         return %sectioncount;
                   9449:     }
1.240     albertel 9450:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9451:     foreach my $user (sort(keys(%courseroles))) {
                   9452: 	if ($user !~ /^(\w{2})/) { next; }
                   9453: 	my ($role) = ($user =~ /^(\w{2})/);
                   9454: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  9455: 	my ($section,$status);
1.240     albertel 9456: 	if ($role eq 'cr' &&
                   9457: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   9458: 	    $section=$1;
                   9459: 	}
                   9460: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   9461: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  9462:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   9463:         if ($end == -1 && $start == -1) {
                   9464:             next; #deleted role
                   9465:         }
                   9466:         if (!defined($possible_status)) { 
                   9467:             $sectioncount{$section}++;
                   9468:         } else {
                   9469:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   9470:                 $status = 'active';
                   9471:             } elsif ($end < $now) {
                   9472:                 $status = 'future';
                   9473:             } elsif ($start > $now) {
                   9474:                 $status = 'previous';
                   9475:             }
                   9476:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   9477:                 $sectioncount{$section}++;
                   9478:             }
                   9479:         }
1.233     raeburn  9480:     }
1.366     albertel 9481:     return %sectioncount;
1.233     raeburn  9482: }
                   9483: 
1.274     raeburn  9484: ###############################################
1.294     raeburn  9485: 
                   9486: =pod
1.405     albertel 9487: 
                   9488: =item * &get_course_users()
                   9489: 
1.275     raeburn  9490: Retrieves usernames:domains for users in the specified course
                   9491: with specific role(s), and access status. 
                   9492: 
                   9493: Incoming parameters:
1.277     albertel 9494: 1. course domain
                   9495: 2. course number
                   9496: 3. access status: users must have - either active, 
1.275     raeburn  9497: previous, future, or all.
1.277     albertel 9498: 4. reference to array of permissible roles
1.288     raeburn  9499: 5. reference to array of section restrictions (optional)
                   9500: 6. reference to results object (hash of hashes).
                   9501: 7. reference to optional userdata hash
1.609     raeburn  9502: 8. reference to optional statushash
1.630     raeburn  9503: 9. flag if privileged users (except those set to unhide in
                   9504:    course settings) should be excluded    
1.609     raeburn  9505: Keys of top level results hash are roles.
1.275     raeburn  9506: Keys of inner hashes are username:domain, with 
                   9507: values set to access type.
1.288     raeburn  9508: Optional userdata hash returns an array with arguments in the 
                   9509: same order as loncoursedata::get_classlist() for student data.
                   9510: 
1.609     raeburn  9511: Optional statushash returns
                   9512: 
1.288     raeburn  9513: Entries for end, start, section and status are blank because
                   9514: of the possibility of multiple values for non-student roles.
                   9515: 
1.275     raeburn  9516: =cut
1.405     albertel 9517: 
1.275     raeburn  9518: ###############################################
1.405     albertel 9519: 
1.275     raeburn  9520: sub get_course_users {
1.630     raeburn  9521:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  9522:     my %idx = ();
1.419     raeburn  9523:     my %seclists;
1.288     raeburn  9524: 
                   9525:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   9526:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   9527:     $idx{end} = &Apache::loncoursedata::CL_END();
                   9528:     $idx{start} = &Apache::loncoursedata::CL_START();
                   9529:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   9530:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   9531:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   9532:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   9533: 
1.290     albertel 9534:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 9535:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  9536:         my $now = time;
1.277     albertel 9537:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  9538:             my $match = 0;
1.412     raeburn  9539:             my $secmatch = 0;
1.419     raeburn  9540:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  9541:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  9542:             if ($section eq '') {
                   9543:                 $section = 'none';
                   9544:             }
1.291     albertel 9545:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9546:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9547:                     $secmatch = 1;
                   9548:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 9549:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9550:                         $secmatch = 1;
                   9551:                     }
                   9552:                 } else {  
1.419     raeburn  9553: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  9554: 		        $secmatch = 1;
                   9555:                     }
1.290     albertel 9556: 		}
1.412     raeburn  9557:                 if (!$secmatch) {
                   9558:                     next;
                   9559:                 }
1.419     raeburn  9560:             }
1.275     raeburn  9561:             if (defined($$types{'active'})) {
1.288     raeburn  9562:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  9563:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  9564:                     $match = 1;
1.275     raeburn  9565:                 }
                   9566:             }
                   9567:             if (defined($$types{'previous'})) {
1.609     raeburn  9568:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  9569:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  9570:                     $match = 1;
1.275     raeburn  9571:                 }
                   9572:             }
                   9573:             if (defined($$types{'future'})) {
1.609     raeburn  9574:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  9575:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  9576:                     $match = 1;
1.275     raeburn  9577:                 }
                   9578:             }
1.609     raeburn  9579:             if ($match) {
                   9580:                 push(@{$seclists{$student}},$section);
                   9581:                 if (ref($userdata) eq 'HASH') {
                   9582:                     $$userdata{$student} = $$classlist{$student};
                   9583:                 }
                   9584:                 if (ref($statushash) eq 'HASH') {
                   9585:                     $statushash->{$student}{'st'}{$section} = $status;
                   9586:                 }
1.288     raeburn  9587:             }
1.275     raeburn  9588:         }
                   9589:     }
1.412     raeburn  9590:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  9591:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   9592:         my $now = time;
1.609     raeburn  9593:         my %displaystatus = ( previous => 'Expired',
                   9594:                               active   => 'Active',
                   9595:                               future   => 'Future',
                   9596:                             );
1.1075.2.36  raeburn  9597:         my (%nothide,@possdoms);
1.630     raeburn  9598:         if ($hidepriv) {
                   9599:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   9600:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   9601:                 if ($user !~ /:/) {
                   9602:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   9603:                 } else {
                   9604:                     $nothide{$user} = 1;
                   9605:                 }
                   9606:             }
1.1075.2.36  raeburn  9607:             my @possdoms = ($cdom);
                   9608:             if ($coursehash{'checkforpriv'}) {
                   9609:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   9610:             }
1.630     raeburn  9611:         }
1.439     raeburn  9612:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  9613:             my $match = 0;
1.412     raeburn  9614:             my $secmatch = 0;
1.439     raeburn  9615:             my $status;
1.412     raeburn  9616:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  9617:             $user =~ s/:$//;
1.439     raeburn  9618:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   9619:             if ($end == -1 || $start == -1) {
                   9620:                 next;
                   9621:             }
                   9622:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   9623:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  9624:                 my ($uname,$udom) = split(/:/,$user);
                   9625:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 9626:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  9627:                         $secmatch = 1;
                   9628:                     } elsif ($usec eq '') {
1.420     albertel 9629:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  9630:                             $secmatch = 1;
                   9631:                         }
                   9632:                     } else {
                   9633:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   9634:                             $secmatch = 1;
                   9635:                         }
                   9636:                     }
                   9637:                     if (!$secmatch) {
                   9638:                         next;
                   9639:                     }
1.288     raeburn  9640:                 }
1.419     raeburn  9641:                 if ($usec eq '') {
                   9642:                     $usec = 'none';
                   9643:                 }
1.275     raeburn  9644:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  9645:                     if ($hidepriv) {
1.1075.2.36  raeburn  9646:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  9647:                             (!$nothide{$uname.':'.$udom})) {
                   9648:                             next;
                   9649:                         }
                   9650:                     }
1.503     raeburn  9651:                     if ($end > 0 && $end < $now) {
1.439     raeburn  9652:                         $status = 'previous';
                   9653:                     } elsif ($start > $now) {
                   9654:                         $status = 'future';
                   9655:                     } else {
                   9656:                         $status = 'active';
                   9657:                     }
1.277     albertel 9658:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  9659:                         if ($status eq $type) {
1.420     albertel 9660:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  9661:                                 push(@{$$users{$role}{$user}},$type);
                   9662:                             }
1.288     raeburn  9663:                             $match = 1;
                   9664:                         }
                   9665:                     }
1.419     raeburn  9666:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   9667:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   9668: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   9669:                         }
1.420     albertel 9670:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  9671:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   9672:                         }
1.609     raeburn  9673:                         if (ref($statushash) eq 'HASH') {
                   9674:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   9675:                         }
1.275     raeburn  9676:                     }
                   9677:                 }
                   9678:             }
                   9679:         }
1.290     albertel 9680:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  9681:             if ((defined($cdom)) && (defined($cnum))) {
                   9682:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   9683:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   9684:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  9685:                     next if ($owner eq '');
                   9686:                     my ($ownername,$ownerdom);
                   9687:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   9688:                         $ownername = $1;
                   9689:                         $ownerdom = $2;
                   9690:                     } else {
                   9691:                         $ownername = $owner;
                   9692:                         $ownerdom = $cdom;
                   9693:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  9694:                     }
                   9695:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 9696:                     if (defined($userdata) && 
1.609     raeburn  9697: 			!exists($$userdata{$owner})) {
                   9698: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   9699:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   9700:                             push(@{$seclists{$owner}},'none');
                   9701:                         }
                   9702:                         if (ref($statushash) eq 'HASH') {
                   9703:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  9704:                         }
1.290     albertel 9705: 		    }
1.279     raeburn  9706:                 }
                   9707:             }
                   9708:         }
1.419     raeburn  9709:         foreach my $user (keys(%seclists)) {
                   9710:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   9711:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   9712:         }
1.275     raeburn  9713:     }
                   9714:     return;
                   9715: }
                   9716: 
1.288     raeburn  9717: sub get_user_info {
                   9718:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 9719:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   9720: 	&plainname($uname,$udom,'lastname');
1.291     albertel 9721:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  9722:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  9723:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   9724:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  9725:     return;
                   9726: }
1.275     raeburn  9727: 
1.472     raeburn  9728: ###############################################
                   9729: 
                   9730: =pod
                   9731: 
                   9732: =item * &get_user_quota()
                   9733: 
1.1075.2.41  raeburn  9734: Retrieves quota assigned for storage of user files.
                   9735: Default is to report quota for portfolio files.
1.472     raeburn  9736: 
                   9737: Incoming parameters:
                   9738: 1. user's username
                   9739: 2. user's domain
1.1075.2.41  raeburn  9740: 3. quota name - portfolio, author, or course
                   9741:    (if no quota name provided, defaults to portfolio).
1.1075.2.59  raeburn  9742: 4. crstype - official, unofficial, textbook or community, if quota name is
1.1075.2.42  raeburn  9743:    course
1.472     raeburn  9744: 
                   9745: Returns:
1.1075.2.58  raeburn  9746: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  9747: 2. (Optional) Type of setting: custom or default
                   9748:    (individually assigned or default for user's 
                   9749:    institutional status).
                   9750: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   9751:    or student - types as defined in localenroll::inst_usertypes 
                   9752:    for user's domain, which determines default quota for user.
                   9753: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  9754: 
                   9755: If a value has been stored in the user's environment, 
1.536     raeburn  9756: it will return that, otherwise it returns the maximal default
1.1075.2.41  raeburn  9757: defined for the user's institutional status(es) in the domain.
1.472     raeburn  9758: 
                   9759: =cut
                   9760: 
                   9761: ###############################################
                   9762: 
                   9763: 
                   9764: sub get_user_quota {
1.1075.2.42  raeburn  9765:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  9766:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  9767:     if (!defined($udom)) {
                   9768:         $udom = $env{'user.domain'};
                   9769:     }
                   9770:     if (!defined($uname)) {
                   9771:         $uname = $env{'user.name'};
                   9772:     }
                   9773:     if (($udom eq '' || $uname eq '') ||
                   9774:         ($udom eq 'public') && ($uname eq 'public')) {
                   9775:         $quota = 0;
1.536     raeburn  9776:         $quotatype = 'default';
                   9777:         $defquota = 0; 
1.472     raeburn  9778:     } else {
1.536     raeburn  9779:         my $inststatus;
1.1075.2.41  raeburn  9780:         if ($quotaname eq 'course') {
                   9781:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   9782:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   9783:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   9784:             } else {
                   9785:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   9786:                 $quota = $cenv{'internal.uploadquota'};
                   9787:             }
1.536     raeburn  9788:         } else {
1.1075.2.41  raeburn  9789:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   9790:                 if ($quotaname eq 'author') {
                   9791:                     $quota = $env{'environment.authorquota'};
                   9792:                 } else {
                   9793:                     $quota = $env{'environment.portfolioquota'};
                   9794:                 }
                   9795:                 $inststatus = $env{'environment.inststatus'};
                   9796:             } else {
                   9797:                 my %userenv = 
                   9798:                     &Apache::lonnet::get('environment',['portfolioquota',
                   9799:                                          'authorquota','inststatus'],$udom,$uname);
                   9800:                 my ($tmp) = keys(%userenv);
                   9801:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9802:                     if ($quotaname eq 'author') {
                   9803:                         $quota = $userenv{'authorquota'};
                   9804:                     } else {
                   9805:                         $quota = $userenv{'portfolioquota'};
                   9806:                     }
                   9807:                     $inststatus = $userenv{'inststatus'};
                   9808:                 } else {
                   9809:                     undef(%userenv);
                   9810:                 }
                   9811:             }
                   9812:         }
                   9813:         if ($quota eq '' || wantarray) {
                   9814:             if ($quotaname eq 'course') {
                   9815:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1075.2.59  raeburn  9816:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') ||
                   9817:                     ($crstype eq 'community') || ($crstype eq 'textbook')) {
1.1075.2.42  raeburn  9818:                     $defquota = $domdefs{$crstype.'quota'};
                   9819:                 }
                   9820:                 if ($defquota eq '') {
                   9821:                     $defquota = 500;
                   9822:                 }
1.1075.2.41  raeburn  9823:             } else {
                   9824:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   9825:             }
                   9826:             if ($quota eq '') {
                   9827:                 $quota = $defquota;
                   9828:                 $quotatype = 'default';
                   9829:             } else {
                   9830:                 $quotatype = 'custom';
                   9831:             }
1.472     raeburn  9832:         }
                   9833:     }
1.536     raeburn  9834:     if (wantarray) {
                   9835:         return ($quota,$quotatype,$settingstatus,$defquota);
                   9836:     } else {
                   9837:         return $quota;
                   9838:     }
1.472     raeburn  9839: }
                   9840: 
                   9841: ###############################################
                   9842: 
                   9843: =pod
                   9844: 
                   9845: =item * &default_quota()
                   9846: 
1.536     raeburn  9847: Retrieves default quota assigned for storage of user portfolio files,
                   9848: given an (optional) user's institutional status.
1.472     raeburn  9849: 
                   9850: Incoming parameters:
1.1075.2.42  raeburn  9851: 
1.472     raeburn  9852: 1. domain
1.536     raeburn  9853: 2. (Optional) institutional status(es).  This is a : separated list of 
                   9854:    status types (e.g., faculty, staff, student etc.)
                   9855:    which apply to the user for whom the default is being retrieved.
                   9856:    If the institutional status string in undefined, the domain
1.1075.2.41  raeburn  9857:    default quota will be returned.
                   9858: 3.  quota name - portfolio, author, or course
                   9859:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  9860: 
                   9861: Returns:
1.1075.2.42  raeburn  9862: 
1.1075.2.58  raeburn  9863: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  9864: 2. (Optional) institutional type which determined the value of the
                   9865:    default quota.
1.472     raeburn  9866: 
                   9867: If a value has been stored in the domain's configuration db,
                   9868: it will return that, otherwise it returns 20 (for backwards 
                   9869: compatibility with domains which have not set up a configuration
1.1075.2.58  raeburn  9870: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  9871: 
1.536     raeburn  9872: If the user's status includes multiple types (e.g., staff and student),
                   9873: the largest default quota which applies to the user determines the
                   9874: default quota returned.
                   9875: 
1.472     raeburn  9876: =cut
                   9877: 
                   9878: ###############################################
                   9879: 
                   9880: 
                   9881: sub default_quota {
1.1075.2.41  raeburn  9882:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  9883:     my ($defquota,$settingstatus);
                   9884:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  9885:                                             ['quotas'],$udom);
1.1075.2.41  raeburn  9886:     my $key = 'defaultquota';
                   9887:     if ($quotaname eq 'author') {
                   9888:         $key = 'authorquota';
                   9889:     }
1.622     raeburn  9890:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  9891:         if ($inststatus ne '') {
1.765     raeburn  9892:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  9893:             foreach my $item (@statuses) {
1.1075.2.41  raeburn  9894:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9895:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  9896:                         if ($defquota eq '') {
1.1075.2.41  raeburn  9897:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9898:                             $settingstatus = $item;
1.1075.2.41  raeburn  9899:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   9900:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  9901:                             $settingstatus = $item;
                   9902:                         }
                   9903:                     }
1.1075.2.41  raeburn  9904:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  9905:                     if ($quotahash{'quotas'}{$item} ne '') {
                   9906:                         if ($defquota eq '') {
                   9907:                             $defquota = $quotahash{'quotas'}{$item};
                   9908:                             $settingstatus = $item;
                   9909:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   9910:                             $defquota = $quotahash{'quotas'}{$item};
                   9911:                             $settingstatus = $item;
                   9912:                         }
1.536     raeburn  9913:                     }
                   9914:                 }
                   9915:             }
                   9916:         }
                   9917:         if ($defquota eq '') {
1.1075.2.41  raeburn  9918:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   9919:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   9920:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  9921:                 $defquota = $quotahash{'quotas'}{'default'};
                   9922:             }
1.536     raeburn  9923:             $settingstatus = 'default';
1.1075.2.42  raeburn  9924:             if ($defquota eq '') {
                   9925:                 if ($quotaname eq 'author') {
                   9926:                     $defquota = 500;
                   9927:                 }
                   9928:             }
1.536     raeburn  9929:         }
                   9930:     } else {
                   9931:         $settingstatus = 'default';
1.1075.2.41  raeburn  9932:         if ($quotaname eq 'author') {
                   9933:             $defquota = 500;
                   9934:         } else {
                   9935:             $defquota = 20;
                   9936:         }
1.536     raeburn  9937:     }
                   9938:     if (wantarray) {
                   9939:         return ($defquota,$settingstatus);
1.472     raeburn  9940:     } else {
1.536     raeburn  9941:         return $defquota;
1.472     raeburn  9942:     }
                   9943: }
                   9944: 
1.1075.2.41  raeburn  9945: ###############################################
                   9946: 
                   9947: =pod
                   9948: 
1.1075.2.42  raeburn  9949: =item * &excess_filesize_warning()
1.1075.2.41  raeburn  9950: 
                   9951: Returns warning message if upload of file to authoring space, or copying
1.1075.2.42  raeburn  9952: of existing file within authoring space will cause quota for the authoring
                   9953: space to be exceeded.
                   9954: 
                   9955: Same, if upload of a file directly to a course/community via Course Editor
                   9956: will cause quota for uploaded content for the course to be exceeded.
1.1075.2.41  raeburn  9957: 
1.1075.2.61  raeburn  9958: Inputs: 7 
1.1075.2.42  raeburn  9959: 1. username or coursenum
1.1075.2.41  raeburn  9960: 2. domain
1.1075.2.42  raeburn  9961: 3. context ('author' or 'course')
1.1075.2.41  raeburn  9962: 4. filename of file for which action is being requested
                   9963: 5. filesize (kB) of file
                   9964: 6. action being taken: copy or upload.
1.1075.2.59  raeburn  9965: 7. quotatype (in course context -- official, unofficial, community or textbook).
1.1075.2.41  raeburn  9966: 
                   9967: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
                   9968:          otherwise return null.
                   9969: 
1.1075.2.42  raeburn  9970: =back
                   9971: 
1.1075.2.41  raeburn  9972: =cut
                   9973: 
1.1075.2.42  raeburn  9974: sub excess_filesize_warning {
1.1075.2.59  raeburn  9975:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1075.2.42  raeburn  9976:     my $current_disk_usage = 0;
1.1075.2.59  raeburn  9977:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1075.2.42  raeburn  9978:     if ($context eq 'author') {
                   9979:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   9980:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   9981:     } else {
                   9982:         foreach my $subdir ('docs','supplemental') {
                   9983:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   9984:         }
                   9985:     }
1.1075.2.41  raeburn  9986:     $disk_quota = int($disk_quota * 1000);
                   9987:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1075.2.69  raeburn  9988:         return '<p class="LC_warning">'.
1.1075.2.41  raeburn  9989:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1075.2.69  raeburn  9990:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   9991:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1075.2.41  raeburn  9992:                             $disk_quota,$current_disk_usage).
                   9993:                '</p>';
                   9994:     }
                   9995:     return;
                   9996: }
                   9997: 
                   9998: ###############################################
                   9999: 
                   10000: 
1.384     raeburn  10001: sub get_secgrprole_info {
                   10002:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   10003:     my %sections_count = &get_sections($cdom,$cnum);
                   10004:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   10005:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   10006:     my @groups = sort(keys(%curr_groups));
                   10007:     my $allroles = [];
                   10008:     my $rolehash;
                   10009:     my $accesshash = {
                   10010:                      active => 'Currently has access',
                   10011:                      future => 'Will have future access',
                   10012:                      previous => 'Previously had access',
                   10013:                   };
                   10014:     if ($needroles) {
                   10015:         $rolehash = {'all' => 'all'};
1.385     albertel 10016:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   10017: 	if (&Apache::lonnet::error(%user_roles)) {
                   10018: 	    undef(%user_roles);
                   10019: 	}
                   10020:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  10021:             my ($role)=split(/\:/,$item,2);
                   10022:             if ($role eq 'cr') { next; }
                   10023:             if ($role =~ /^cr/) {
                   10024:                 $$rolehash{$role} = (split('/',$role))[3];
                   10025:             } else {
                   10026:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   10027:             }
                   10028:         }
                   10029:         foreach my $key (sort(keys(%{$rolehash}))) {
                   10030:             push(@{$allroles},$key);
                   10031:         }
                   10032:         push (@{$allroles},'st');
                   10033:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   10034:     }
                   10035:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   10036: }
                   10037: 
1.555     raeburn  10038: sub user_picker {
1.1075.2.127  raeburn  10039:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  10040:     my $currdom = $dom;
1.1075.2.114  raeburn  10041:     my @alldoms = &Apache::lonnet::all_domains();
                   10042:     if (@alldoms == 1) {
                   10043:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   10044:                                                ['directorysrch'],$alldoms[0]);
                   10045:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   10046:         my $showdom = $domdesc;
                   10047:         if ($showdom eq '') {
                   10048:             $showdom = $dom;
                   10049:         }
                   10050:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   10051:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   10052:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   10053:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   10054:             }
                   10055:         }
                   10056:     }
1.555     raeburn  10057:     my %curr_selected = (
                   10058:                         srchin => 'dom',
1.580     raeburn  10059:                         srchby => 'lastname',
1.555     raeburn  10060:                       );
                   10061:     my $srchterm;
1.625     raeburn  10062:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  10063:         if ($srch->{'srchby'} ne '') {
                   10064:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   10065:         }
                   10066:         if ($srch->{'srchin'} ne '') {
                   10067:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   10068:         }
                   10069:         if ($srch->{'srchtype'} ne '') {
                   10070:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   10071:         }
                   10072:         if ($srch->{'srchdomain'} ne '') {
                   10073:             $currdom = $srch->{'srchdomain'};
                   10074:         }
                   10075:         $srchterm = $srch->{'srchterm'};
                   10076:     }
1.1075.2.98  raeburn  10077:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  10078:                     'usr'       => 'Search criteria',
1.563     raeburn  10079:                     'doma'      => 'Domain/institution to search',
1.558     albertel 10080:                     'uname'     => 'username',
                   10081:                     'lastname'  => 'last name',
1.555     raeburn  10082:                     'lastfirst' => 'last name, first name',
1.558     albertel 10083:                     'crs'       => 'in this course',
1.576     raeburn  10084:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 10085:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  10086:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 10087:                     'exact'     => 'is',
                   10088:                     'contains'  => 'contains',
1.569     raeburn  10089:                     'begins'    => 'begins with',
1.1075.2.98  raeburn  10090:                                        );
                   10091:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  10092:                     'youm'      => "You must include some text to search for.",
                   10093:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   10094:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   10095:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   10096:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   10097:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   10098:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   10099:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  10100:                                        );
1.1075.2.98  raeburn  10101:     &html_escape(\%html_lt);
                   10102:     &js_escape(\%js_lt);
1.1075.2.115  raeburn  10103:     my $domform;
1.1075.2.126  raeburn  10104:     my $allow_blank = 1;
1.1075.2.115  raeburn  10105:     if ($fixeddom) {
1.1075.2.126  raeburn  10106:         $allow_blank = 0;
                   10107:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1075.2.115  raeburn  10108:     } else {
1.1075.2.126  raeburn  10109:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1);
1.1075.2.115  raeburn  10110:     }
1.563     raeburn  10111:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  10112: 
                   10113:     my @srchins = ('crs','dom','alc','instd');
                   10114: 
                   10115:     foreach my $option (@srchins) {
                   10116:         # FIXME 'alc' option unavailable until 
                   10117:         #       loncreateuser::print_user_query_page()
                   10118:         #       has been completed.
                   10119:         next if ($option eq 'alc');
1.880     raeburn  10120:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  10121:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1075.2.127  raeburn  10122:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  10123:         if ($curr_selected{'srchin'} eq $option) {
                   10124:             $srchinsel .= ' 
1.1075.2.98  raeburn  10125:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  10126:         } else {
                   10127:             $srchinsel .= '
1.1075.2.98  raeburn  10128:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  10129:         }
1.555     raeburn  10130:     }
1.563     raeburn  10131:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  10132: 
                   10133:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  10134:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  10135:         if ($curr_selected{'srchby'} eq $option) {
                   10136:             $srchbysel .= '
1.1075.2.98  raeburn  10137:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10138:         } else {
                   10139:             $srchbysel .= '
1.1075.2.98  raeburn  10140:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10141:          }
                   10142:     }
                   10143:     $srchbysel .= "\n  </select>\n";
                   10144: 
                   10145:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  10146:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  10147:         if ($curr_selected{'srchtype'} eq $option) {
                   10148:             $srchtypesel .= '
1.1075.2.98  raeburn  10149:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  10150:         } else {
                   10151:             $srchtypesel .= '
1.1075.2.98  raeburn  10152:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  10153:         }
                   10154:     }
                   10155:     $srchtypesel .= "\n  </select>\n";
                   10156: 
1.558     albertel 10157:     my ($newuserscript,$new_user_create);
1.994     raeburn  10158:     my $context_dom = $env{'request.role.domain'};
                   10159:     if ($context eq 'requestcrs') {
                   10160:         if ($env{'form.coursedom'} ne '') { 
                   10161:             $context_dom = $env{'form.coursedom'};
                   10162:         }
                   10163:     }
1.556     raeburn  10164:     if ($forcenewuser) {
1.576     raeburn  10165:         if (ref($srch) eq 'HASH') {
1.994     raeburn  10166:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  10167:                 if ($cancreate) {
                   10168:                     $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>';
                   10169:                 } else {
1.799     bisitz   10170:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  10171:                     my %usertypetext = (
                   10172:                         official   => 'institutional',
                   10173:                         unofficial => 'non-institutional',
                   10174:                     );
1.799     bisitz   10175:                     $new_user_create = '<p class="LC_warning">'
                   10176:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   10177:                                       .' '
                   10178:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   10179:                                           ,'<a href="'.$helplink.'">','</a>')
                   10180:                                       .'</p><br />';
1.627     raeburn  10181:                 }
1.576     raeburn  10182:             }
                   10183:         }
                   10184: 
1.556     raeburn  10185:         $newuserscript = <<"ENDSCRIPT";
                   10186: 
1.570     raeburn  10187: function setSearch(createnew,callingForm) {
1.556     raeburn  10188:     if (createnew == 1) {
1.570     raeburn  10189:         for (var i=0; i<callingForm.srchby.length; i++) {
                   10190:             if (callingForm.srchby.options[i].value == 'uname') {
                   10191:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  10192:             }
                   10193:         }
1.570     raeburn  10194:         for (var i=0; i<callingForm.srchin.length; i++) {
                   10195:             if ( callingForm.srchin.options[i].value == 'dom') {
                   10196: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  10197:             }
                   10198:         }
1.570     raeburn  10199:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   10200:             if (callingForm.srchtype.options[i].value == 'exact') {
                   10201:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  10202:             }
                   10203:         }
1.570     raeburn  10204:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  10205:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  10206:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  10207:             }
                   10208:         }
                   10209:     }
                   10210: }
                   10211: ENDSCRIPT
1.558     albertel 10212: 
1.556     raeburn  10213:     }
                   10214: 
1.555     raeburn  10215:     my $output = <<"END_BLOCK";
1.556     raeburn  10216: <script type="text/javascript">
1.824     bisitz   10217: // <![CDATA[
1.570     raeburn  10218: function validateEntry(callingForm) {
1.558     albertel 10219: 
1.556     raeburn  10220:     var checkok = 1;
1.558     albertel 10221:     var srchin;
1.570     raeburn  10222:     for (var i=0; i<callingForm.srchin.length; i++) {
                   10223: 	if ( callingForm.srchin[i].checked ) {
                   10224: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 10225: 	}
                   10226:     }
                   10227: 
1.570     raeburn  10228:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   10229:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   10230:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   10231:     var srchterm =  callingForm.srchterm.value;
                   10232:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  10233:     var msg = "";
                   10234: 
                   10235:     if (srchterm == "") {
                   10236:         checkok = 0;
1.1075.2.98  raeburn  10237:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  10238:     }
                   10239: 
1.569     raeburn  10240:     if (srchtype== 'begins') {
                   10241:         if (srchterm.length < 2) {
                   10242:             checkok = 0;
1.1075.2.98  raeburn  10243:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  10244:         }
                   10245:     }
                   10246: 
1.556     raeburn  10247:     if (srchtype== 'contains') {
                   10248:         if (srchterm.length < 3) {
                   10249:             checkok = 0;
1.1075.2.98  raeburn  10250:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  10251:         }
                   10252:     }
                   10253:     if (srchin == 'instd') {
                   10254:         if (srchdomain == '') {
                   10255:             checkok = 0;
1.1075.2.98  raeburn  10256:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  10257:         }
                   10258:     }
                   10259:     if (srchin == 'dom') {
                   10260:         if (srchdomain == '') {
                   10261:             checkok = 0;
1.1075.2.98  raeburn  10262:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  10263:         }
                   10264:     }
                   10265:     if (srchby == 'lastfirst') {
                   10266:         if (srchterm.indexOf(",") == -1) {
                   10267:             checkok = 0;
1.1075.2.98  raeburn  10268:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  10269:         }
                   10270:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   10271:             checkok = 0;
1.1075.2.98  raeburn  10272:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  10273:         }
                   10274:     }
                   10275:     if (checkok == 0) {
1.1075.2.98  raeburn  10276:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  10277:         return;
                   10278:     }
                   10279:     if (checkok == 1) {
1.570     raeburn  10280:         callingForm.submit();
1.556     raeburn  10281:     }
                   10282: }
                   10283: 
                   10284: $newuserscript
                   10285: 
1.824     bisitz   10286: // ]]>
1.556     raeburn  10287: </script>
1.558     albertel 10288: 
                   10289: $new_user_create
                   10290: 
1.555     raeburn  10291: END_BLOCK
1.558     albertel 10292: 
1.876     raeburn  10293:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1075.2.98  raeburn  10294:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  10295:                $domform.
                   10296:                &Apache::lonhtmlcommon::row_closure().
1.1075.2.98  raeburn  10297:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  10298:                $srchbysel.
                   10299:                $srchtypesel. 
                   10300:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   10301:                $srchinsel.
                   10302:                &Apache::lonhtmlcommon::row_closure(1). 
                   10303:                &Apache::lonhtmlcommon::end_pick_box().
                   10304:                '<br />';
1.1075.2.114  raeburn  10305:     return ($output,1);
1.555     raeburn  10306: }
                   10307: 
1.612     raeburn  10308: sub user_rule_check {
1.615     raeburn  10309:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1075.2.99  raeburn  10310:     my ($response,%inst_response);
1.612     raeburn  10311:     if (ref($usershash) eq 'HASH') {
1.1075.2.99  raeburn  10312:         if (keys(%{$usershash}) > 1) {
                   10313:             my (%by_username,%by_id,%userdoms);
                   10314:             my $checkid;
1.612     raeburn  10315:             if (ref($checks) eq 'HASH') {
1.1075.2.99  raeburn  10316:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   10317:                     $checkid = 1;
                   10318:                 }
                   10319:             }
                   10320:             foreach my $user (keys(%{$usershash})) {
                   10321:                 my ($uname,$udom) = split(/:/,$user);
                   10322:                 if ($checkid) {
                   10323:                     if (ref($usershash->{$user}) eq 'HASH') {
                   10324:                         if ($usershash->{$user}->{'id'} ne '') {
                   10325:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname;
                   10326:                             $userdoms{$udom} = 1;
                   10327:                             if (ref($inst_results) eq 'HASH') {
                   10328:                                 $inst_results->{$uname.':'.$udom} = {};
                   10329:                             }
                   10330:                         }
                   10331:                     }
                   10332:                 } else {
                   10333:                     $by_username{$udom}{$uname} = 1;
                   10334:                     $userdoms{$udom} = 1;
                   10335:                     if (ref($inst_results) eq 'HASH') {
                   10336:                         $inst_results->{$uname.':'.$udom} = {};
                   10337:                     }
                   10338:                 }
                   10339:             }
                   10340:             foreach my $udom (keys(%userdoms)) {
                   10341:                 if (!$got_rules->{$udom}) {
                   10342:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10343:                                                              ['usercreation'],$udom);
                   10344:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10345:                         foreach my $item ('username','id') {
                   10346:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10347:                                 $$curr_rules{$udom}{$item} =
                   10348:                                     $domconfig{'usercreation'}{$item.'_rule'};
                   10349:                             }
                   10350:                         }
                   10351:                     }
                   10352:                     $got_rules->{$udom} = 1;
                   10353:                 }
                   10354:             }
                   10355:             if ($checkid) {
                   10356:                 foreach my $udom (keys(%by_id)) {
                   10357:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   10358:                     if ($outcome eq 'ok') {
                   10359:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   10360:                             my $uname = $by_id{$udom}{$id};
                   10361:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10362:                         }
                   10363:                         if (ref($results) eq 'HASH') {
                   10364:                             foreach my $uname (keys(%{$results})) {
                   10365:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   10366:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   10367:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10368:                                 }
                   10369:                             }
                   10370:                         }
                   10371:                     }
1.612     raeburn  10372:                 }
1.615     raeburn  10373:             } else {
1.1075.2.99  raeburn  10374:                 foreach my $udom (keys(%by_username)) {
                   10375:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   10376:                     if ($outcome eq 'ok') {
                   10377:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   10378:                             $inst_response{$uname.':'.$udom} = $outcome;
                   10379:                         }
                   10380:                         if (ref($results) eq 'HASH') {
                   10381:                             foreach my $uname (keys(%{$results})) {
                   10382:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   10383:                             }
                   10384:                         }
                   10385:                     }
                   10386:                 }
1.612     raeburn  10387:             }
1.1075.2.99  raeburn  10388:         } elsif (keys(%{$usershash}) == 1) {
                   10389:             my $user = (keys(%{$usershash}))[0];
                   10390:             my ($uname,$udom) = split(/:/,$user);
                   10391:             if (($udom ne '') && ($uname ne '')) {
                   10392:                 if (ref($usershash->{$user}) eq 'HASH') {
                   10393:                     if (ref($checks) eq 'HASH') {
                   10394:                         if (defined($checks->{'username'})) {
                   10395:                             ($inst_response{$user},%{$inst_results->{$user}}) =
                   10396:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   10397:                         } elsif (defined($checks->{'id'})) {
                   10398:                             if ($usershash->{$user}->{'id'} ne '') {
                   10399:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10400:                                     &Apache::lonnet::get_instuser($udom,undef,
                   10401:                                                                   $usershash->{$user}->{'id'});
                   10402:                             } else {
                   10403:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   10404:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   10405:                             }
                   10406:                         }
                   10407:                     } else {
                   10408:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   10409:                             &Apache::lonnet::get_instuser($udom,$uname);
                   10410:                        return;
                   10411:                     }
                   10412:                     if (!$got_rules->{$udom}) {
                   10413:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   10414:                                                                  ['usercreation'],$udom);
                   10415:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   10416:                             foreach my $item ('username','id') {
                   10417:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   10418:                                    $$curr_rules{$udom}{$item} =
                   10419:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   10420:                                 }
                   10421:                             }
1.585     raeburn  10422:                         }
1.1075.2.99  raeburn  10423:                         $got_rules->{$udom} = 1;
1.585     raeburn  10424:                     }
                   10425:                 }
1.1075.2.99  raeburn  10426:             } else {
                   10427:                 return;
                   10428:             }
                   10429:         } else {
                   10430:             return;
                   10431:         }
                   10432:         foreach my $user (keys(%{$usershash})) {
                   10433:             my ($uname,$udom) = split(/:/,$user);
                   10434:             next if (($udom eq '') || ($uname eq ''));
                   10435:             my $id;
                   10436:             if (ref($inst_results) eq 'HASH') {
                   10437:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   10438:                     $id = $inst_results->{$user}->{'id'};
                   10439:                 }
                   10440:             }
                   10441:             if ($id eq '') {
                   10442:                 if (ref($usershash->{$user})) {
                   10443:                     $id = $usershash->{$user}->{'id'};
                   10444:                 }
1.585     raeburn  10445:             }
1.612     raeburn  10446:             foreach my $item (keys(%{$checks})) {
                   10447:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   10448:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   10449:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1075.2.99  raeburn  10450:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   10451:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  10452:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   10453:                                 if ($rule_check{$rule}) {
                   10454:                                     $$rulematch{$user}{$item} = $rule;
1.1075.2.99  raeburn  10455:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  10456:                                         if (ref($inst_results) eq 'HASH') {
                   10457:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   10458:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   10459:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1075.2.99  raeburn  10460:                                                 } elsif ($item eq 'id') {
                   10461:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   10462:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   10463:                                                     }
1.615     raeburn  10464:                                                 }
1.612     raeburn  10465:                                             }
                   10466:                                         }
1.615     raeburn  10467:                                     }
                   10468:                                     last;
1.585     raeburn  10469:                                 }
                   10470:                             }
                   10471:                         }
                   10472:                     }
                   10473:                 }
                   10474:             }
                   10475:         }
                   10476:     }
1.612     raeburn  10477:     return;
                   10478: }
                   10479: 
                   10480: sub user_rule_formats {
                   10481:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   10482:     my %text = ( 
                   10483:                  'username' => 'Usernames',
                   10484:                  'id'       => 'IDs',
                   10485:                );
                   10486:     my $output;
                   10487:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   10488:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   10489:         if (@{$ruleorder} > 0) {
1.1075.2.20  raeburn  10490:             $output = '<br />'.
                   10491:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   10492:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   10493:                       ' <ul>';
1.612     raeburn  10494:             foreach my $rule (@{$ruleorder}) {
                   10495:                 if (ref($curr_rules) eq 'ARRAY') {
                   10496:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   10497:                         if (ref($rules->{$rule}) eq 'HASH') {
                   10498:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   10499:                                         $rules->{$rule}{'desc'}.'</li>';
                   10500:                         }
                   10501:                     }
                   10502:                 }
                   10503:             }
                   10504:             $output .= '</ul>';
                   10505:         }
                   10506:     }
                   10507:     return $output;
                   10508: }
                   10509: 
                   10510: sub instrule_disallow_msg {
1.615     raeburn  10511:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  10512:     my $response;
                   10513:     my %text = (
                   10514:                   item   => 'username',
                   10515:                   items  => 'usernames',
                   10516:                   match  => 'matches',
                   10517:                   do     => 'does',
                   10518:                   action => 'a username',
                   10519:                   one    => 'one',
                   10520:                );
                   10521:     if ($count > 1) {
                   10522:         $text{'item'} = 'usernames';
                   10523:         $text{'match'} ='match';
                   10524:         $text{'do'} = 'do';
                   10525:         $text{'action'} = 'usernames',
                   10526:         $text{'one'} = 'ones';
                   10527:     }
                   10528:     if ($checkitem eq 'id') {
                   10529:         $text{'items'} = 'IDs';
                   10530:         $text{'item'} = 'ID';
                   10531:         $text{'action'} = 'an ID';
1.615     raeburn  10532:         if ($count > 1) {
                   10533:             $text{'item'} = 'IDs';
                   10534:             $text{'action'} = 'IDs';
                   10535:         }
1.612     raeburn  10536:     }
1.674     bisitz   10537:     $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  10538:     if ($mode eq 'upload') {
                   10539:         if ($checkitem eq 'username') {
                   10540:             $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'}.");
                   10541:         } elsif ($checkitem eq 'id') {
1.674     bisitz   10542:             $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  10543:         }
1.669     raeburn  10544:     } elsif ($mode eq 'selfcreate') {
                   10545:         if ($checkitem eq 'id') {
                   10546:             $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.");
                   10547:         }
1.615     raeburn  10548:     } else {
                   10549:         if ($checkitem eq 'username') {
                   10550:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   10551:         } elsif ($checkitem eq 'id') {
                   10552:             $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.");
                   10553:         }
1.612     raeburn  10554:     }
                   10555:     return $response;
1.585     raeburn  10556: }
                   10557: 
1.624     raeburn  10558: sub personal_data_fieldtitles {
                   10559:     my %fieldtitles = &Apache::lonlocal::texthash (
                   10560:                         id => 'Student/Employee ID',
                   10561:                         permanentemail => 'E-mail address',
                   10562:                         lastname => 'Last Name',
                   10563:                         firstname => 'First Name',
                   10564:                         middlename => 'Middle Name',
                   10565:                         generation => 'Generation',
                   10566:                         gen => 'Generation',
1.765     raeburn  10567:                         inststatus => 'Affiliation',
1.624     raeburn  10568:                    );
                   10569:     return %fieldtitles;
                   10570: }
                   10571: 
1.642     raeburn  10572: sub sorted_inst_types {
                   10573:     my ($dom) = @_;
1.1075.2.70  raeburn  10574:     my ($usertypes,$order);
                   10575:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   10576:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   10577:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   10578:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   10579:     } else {
                   10580:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   10581:     }
1.642     raeburn  10582:     my $othertitle = &mt('All users');
                   10583:     if ($env{'request.course.id'}) {
1.668     raeburn  10584:         $othertitle  = &mt('Any users');
1.642     raeburn  10585:     }
                   10586:     my @types;
                   10587:     if (ref($order) eq 'ARRAY') {
                   10588:         @types = @{$order};
                   10589:     }
                   10590:     if (@types == 0) {
                   10591:         if (ref($usertypes) eq 'HASH') {
                   10592:             @types = sort(keys(%{$usertypes}));
                   10593:         }
                   10594:     }
                   10595:     if (keys(%{$usertypes}) > 0) {
                   10596:         $othertitle = &mt('Other users');
                   10597:     }
                   10598:     return ($othertitle,$usertypes,\@types);
                   10599: }
                   10600: 
1.645     raeburn  10601: sub get_institutional_codes {
1.1075.2.157  raeburn  10602:     my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645     raeburn  10603: # Get complete list of course sections to update
                   10604:     my @currsections = ();
                   10605:     my @currxlists = ();
1.1075.2.157  raeburn  10606:     my (%unclutteredsec,%unclutteredlcsec);
1.645     raeburn  10607:     my $coursecode = $$settings{'internal.coursecode'};
1.1075.2.157  raeburn  10608:     my $crskey = $crs.':'.$coursecode;
                   10609:     @{$unclutteredsec{$crskey}} = ();
                   10610:     @{$unclutteredlcsec{$crskey}} = ();
1.645     raeburn  10611: 
                   10612:     if ($$settings{'internal.sectionnums'} ne '') {
                   10613:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   10614:     }
                   10615: 
                   10616:     if ($$settings{'internal.crosslistings'} ne '') {
                   10617:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   10618:     }
                   10619: 
                   10620:     if (@currxlists > 0) {
1.1075.2.157  raeburn  10621:         foreach my $xl (@currxlists) {
                   10622:             if ($xl =~ /^([^:]+):(\w*)$/) {
1.645     raeburn  10623:                 unless (grep/^$1$/,@{$allcourses}) {
1.1075.2.119  raeburn  10624:                     push(@{$allcourses},$1);
1.645     raeburn  10625:                     $$LC_code{$1} = $2;
                   10626:                 }
                   10627:             }
                   10628:         }
                   10629:     }
1.1075.2.157  raeburn  10630: 
1.645     raeburn  10631:     if (@currsections > 0) {
1.1075.2.157  raeburn  10632:         foreach my $sec (@currsections) {
                   10633:             if ($sec =~ m/^(\w+):(\w*)$/ ) {
                   10634:                 my $instsec = $1;
1.645     raeburn  10635:                 my $lc_sec = $2;
1.1075.2.157  raeburn  10636:                 unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
                   10637:                     push(@{$unclutteredsec{$crskey}},$instsec);
                   10638:                     push(@{$unclutteredlcsec{$crskey}},$lc_sec);
                   10639:                 }
                   10640:             }
                   10641:         }
                   10642:     }
                   10643: 
                   10644:     if (@{$unclutteredsec{$crskey}} > 0) {
                   10645:         my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
                   10646:         if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
                   10647:             for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
                   10648:                 my $sec = $coursecode.$formattedsec{$crskey}[$i];
                   10649:                 unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1075.2.119  raeburn  10650:                     push(@{$allcourses},$sec);
1.1075.2.157  raeburn  10651:                     $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645     raeburn  10652:                 }
                   10653:             }
                   10654:         }
                   10655:     }
                   10656:     return;
                   10657: }
                   10658: 
1.971     raeburn  10659: sub get_standard_codeitems {
                   10660:     return ('Year','Semester','Department','Number','Section');
                   10661: }
                   10662: 
1.112     bowersj2 10663: =pod
                   10664: 
1.780     raeburn  10665: =head1 Slot Helpers
                   10666: 
                   10667: =over 4
                   10668: 
                   10669: =item * sorted_slots()
                   10670: 
1.1040    raeburn  10671: Sorts an array of slot names in order of an optional sort key,
                   10672: default sort is by slot start time (earliest first). 
1.780     raeburn  10673: 
                   10674: Inputs:
                   10675: 
                   10676: =over 4
                   10677: 
                   10678: slotsarr  - Reference to array of unsorted slot names.
                   10679: 
                   10680: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   10681: 
1.1040    raeburn  10682: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   10683: 
1.549     albertel 10684: =back
                   10685: 
1.780     raeburn  10686: Returns:
                   10687: 
                   10688: =over 4
                   10689: 
1.1040    raeburn  10690: sorted   - An array of slot names sorted by a specified sort key 
                   10691:            (default sort key is start time of the slot).
1.780     raeburn  10692: 
                   10693: =back
                   10694: 
                   10695: =cut
                   10696: 
                   10697: 
                   10698: sub sorted_slots {
1.1040    raeburn  10699:     my ($slotsarr,$slots,$sortkey) = @_;
                   10700:     if ($sortkey eq '') {
                   10701:         $sortkey = 'starttime';
                   10702:     }
1.780     raeburn  10703:     my @sorted;
                   10704:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   10705:         @sorted =
                   10706:             sort {
                   10707:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  10708:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  10709:                      }
                   10710:                      if (ref($slots->{$a})) { return -1;}
                   10711:                      if (ref($slots->{$b})) { return 1;}
                   10712:                      return 0;
                   10713:                  } @{$slotsarr};
                   10714:     }
                   10715:     return @sorted;
                   10716: }
                   10717: 
1.1040    raeburn  10718: =pod
                   10719: 
                   10720: =item * get_future_slots()
                   10721: 
                   10722: Inputs:
                   10723: 
                   10724: =over 4
                   10725: 
                   10726: cnum - course number
                   10727: 
                   10728: cdom - course domain
                   10729: 
                   10730: now - current UNIX time
                   10731: 
                   10732: symb - optional symb
                   10733: 
                   10734: =back
                   10735: 
                   10736: Returns:
                   10737: 
                   10738: =over 4
                   10739: 
                   10740: sorted_reservable - ref to array of student_schedulable slots currently 
                   10741:                     reservable, ordered by end date of reservation period.
                   10742: 
                   10743: reservable_now - ref to hash of student_schedulable slots currently
                   10744:                  reservable.
                   10745: 
                   10746:     Keys in inner hash are:
                   10747:     (a) symb: either blank or symb to which slot use is restricted.
1.1075.2.104  raeburn  10748:     (b) endreserve: end date of reservation period.
                   10749:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10750:         selected.
1.1040    raeburn  10751: 
                   10752: sorted_future - ref to array of student_schedulable slots reservable in
                   10753:                 the future, ordered by start date of reservation period.
                   10754: 
                   10755: future_reservable - ref to hash of student_schedulable slots reservable
                   10756:                     in the future.
                   10757: 
                   10758:     Keys in inner hash are:
                   10759:     (a) symb: either blank or symb to which slot use is restricted.
                   10760:     (b) startreserve:  start date of reservation period.
1.1075.2.104  raeburn  10761:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   10762:         selected.
1.1040    raeburn  10763: 
                   10764: =back
                   10765: 
                   10766: =cut
                   10767: 
                   10768: sub get_future_slots {
                   10769:     my ($cnum,$cdom,$now,$symb) = @_;
                   10770:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   10771:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   10772:     foreach my $slot (keys(%slots)) {
                   10773:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   10774:         if ($symb) {
                   10775:             next if (($slots{$slot}->{'symb'} ne '') && 
                   10776:                      ($slots{$slot}->{'symb'} ne $symb));
                   10777:         }
                   10778:         if (($slots{$slot}->{'starttime'} > $now) &&
                   10779:             ($slots{$slot}->{'endtime'} > $now)) {
                   10780:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   10781:                 my $userallowed = 0;
                   10782:                 if ($slots{$slot}->{'allowedsections'}) {
                   10783:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   10784:                     if (!defined($env{'request.role.sec'})
                   10785:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   10786:                         $userallowed=1;
                   10787:                     } else {
                   10788:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   10789:                             $userallowed=1;
                   10790:                         }
                   10791:                     }
                   10792:                     unless ($userallowed) {
                   10793:                         if (defined($env{'request.course.groups'})) {
                   10794:                             my @groups = split(/:/,$env{'request.course.groups'});
                   10795:                             foreach my $group (@groups) {
                   10796:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   10797:                                     $userallowed=1;
                   10798:                                     last;
                   10799:                                 }
                   10800:                             }
                   10801:                         }
                   10802:                     }
                   10803:                 }
                   10804:                 if ($slots{$slot}->{'allowedusers'}) {
                   10805:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   10806:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   10807:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   10808:                         $userallowed = 1;
                   10809:                     }
                   10810:                 }
                   10811:                 next unless($userallowed);
                   10812:             }
                   10813:             my $startreserve = $slots{$slot}->{'startreserve'};
                   10814:             my $endreserve = $slots{$slot}->{'endreserve'};
                   10815:             my $symb = $slots{$slot}->{'symb'};
1.1075.2.104  raeburn  10816:             my $uniqueperiod;
                   10817:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   10818:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   10819:             }
1.1040    raeburn  10820:             if (($startreserve < $now) &&
                   10821:                 (!$endreserve || $endreserve > $now)) {
                   10822:                 my $lastres = $endreserve;
                   10823:                 if (!$lastres) {
                   10824:                     $lastres = $slots{$slot}->{'starttime'};
                   10825:                 }
                   10826:                 $reservable_now{$slot} = {
                   10827:                                            symb       => $symb,
1.1075.2.104  raeburn  10828:                                            endreserve => $lastres,
                   10829:                                            uniqueperiod => $uniqueperiod,   
1.1040    raeburn  10830:                                          };
                   10831:             } elsif (($startreserve > $now) &&
                   10832:                      (!$endreserve || $endreserve > $startreserve)) {
                   10833:                 $future_reservable{$slot} = {
                   10834:                                               symb         => $symb,
1.1075.2.104  raeburn  10835:                                               startreserve => $startreserve,
                   10836:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  10837:                                             };
                   10838:             }
                   10839:         }
                   10840:     }
                   10841:     my @unsorted_reservable = keys(%reservable_now);
                   10842:     if (@unsorted_reservable > 0) {
                   10843:         @sorted_reservable = 
                   10844:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   10845:     }
                   10846:     my @unsorted_future = keys(%future_reservable);
                   10847:     if (@unsorted_future > 0) {
                   10848:         @sorted_future =
                   10849:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   10850:     }
                   10851:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   10852: }
1.780     raeburn  10853: 
                   10854: =pod
                   10855: 
1.1057    foxr     10856: =back
                   10857: 
1.549     albertel 10858: =head1 HTTP Helpers
                   10859: 
                   10860: =over 4
                   10861: 
1.648     raeburn  10862: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 10863: 
1.258     albertel 10864: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 10865: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 10866: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 10867: 
                   10868: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   10869: $possible_names is an ref to an array of form element names.  As an example:
                   10870: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 10871: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 10872: 
                   10873: =cut
1.1       albertel 10874: 
1.6       albertel 10875: sub get_unprocessed_cgi {
1.25      albertel 10876:   my ($query,$possible_names)= @_;
1.26      matthew  10877:   # $Apache::lonxml::debug=1;
1.356     albertel 10878:   foreach my $pair (split(/&/,$query)) {
                   10879:     my ($name, $value) = split(/=/,$pair);
1.369     www      10880:     $name = &unescape($name);
1.25      albertel 10881:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   10882:       $value =~ tr/+/ /;
                   10883:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 10884:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 10885:     }
1.16      harris41 10886:   }
1.6       albertel 10887: }
                   10888: 
1.112     bowersj2 10889: =pod
                   10890: 
1.648     raeburn  10891: =item * &cacheheader() 
1.112     bowersj2 10892: 
                   10893: returns cache-controlling header code
                   10894: 
                   10895: =cut
                   10896: 
1.7       albertel 10897: sub cacheheader {
1.258     albertel 10898:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 10899:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   10900:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 10901:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   10902:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 10903:     return $output;
1.7       albertel 10904: }
                   10905: 
1.112     bowersj2 10906: =pod
                   10907: 
1.648     raeburn  10908: =item * &no_cache($r) 
1.112     bowersj2 10909: 
                   10910: specifies header code to not have cache
                   10911: 
                   10912: =cut
                   10913: 
1.9       albertel 10914: sub no_cache {
1.216     albertel 10915:     my ($r) = @_;
                   10916:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 10917: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 10918:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   10919:     $r->no_cache(1);
                   10920:     $r->header_out("Expires" => $date);
                   10921:     $r->header_out("Pragma" => "no-cache");
1.123     www      10922: }
                   10923: 
                   10924: sub content_type {
1.181     albertel 10925:     my ($r,$type,$charset) = @_;
1.299     foxr     10926:     if ($r) {
                   10927: 	#  Note that printout.pl calls this with undef for $r.
                   10928: 	&no_cache($r);
                   10929:     }
1.258     albertel 10930:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 10931:     unless ($charset) {
                   10932: 	$charset=&Apache::lonlocal::current_encoding;
                   10933:     }
                   10934:     if ($charset) { $type.='; charset='.$charset; }
                   10935:     if ($r) {
                   10936: 	$r->content_type($type);
                   10937:     } else {
                   10938: 	print("Content-type: $type\n\n");
                   10939:     }
1.9       albertel 10940: }
1.25      albertel 10941: 
1.112     bowersj2 10942: =pod
                   10943: 
1.648     raeburn  10944: =item * &add_to_env($name,$value) 
1.112     bowersj2 10945: 
1.258     albertel 10946: adds $name to the %env hash with value
1.112     bowersj2 10947: $value, if $name already exists, the entry is converted to an array
                   10948: reference and $value is added to the array.
                   10949: 
                   10950: =cut
                   10951: 
1.25      albertel 10952: sub add_to_env {
                   10953:   my ($name,$value)=@_;
1.258     albertel 10954:   if (defined($env{$name})) {
                   10955:     if (ref($env{$name})) {
1.25      albertel 10956:       #already have multiple values
1.258     albertel 10957:       push(@{ $env{$name} },$value);
1.25      albertel 10958:     } else {
                   10959:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 10960:       my $first=$env{$name};
                   10961:       undef($env{$name});
                   10962:       push(@{ $env{$name} },$first,$value);
1.25      albertel 10963:     }
                   10964:   } else {
1.258     albertel 10965:     $env{$name}=$value;
1.25      albertel 10966:   }
1.31      albertel 10967: }
1.149     albertel 10968: 
                   10969: =pod
                   10970: 
1.648     raeburn  10971: =item * &get_env_multiple($name) 
1.149     albertel 10972: 
1.258     albertel 10973: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 10974: values may be defined and end up as an array ref.
                   10975: 
                   10976: returns an array of values
                   10977: 
                   10978: =cut
                   10979: 
                   10980: sub get_env_multiple {
                   10981:     my ($name) = @_;
                   10982:     my @values;
1.258     albertel 10983:     if (defined($env{$name})) {
1.149     albertel 10984:         # exists is it an array
1.258     albertel 10985:         if (ref($env{$name})) {
                   10986:             @values=@{ $env{$name} };
1.149     albertel 10987:         } else {
1.258     albertel 10988:             $values[0]=$env{$name};
1.149     albertel 10989:         }
                   10990:     }
                   10991:     return(@values);
                   10992: }
                   10993: 
1.660     raeburn  10994: sub ask_for_embedded_content {
                   10995:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  10996:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1075.2.11  raeburn  10997:         %currsubfile,%unused,$rem);
1.1071    raeburn  10998:     my $counter = 0;
                   10999:     my $numnew = 0;
1.987     raeburn  11000:     my $numremref = 0;
                   11001:     my $numinvalid = 0;
                   11002:     my $numpathchg = 0;
                   11003:     my $numexisting = 0;
1.1071    raeburn  11004:     my $numunused = 0;
                   11005:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1075.2.53  raeburn  11006:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  11007:     my $heading = &mt('Upload embedded files');
                   11008:     my $buttontext = &mt('Upload');
                   11009: 
1.1075.2.11  raeburn  11010:     if ($env{'request.course.id'}) {
1.1075.2.35  raeburn  11011:         if ($actionurl eq '/adm/dependencies') {
                   11012:             $navmap = Apache::lonnavmaps::navmap->new();
                   11013:         }
                   11014:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   11015:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1075.2.11  raeburn  11016:     }
1.1075.2.35  raeburn  11017:     if (($actionurl eq '/adm/portfolio') ||
                   11018:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  11019:         my $current_path='/';
                   11020:         if ($env{'form.currentpath'}) {
                   11021:             $current_path = $env{'form.currentpath'};
                   11022:         }
                   11023:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1075.2.35  raeburn  11024:             $udom = $cdom;
                   11025:             $uname = $cnum;
1.984     raeburn  11026:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   11027:         } else {
                   11028:             $udom = $env{'user.domain'};
                   11029:             $uname = $env{'user.name'};
                   11030:             $url = '/userfiles/portfolio';
                   11031:         }
1.987     raeburn  11032:         $toplevel = $url.'/';
1.984     raeburn  11033:         $url .= $current_path;
                   11034:         $getpropath = 1;
1.987     raeburn  11035:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   11036:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      11037:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  11038:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  11039:         $toplevel = $url;
1.984     raeburn  11040:         if ($rest ne '') {
1.987     raeburn  11041:             $url .= $rest;
                   11042:         }
                   11043:     } elsif ($actionurl eq '/adm/coursedocs') {
                   11044:         if (ref($args) eq 'HASH') {
1.1071    raeburn  11045:             $url = $args->{'docs_url'};
                   11046:             $toplevel = $url;
1.1075.2.11  raeburn  11047:             if ($args->{'context'} eq 'paste') {
                   11048:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   11049:                 ($path) =
                   11050:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11051:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11052:                 $fileloc =~ s{^/}{};
                   11053:             }
1.1071    raeburn  11054:         }
                   11055:     } elsif ($actionurl eq '/adm/dependencies') {
                   11056:         if ($env{'request.course.id'} ne '') {
                   11057:             if (ref($args) eq 'HASH') {
                   11058:                 $url = $args->{'docs_url'};
                   11059:                 $title = $args->{'docs_title'};
1.1075.2.35  raeburn  11060:                 $toplevel = $url;
                   11061:                 unless ($toplevel =~ m{^/}) {
                   11062:                     $toplevel = "/$url";
                   11063:                 }
1.1075.2.11  raeburn  11064:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1075.2.35  raeburn  11065:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   11066:                     $path = $1;
                   11067:                 } else {
                   11068:                     ($path) =
                   11069:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   11070:                 }
1.1075.2.79  raeburn  11071:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   11072:                     $fileloc = $toplevel;
                   11073:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   11074:                     my ($udom,$uname,$fname) =
                   11075:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   11076:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   11077:                 } else {
                   11078:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   11079:                 }
1.1071    raeburn  11080:                 $fileloc =~ s{^/}{};
                   11081:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   11082:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   11083:             }
1.987     raeburn  11084:         }
1.1075.2.35  raeburn  11085:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11086:         $udom = $cdom;
                   11087:         $uname = $cnum;
                   11088:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   11089:         $toplevel = $url;
                   11090:         $path = $url;
                   11091:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   11092:         $fileloc =~ s{^/}{};
                   11093:     }
                   11094:     foreach my $file (keys(%{$allfiles})) {
                   11095:         my $embed_file;
                   11096:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   11097:             $embed_file = $1;
                   11098:         } else {
                   11099:             $embed_file = $file;
                   11100:         }
1.1075.2.55  raeburn  11101:         my ($absolutepath,$cleaned_file);
                   11102:         if ($embed_file =~ m{^\w+://}) {
                   11103:             $cleaned_file = $embed_file;
1.1075.2.47  raeburn  11104:             $newfiles{$cleaned_file} = 1;
                   11105:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11106:         } else {
1.1075.2.55  raeburn  11107:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  11108:             if ($embed_file =~ m{^/}) {
                   11109:                 $absolutepath = $embed_file;
                   11110:             }
1.1075.2.47  raeburn  11111:             if ($cleaned_file =~ m{/}) {
                   11112:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  11113:                 $path = &check_for_traversal($path,$url,$toplevel);
                   11114:                 my $item = $fname;
                   11115:                 if ($path ne '') {
                   11116:                     $item = $path.'/'.$fname;
                   11117:                     $subdependencies{$path}{$fname} = 1;
                   11118:                 } else {
                   11119:                     $dependencies{$item} = 1;
                   11120:                 }
                   11121:                 if ($absolutepath) {
                   11122:                     $mapping{$item} = $absolutepath;
                   11123:                 } else {
                   11124:                     $mapping{$item} = $embed_file;
                   11125:                 }
                   11126:             } else {
                   11127:                 $dependencies{$embed_file} = 1;
                   11128:                 if ($absolutepath) {
1.1075.2.47  raeburn  11129:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  11130:                 } else {
1.1075.2.47  raeburn  11131:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  11132:                 }
                   11133:             }
1.984     raeburn  11134:         }
                   11135:     }
1.1071    raeburn  11136:     my $dirptr = 16384;
1.984     raeburn  11137:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  11138:         $currsubfile{$path} = {};
1.1075.2.35  raeburn  11139:         if (($actionurl eq '/adm/portfolio') ||
                   11140:             ($actionurl eq '/adm/coursegrp_portfolio')) { 
1.1021    raeburn  11141:             my ($sublistref,$listerror) =
                   11142:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   11143:             if (ref($sublistref) eq 'ARRAY') {
                   11144:                 foreach my $line (@{$sublistref}) {
                   11145:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  11146:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  11147:                 }
1.984     raeburn  11148:             }
1.987     raeburn  11149:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11150:             if (opendir(my $dir,$url.'/'.$path)) {
                   11151:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  11152:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   11153:             }
1.1075.2.11  raeburn  11154:         } elsif (($actionurl eq '/adm/dependencies') ||
                   11155:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11156:                   ($args->{'context'} eq 'paste')) ||
                   11157:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11158:             if ($env{'request.course.id'} ne '') {
1.1075.2.35  raeburn  11159:                 my $dir;
                   11160:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   11161:                     $dir = $fileloc;
                   11162:                 } else {
                   11163:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11164:                 }
1.1071    raeburn  11165:                 if ($dir ne '') {
                   11166:                     my ($sublistref,$listerror) =
                   11167:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   11168:                     if (ref($sublistref) eq 'ARRAY') {
                   11169:                         foreach my $line (@{$sublistref}) {
                   11170:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   11171:                                 undef,$mtime)=split(/\&/,$line,12);
                   11172:                             unless (($testdir&$dirptr) ||
                   11173:                                     ($file_name =~ /^\.\.?$/)) {
                   11174:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   11175:                             }
                   11176:                         }
                   11177:                     }
                   11178:                 }
1.984     raeburn  11179:             }
                   11180:         }
                   11181:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  11182:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  11183:                 my $item = $path.'/'.$file;
                   11184:                 unless ($mapping{$item} eq $item) {
                   11185:                     $pathchanges{$item} = 1;
                   11186:                 }
                   11187:                 $existing{$item} = 1;
                   11188:                 $numexisting ++;
                   11189:             } else {
                   11190:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  11191:             }
                   11192:         }
1.1071    raeburn  11193:         if ($actionurl eq '/adm/dependencies') {
                   11194:             foreach my $path (keys(%currsubfile)) {
                   11195:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   11196:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   11197:                          unless ($subdependencies{$path}{$file}) {
1.1075.2.11  raeburn  11198:                              next if (($rem ne '') &&
                   11199:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   11200:                                        (ref($navmap) &&
                   11201:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   11202:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11203:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  11204:                              $unused{$path.'/'.$file} = 1; 
                   11205:                          }
                   11206:                     }
                   11207:                 }
                   11208:             }
                   11209:         }
1.984     raeburn  11210:     }
1.987     raeburn  11211:     my %currfile;
1.1075.2.35  raeburn  11212:     if (($actionurl eq '/adm/portfolio') ||
                   11213:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  11214:         my ($dirlistref,$listerror) =
                   11215:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   11216:         if (ref($dirlistref) eq 'ARRAY') {
                   11217:             foreach my $line (@{$dirlistref}) {
                   11218:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   11219:                 $currfile{$file_name} = 1;
                   11220:             }
1.984     raeburn  11221:         }
1.987     raeburn  11222:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  11223:         if (opendir(my $dir,$url)) {
1.987     raeburn  11224:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  11225:             map {$currfile{$_} = 1;} @dir_list;
                   11226:         }
1.1075.2.11  raeburn  11227:     } elsif (($actionurl eq '/adm/dependencies') ||
                   11228:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1075.2.35  raeburn  11229:               ($args->{'context'} eq 'paste')) ||
                   11230:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  11231:         if ($env{'request.course.id'} ne '') {
                   11232:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   11233:             if ($dir ne '') {
                   11234:                 my ($dirlistref,$listerror) =
                   11235:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   11236:                 if (ref($dirlistref) eq 'ARRAY') {
                   11237:                     foreach my $line (@{$dirlistref}) {
                   11238:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   11239:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   11240:                         unless (($testdir&$dirptr) ||
                   11241:                                 ($file_name =~ /^\.\.?$/)) {
                   11242:                             $currfile{$file_name} = [$size,$mtime];
                   11243:                         }
                   11244:                     }
                   11245:                 }
                   11246:             }
                   11247:         }
1.984     raeburn  11248:     }
                   11249:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  11250:         if (exists($currfile{$file})) {
1.987     raeburn  11251:             unless ($mapping{$file} eq $file) {
                   11252:                 $pathchanges{$file} = 1;
                   11253:             }
                   11254:             $existing{$file} = 1;
                   11255:             $numexisting ++;
                   11256:         } else {
1.984     raeburn  11257:             $newfiles{$file} = 1;
                   11258:         }
                   11259:     }
1.1071    raeburn  11260:     foreach my $file (keys(%currfile)) {
                   11261:         unless (($file eq $filename) ||
                   11262:                 ($file eq $filename.'.bak') ||
                   11263:                 ($dependencies{$file})) {
1.1075.2.11  raeburn  11264:             if ($actionurl eq '/adm/dependencies') {
1.1075.2.35  raeburn  11265:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   11266:                     next if (($rem ne '') &&
                   11267:                              (($env{"httpref.$rem".$file} ne '') ||
                   11268:                               (ref($navmap) &&
                   11269:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   11270:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   11271:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   11272:                 }
1.1075.2.11  raeburn  11273:             }
1.1071    raeburn  11274:             $unused{$file} = 1;
                   11275:         }
                   11276:     }
1.1075.2.11  raeburn  11277:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   11278:         ($args->{'context'} eq 'paste')) {
                   11279:         $counter = scalar(keys(%existing));
                   11280:         $numpathchg = scalar(keys(%pathchanges));
                   11281:         return ($output,$counter,$numpathchg,\%existing);
1.1075.2.35  raeburn  11282:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") &&
                   11283:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   11284:         $counter = scalar(keys(%existing));
                   11285:         $numpathchg = scalar(keys(%pathchanges));
                   11286:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1075.2.11  raeburn  11287:     }
1.984     raeburn  11288:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  11289:         if ($actionurl eq '/adm/dependencies') {
                   11290:             next if ($embed_file =~ m{^\w+://});
                   11291:         }
1.660     raeburn  11292:         $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11293:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  11294:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  11295:         unless ($mapping{$embed_file} eq $embed_file) {
1.1075.2.35  raeburn  11296:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   11297:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  11298:         }
1.1075.2.35  raeburn  11299:         $upload_output .= '</td>';
1.1071    raeburn  11300:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1075.2.35  raeburn  11301:             $upload_output.='<td align="right">'.
                   11302:                             '<span class="LC_info LC_fontsize_medium">'.
                   11303:                             &mt("URL points to web address").'</span>';
1.987     raeburn  11304:             $numremref++;
1.660     raeburn  11305:         } elsif ($args->{'error_on_invalid_names'}
                   11306:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1075.2.35  raeburn  11307:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   11308:                             &mt('Invalid characters').'</span>';
1.987     raeburn  11309:             $numinvalid++;
1.660     raeburn  11310:         } else {
1.1075.2.35  raeburn  11311:             $upload_output .= '<td>'.
                   11312:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  11313:                                                      $embed_file,\%mapping,
1.1071    raeburn  11314:                                                      $allfiles,$codebase,'upload');
                   11315:             $counter ++;
                   11316:             $numnew ++;
1.987     raeburn  11317:         }
                   11318:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   11319:     }
                   11320:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  11321:         if ($actionurl eq '/adm/dependencies') {
                   11322:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   11323:             $modify_output .= &start_data_table_row().
                   11324:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   11325:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   11326:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   11327:                               '<td>'.$size.'</td>'.
                   11328:                               '<td>'.$mtime.'</td>'.
                   11329:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   11330:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   11331:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   11332:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   11333:                               &embedded_file_element('upload_embedded',$counter,
                   11334:                                                      $embed_file,\%mapping,
                   11335:                                                      $allfiles,$codebase,'modify').
                   11336:                               '</div></td>'.
                   11337:                               &end_data_table_row()."\n";
                   11338:             $counter ++;
                   11339:         } else {
                   11340:             $upload_output .= &start_data_table_row().
1.1075.2.35  raeburn  11341:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   11342:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   11343:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  11344:                               &Apache::loncommon::end_data_table_row()."\n";
                   11345:         }
                   11346:     }
                   11347:     my $delidx = $counter;
                   11348:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   11349:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   11350:         $delete_output .= &start_data_table_row().
                   11351:                           '<td><img src="'.&icon($oldfile).'" />'.
                   11352:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   11353:                           '<td>'.$size.'</td>'.
                   11354:                           '<td>'.$mtime.'</td>'.
                   11355:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   11356:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   11357:                           &embedded_file_element('upload_embedded',$delidx,
                   11358:                                                  $oldfile,\%mapping,$allfiles,
                   11359:                                                  $codebase,'delete').'</td>'.
                   11360:                           &end_data_table_row()."\n"; 
                   11361:         $numunused ++;
                   11362:         $delidx ++;
1.987     raeburn  11363:     }
                   11364:     if ($upload_output) {
                   11365:         $upload_output = &start_data_table().
                   11366:                          $upload_output.
                   11367:                          &end_data_table()."\n";
                   11368:     }
1.1071    raeburn  11369:     if ($modify_output) {
                   11370:         $modify_output = &start_data_table().
                   11371:                          &start_data_table_header_row().
                   11372:                          '<th>'.&mt('File').'</th>'.
                   11373:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11374:                          '<th>'.&mt('Modified').'</th>'.
                   11375:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   11376:                          &end_data_table_header_row().
                   11377:                          $modify_output.
                   11378:                          &end_data_table()."\n";
                   11379:     }
                   11380:     if ($delete_output) {
                   11381:         $delete_output = &start_data_table().
                   11382:                          &start_data_table_header_row().
                   11383:                          '<th>'.&mt('File').'</th>'.
                   11384:                          '<th>'.&mt('Size (KB)').'</th>'.
                   11385:                          '<th>'.&mt('Modified').'</th>'.
                   11386:                          '<th>'.&mt('Delete?').'</th>'.
                   11387:                          &end_data_table_header_row().
                   11388:                          $delete_output.
                   11389:                          &end_data_table()."\n";
                   11390:     }
1.987     raeburn  11391:     my $applies = 0;
                   11392:     if ($numremref) {
                   11393:         $applies ++;
                   11394:     }
                   11395:     if ($numinvalid) {
                   11396:         $applies ++;
                   11397:     }
                   11398:     if ($numexisting) {
                   11399:         $applies ++;
                   11400:     }
1.1071    raeburn  11401:     if ($counter || $numunused) {
1.987     raeburn  11402:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   11403:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  11404:                   $state.'<h3>'.$heading.'</h3>'; 
                   11405:         if ($actionurl eq '/adm/dependencies') {
                   11406:             if ($numnew) {
                   11407:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   11408:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   11409:                            $upload_output.'<br />'."\n";
                   11410:             }
                   11411:             if ($numexisting) {
                   11412:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   11413:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   11414:                            $modify_output.'<br />'."\n";
                   11415:                            $buttontext = &mt('Save changes');
                   11416:             }
                   11417:             if ($numunused) {
                   11418:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   11419:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   11420:                            $delete_output.'<br />'."\n";
                   11421:                            $buttontext = &mt('Save changes');
                   11422:             }
                   11423:         } else {
                   11424:             $output .= $upload_output.'<br />'."\n";
                   11425:         }
                   11426:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   11427:                    $counter.'" />'."\n";
                   11428:         if ($actionurl eq '/adm/dependencies') { 
                   11429:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   11430:                        $numnew.'" />'."\n";
                   11431:         } elsif ($actionurl eq '') {
1.987     raeburn  11432:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   11433:         }
                   11434:     } elsif ($applies) {
                   11435:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   11436:         if ($applies > 1) {
                   11437:             $output .=  
1.1075.2.35  raeburn  11438:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  11439:             if ($numremref) {
                   11440:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   11441:             }
                   11442:             if ($numinvalid) {
                   11443:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   11444:             }
                   11445:             if ($numexisting) {
                   11446:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   11447:             }
                   11448:             $output .= '</ul><br />';
                   11449:         } elsif ($numremref) {
                   11450:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   11451:         } elsif ($numinvalid) {
                   11452:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   11453:         } elsif ($numexisting) {
                   11454:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   11455:         }
                   11456:         $output .= $upload_output.'<br />';
                   11457:     }
                   11458:     my ($pathchange_output,$chgcount);
1.1071    raeburn  11459:     $chgcount = $counter;
1.987     raeburn  11460:     if (keys(%pathchanges) > 0) {
                   11461:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  11462:             if ($counter) {
1.987     raeburn  11463:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   11464:                                                   $embed_file,\%mapping,
1.1071    raeburn  11465:                                                   $allfiles,$codebase,'change');
1.987     raeburn  11466:             } else {
                   11467:                 $pathchange_output .= 
                   11468:                     &start_data_table_row().
                   11469:                     '<td><input type ="checkbox" name="namechange" value="'.
                   11470:                     $chgcount.'" checked="checked" /></td>'.
                   11471:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   11472:                     '<td>'.$embed_file.
                   11473:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  11474:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  11475:                     '</td>'.&end_data_table_row();
1.660     raeburn  11476:             }
1.987     raeburn  11477:             $numpathchg ++;
                   11478:             $chgcount ++;
1.660     raeburn  11479:         }
                   11480:     }
1.1075.2.35  raeburn  11481:     if (($counter) || ($numunused)) {
1.987     raeburn  11482:         if ($numpathchg) {
                   11483:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   11484:                        $numpathchg.'" />'."\n";
                   11485:         }
                   11486:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   11487:             ($actionurl eq '/adm/imsimport')) {
                   11488:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   11489:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   11490:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  11491:         } elsif ($actionurl eq '/adm/dependencies') {
                   11492:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  11493:         }
1.1075.2.35  raeburn  11494:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  11495:     } elsif ($numpathchg) {
                   11496:         my %pathchange = ();
                   11497:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   11498:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11499:             $output .= '<p>'.&mt('or').'</p>'; 
1.1075.2.35  raeburn  11500:         }
1.987     raeburn  11501:     }
1.1071    raeburn  11502:     return ($output,$counter,$numpathchg);
1.987     raeburn  11503: }
                   11504: 
1.1075.2.47  raeburn  11505: =pod
                   11506: 
                   11507: =item * clean_path($name)
                   11508: 
                   11509: Performs clean-up of directories, subdirectories and filename in an
                   11510: embedded object, referenced in an HTML file which is being uploaded
                   11511: to a course or portfolio, where
                   11512: "Upload embedded images/multimedia files if HTML file" checkbox was
                   11513: checked.
                   11514: 
                   11515: Clean-up is similar to replacements in lonnet::clean_filename()
                   11516: except each / between sub-directory and next level is preserved.
                   11517: 
                   11518: =cut
                   11519: 
                   11520: sub clean_path {
                   11521:     my ($embed_file) = @_;
                   11522:     $embed_file =~s{^/+}{};
                   11523:     my @contents;
                   11524:     if ($embed_file =~ m{/}) {
                   11525:         @contents = split(/\//,$embed_file);
                   11526:     } else {
                   11527:         @contents = ($embed_file);
                   11528:     }
                   11529:     my $lastidx = scalar(@contents)-1;
                   11530:     for (my $i=0; $i<=$lastidx; $i++) {
                   11531:         $contents[$i]=~s{\\}{/}g;
                   11532:         $contents[$i]=~s/\s+/\_/g;
                   11533:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   11534:         if ($i == $lastidx) {
                   11535:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   11536:         }
                   11537:     }
                   11538:     if ($lastidx > 0) {
                   11539:         return join('/',@contents);
                   11540:     } else {
                   11541:         return $contents[0];
                   11542:     }
                   11543: }
                   11544: 
1.987     raeburn  11545: sub embedded_file_element {
1.1071    raeburn  11546:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  11547:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   11548:                    (ref($codebase) eq 'HASH'));
                   11549:     my $output;
1.1071    raeburn  11550:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  11551:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   11552:     }
                   11553:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   11554:                &escape($embed_file).'" />';
                   11555:     unless (($context eq 'upload_embedded') && 
                   11556:             ($mapping->{$embed_file} eq $embed_file)) {
                   11557:         $output .='
                   11558:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   11559:     }
                   11560:     my $attrib;
                   11561:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   11562:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   11563:     }
                   11564:     $output .=
                   11565:         "\n\t\t".
                   11566:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   11567:         $attrib.'" />';
                   11568:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   11569:         $output .=
                   11570:             "\n\t\t".
                   11571:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   11572:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  11573:     }
1.987     raeburn  11574:     return $output;
1.660     raeburn  11575: }
                   11576: 
1.1071    raeburn  11577: sub get_dependency_details {
                   11578:     my ($currfile,$currsubfile,$embed_file) = @_;
                   11579:     my ($size,$mtime,$showsize,$showmtime);
                   11580:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   11581:         if ($embed_file =~ m{/}) {
                   11582:             my ($path,$fname) = split(/\//,$embed_file);
                   11583:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   11584:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   11585:             }
                   11586:         } else {
                   11587:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   11588:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   11589:             }
                   11590:         }
                   11591:         $showsize = $size/1024.0;
                   11592:         $showsize = sprintf("%.1f",$showsize);
                   11593:         if ($mtime > 0) {
                   11594:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   11595:         }
                   11596:     }
                   11597:     return ($showsize,$showmtime);
                   11598: }
                   11599: 
                   11600: sub ask_embedded_js {
                   11601:     return <<"END";
                   11602: <script type="text/javascript"">
                   11603: // <![CDATA[
                   11604: function toggleBrowse(counter) {
                   11605:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   11606:     var fileid = document.getElementById('embedded_item_'+counter);
                   11607:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   11608:     if (chkboxid.checked == true) {
                   11609:         uploaddivid.style.display='block';
                   11610:     } else {
                   11611:         uploaddivid.style.display='none';
                   11612:         fileid.value = '';
                   11613:     }
                   11614: }
                   11615: // ]]>
                   11616: </script>
                   11617: 
                   11618: END
                   11619: }
                   11620: 
1.661     raeburn  11621: sub upload_embedded {
                   11622:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  11623:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   11624:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  11625:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   11626:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   11627:         my $orig_uploaded_filename =
                   11628:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  11629:         foreach my $type ('orig','ref','attrib','codebase') {
                   11630:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   11631:                 $env{'form.embedded_'.$type.'_'.$i} =
                   11632:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   11633:             }
                   11634:         }
1.661     raeburn  11635:         my ($path,$fname) =
                   11636:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   11637:         # no path, whole string is fname
                   11638:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   11639:         $fname = &Apache::lonnet::clean_filename($fname);
                   11640:         # See if there is anything left
                   11641:         next if ($fname eq '');
                   11642: 
                   11643:         # Check if file already exists as a file or directory.
                   11644:         my ($state,$msg);
                   11645:         if ($context eq 'portfolio') {
                   11646:             my $port_path = $dirpath;
                   11647:             if ($group ne '') {
                   11648:                 $port_path = "groups/$group/$port_path";
                   11649:             }
1.987     raeburn  11650:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   11651:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  11652:                                               $dir_root,$port_path,$disk_quota,
                   11653:                                               $current_disk_usage,$uname,$udom);
                   11654:             if ($state eq 'will_exceed_quota'
1.984     raeburn  11655:                 || $state eq 'file_locked') {
1.661     raeburn  11656:                 $output .= $msg;
                   11657:                 next;
                   11658:             }
                   11659:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   11660:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   11661:             if ($state eq 'exists') {
                   11662:                 $output .= $msg;
                   11663:                 next;
                   11664:             }
                   11665:         }
                   11666:         # Check if extension is valid
                   11667:         if (($fname =~ /\.(\w+)$/) &&
                   11668:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1075.2.53  raeburn  11669:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   11670:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  11671:             next;
                   11672:         } elsif (($fname =~ /\.(\w+)$/) &&
                   11673:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  11674:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  11675:             next;
                   11676:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1075.2.34  raeburn  11677:             $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  11678:             next;
                   11679:         }
                   11680:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1075.2.35  raeburn  11681:         my $subdir = $path;
                   11682:         $subdir =~ s{/+$}{};
1.661     raeburn  11683:         if ($context eq 'portfolio') {
1.984     raeburn  11684:             my $result;
                   11685:             if ($state eq 'existingfile') {
                   11686:                 $result=
                   11687:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1075.2.35  raeburn  11688:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  11689:             } else {
1.984     raeburn  11690:                 $result=
                   11691:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  11692:                                                     $dirpath.
1.1075.2.35  raeburn  11693:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  11694:                 if ($result !~ m|^/uploaded/|) {
                   11695:                     $output .= '<span class="LC_error">'
                   11696:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11697:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11698:                                .'</span><br />';
                   11699:                     next;
                   11700:                 } else {
1.987     raeburn  11701:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11702:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  11703:                 }
1.661     raeburn  11704:             }
1.1075.2.35  raeburn  11705:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
                   11706:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   11707:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  11708:             my $result =
1.1075.2.35  raeburn  11709:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  11710:             if ($result !~ m|^/uploaded/|) {
                   11711:                 $output .= '<span class="LC_error">'
                   11712:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   11713:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   11714:                            .'</span><br />';
                   11715:                     next;
                   11716:             } else {
                   11717:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11718:                            $path.$fname.'</span>').'<br />';
1.1075.2.35  raeburn  11719:                 if ($context eq 'syllabus') {
                   11720:                     &Apache::lonnet::make_public_indefinitely($result);
                   11721:                 }
1.987     raeburn  11722:             }
1.661     raeburn  11723:         } else {
                   11724: # Save the file
                   11725:             my $target = $env{'form.embedded_item_'.$i};
                   11726:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   11727:             my $dest = $fullpath.$fname;
                   11728:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  11729:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  11730:             my $count;
                   11731:             my $filepath = $dir_root;
1.1027    raeburn  11732:             foreach my $subdir (@parts) {
                   11733:                 $filepath .= "/$subdir";
                   11734:                 if (!-e $filepath) {
1.661     raeburn  11735:                     mkdir($filepath,0770);
                   11736:                 }
                   11737:             }
                   11738:             my $fh;
                   11739:             if (!open($fh,'>'.$dest)) {
                   11740:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   11741:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  11742:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   11743:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11744:                            '</span><br />';
                   11745:             } else {
                   11746:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   11747:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   11748:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  11749:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   11750:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  11751:                               '</span><br />';
                   11752:                 } else {
1.987     raeburn  11753:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   11754:                                $url.'</span>').'<br />';
                   11755:                     unless ($context eq 'testbank') {
                   11756:                         $footer .= &mt('View embedded file: [_1]',
                   11757:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   11758:                     }
                   11759:                 }
                   11760:                 close($fh);
                   11761:             }
                   11762:         }
                   11763:         if ($env{'form.embedded_ref_'.$i}) {
                   11764:             $pathchange{$i} = 1;
                   11765:         }
                   11766:     }
                   11767:     if ($output) {
                   11768:         $output = '<p>'.$output.'</p>';
                   11769:     }
                   11770:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   11771:     $returnflag = 'ok';
1.1071    raeburn  11772:     my $numpathchgs = scalar(keys(%pathchange));
                   11773:     if ($numpathchgs > 0) {
1.987     raeburn  11774:         if ($context eq 'portfolio') {
                   11775:             $output .= '<p>'.&mt('or').'</p>';
                   11776:         } elsif ($context eq 'testbank') {
1.1071    raeburn  11777:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   11778:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  11779:             $returnflag = 'modify_orightml';
                   11780:         }
                   11781:     }
1.1071    raeburn  11782:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  11783: }
                   11784: 
                   11785: sub modify_html_form {
                   11786:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   11787:     my $end = 0;
                   11788:     my $modifyform;
                   11789:     if ($context eq 'upload_embedded') {
                   11790:         return unless (ref($pathchange) eq 'HASH');
                   11791:         if ($env{'form.number_embedded_items'}) {
                   11792:             $end += $env{'form.number_embedded_items'};
                   11793:         }
                   11794:         if ($env{'form.number_pathchange_items'}) {
                   11795:             $end += $env{'form.number_pathchange_items'};
                   11796:         }
                   11797:         if ($end) {
                   11798:             for (my $i=0; $i<$end; $i++) {
                   11799:                 if ($i < $env{'form.number_embedded_items'}) {
                   11800:                     next unless($pathchange->{$i});
                   11801:                 }
                   11802:                 $modifyform .=
                   11803:                     &start_data_table_row().
                   11804:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   11805:                     'checked="checked" /></td>'.
                   11806:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   11807:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   11808:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   11809:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   11810:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   11811:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   11812:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   11813:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   11814:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   11815:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   11816:                     &end_data_table_row();
1.1071    raeburn  11817:             }
1.987     raeburn  11818:         }
                   11819:     } else {
                   11820:         $modifyform = $pathchgtable;
                   11821:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   11822:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   11823:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   11824:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   11825:         }
                   11826:     }
                   11827:     if ($modifyform) {
1.1071    raeburn  11828:         if ($actionurl eq '/adm/dependencies') {
                   11829:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   11830:         }
1.987     raeburn  11831:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   11832:                '<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".
                   11833:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   11834:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   11835:                '</ol></p>'."\n".'<p>'.
                   11836:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   11837:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   11838:                &start_data_table()."\n".
                   11839:                &start_data_table_header_row().
                   11840:                '<th>'.&mt('Change?').'</th>'.
                   11841:                '<th>'.&mt('Current reference').'</th>'.
                   11842:                '<th>'.&mt('Required reference').'</th>'.
                   11843:                &end_data_table_header_row()."\n".
                   11844:                $modifyform.
                   11845:                &end_data_table().'<br />'."\n".$hiddenstate.
                   11846:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   11847:                '</form>'."\n";
                   11848:     }
                   11849:     return;
                   11850: }
                   11851: 
                   11852: sub modify_html_refs {
1.1075.2.35  raeburn  11853:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  11854:     my $container;
                   11855:     if ($context eq 'portfolio') {
                   11856:         $container = $env{'form.container'};
                   11857:     } elsif ($context eq 'coursedoc') {
                   11858:         $container = $env{'form.primaryurl'};
1.1071    raeburn  11859:     } elsif ($context eq 'manage_dependencies') {
                   11860:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   11861:         $container = "/$container";
1.1075.2.35  raeburn  11862:     } elsif ($context eq 'syllabus') {
                   11863:         $container = $url;
1.987     raeburn  11864:     } else {
1.1027    raeburn  11865:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  11866:     }
                   11867:     my (%allfiles,%codebase,$output,$content);
                   11868:     my @changes = &get_env_multiple('form.namechange');
1.1075.2.35  raeburn  11869:     unless ((@changes > 0)  || ($context eq 'syllabus')) {
1.1071    raeburn  11870:         if (wantarray) {
                   11871:             return ('',0,0); 
                   11872:         } else {
                   11873:             return;
                   11874:         }
                   11875:     }
                   11876:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11877:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  11878:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   11879:             if (wantarray) {
                   11880:                 return ('',0,0);
                   11881:             } else {
                   11882:                 return;
                   11883:             }
                   11884:         } 
1.987     raeburn  11885:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  11886:         if ($content eq '-1') {
                   11887:             if (wantarray) {
                   11888:                 return ('',0,0);
                   11889:             } else {
                   11890:                 return;
                   11891:             }
                   11892:         }
1.987     raeburn  11893:     } else {
1.1071    raeburn  11894:         unless ($container =~ /^\Q$dir_root\E/) {
                   11895:             if (wantarray) {
                   11896:                 return ('',0,0);
                   11897:             } else {
                   11898:                 return;
                   11899:             }
                   11900:         } 
1.1075.2.128  raeburn  11901:         if (open(my $fh,'<',$container)) {
1.987     raeburn  11902:             $content = join('', <$fh>);
                   11903:             close($fh);
                   11904:         } else {
1.1071    raeburn  11905:             if (wantarray) {
                   11906:                 return ('',0,0);
                   11907:             } else {
                   11908:                 return;
                   11909:             }
1.987     raeburn  11910:         }
                   11911:     }
                   11912:     my ($count,$codebasecount) = (0,0);
                   11913:     my $mm = new File::MMagic;
                   11914:     my $mime_type = $mm->checktype_contents($content);
                   11915:     if ($mime_type eq 'text/html') {
                   11916:         my $parse_result = 
                   11917:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   11918:                                                     \%codebase,\$content);
                   11919:         if ($parse_result eq 'ok') {
                   11920:             foreach my $i (@changes) {
                   11921:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   11922:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   11923:                 if ($allfiles{$ref}) {
                   11924:                     my $newname =  $orig;
                   11925:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  11926:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  11927:                     if ($attrib_regexp =~ /:/) {
                   11928:                         $attrib_regexp =~ s/\:/|/g;
                   11929:                     }
                   11930:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11931:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   11932:                         $count += $numchg;
1.1075.2.35  raeburn  11933:                         $allfiles{$newname} = $allfiles{$ref};
1.1075.2.48  raeburn  11934:                         delete($allfiles{$ref});
1.987     raeburn  11935:                     }
                   11936:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  11937:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  11938:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   11939:                         $codebasecount ++;
                   11940:                     }
                   11941:                 }
                   11942:             }
1.1075.2.35  raeburn  11943:             my $skiprewrites;
1.987     raeburn  11944:             if ($count || $codebasecount) {
                   11945:                 my $saveresult;
1.1071    raeburn  11946:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1075.2.35  raeburn  11947:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  11948:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   11949:                     if ($url eq $container) {
                   11950:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   11951:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11952:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  11953:                                             $fname.'</span>').'</p>';
1.987     raeburn  11954:                     } else {
                   11955:                          $output = '<p class="LC_error">'.
                   11956:                                    &mt('Error: update failed for: [_1].',
                   11957:                                    '<span class="LC_filename">'.
                   11958:                                    $container.'</span>').'</p>';
                   11959:                     }
1.1075.2.35  raeburn  11960:                     if ($context eq 'syllabus') {
                   11961:                         unless ($saveresult eq 'ok') {
                   11962:                             $skiprewrites = 1;
                   11963:                         }
                   11964:                     }
1.987     raeburn  11965:                 } else {
1.1075.2.128  raeburn  11966:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  11967:                         print $fh $content;
                   11968:                         close($fh);
                   11969:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   11970:                                   $count,'<span class="LC_filename">'.
                   11971:                                   $container.'</span>').'</p>';
1.661     raeburn  11972:                     } else {
1.987     raeburn  11973:                          $output = '<p class="LC_error">'.
                   11974:                                    &mt('Error: could not update [_1].',
                   11975:                                    '<span class="LC_filename">'.
                   11976:                                    $container.'</span>').'</p>';
1.661     raeburn  11977:                     }
                   11978:                 }
                   11979:             }
1.1075.2.35  raeburn  11980:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   11981:                 my ($actionurl,$state);
                   11982:                 $actionurl = "/public/$udom/$uname/syllabus";
                   11983:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   11984:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   11985:                                               \%codebase,
                   11986:                                               {'context' => 'rewrites',
                   11987:                                                'ignore_remote_references' => 1,});
                   11988:                 if (ref($mapping) eq 'HASH') {
                   11989:                     my $rewrites = 0;
                   11990:                     foreach my $key (keys(%{$mapping})) {
                   11991:                         next if ($key =~ m{^https?://});
                   11992:                         my $ref = $mapping->{$key};
                   11993:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   11994:                         my $attrib;
                   11995:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   11996:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   11997:                         }
                   11998:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   11999:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   12000:                             $rewrites += $numchg;
                   12001:                         }
                   12002:                     }
                   12003:                     if ($rewrites) {
                   12004:                         my $saveresult;
                   12005:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   12006:                         if ($url eq $container) {
                   12007:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   12008:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   12009:                                             $count,'<span class="LC_filename">'.
                   12010:                                             $fname.'</span>').'</p>';
                   12011:                         } else {
                   12012:                             $output .= '<p class="LC_error">'.
                   12013:                                        &mt('Error: could not update links in [_1].',
                   12014:                                        '<span class="LC_filename">'.
                   12015:                                        $container.'</span>').'</p>';
                   12016: 
                   12017:                         }
                   12018:                     }
                   12019:                 }
                   12020:             }
1.987     raeburn  12021:         } else {
                   12022:             &logthis('Failed to parse '.$container.
                   12023:                      ' to modify references: '.$parse_result);
1.661     raeburn  12024:         }
                   12025:     }
1.1071    raeburn  12026:     if (wantarray) {
                   12027:         return ($output,$count,$codebasecount);
                   12028:     } else {
                   12029:         return $output;
                   12030:     }
1.661     raeburn  12031: }
                   12032: 
                   12033: sub check_for_existing {
                   12034:     my ($path,$fname,$element) = @_;
                   12035:     my ($state,$msg);
                   12036:     if (-d $path.'/'.$fname) {
                   12037:         $state = 'exists';
                   12038:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12039:     } elsif (-e $path.'/'.$fname) {
                   12040:         $state = 'exists';
                   12041:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   12042:     }
                   12043:     if ($state eq 'exists') {
                   12044:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   12045:     }
                   12046:     return ($state,$msg);
                   12047: }
                   12048: 
                   12049: sub check_for_upload {
                   12050:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   12051:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  12052:     my $filesize = length($env{'form.'.$element});
                   12053:     if (!$filesize) {
                   12054:         my $msg = '<span class="LC_error">'.
                   12055:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   12056:                       '<span class="LC_filename">'.$fname.'</span>',
                   12057:                       $filesize).'<br />'.
1.1007    raeburn  12058:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  12059:                   '</span>';
                   12060:         return ('zero_bytes',$msg);
                   12061:     }
                   12062:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  12063:     my $getpropath = 1;
1.1021    raeburn  12064:     my ($dirlistref,$listerror) =
                   12065:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  12066:     my $found_file = 0;
                   12067:     my $locked_file = 0;
1.991     raeburn  12068:     my @lockers;
                   12069:     my $navmap;
                   12070:     if ($env{'request.course.id'}) {
                   12071:         $navmap = Apache::lonnavmaps::navmap->new();
                   12072:     }
1.1021    raeburn  12073:     if (ref($dirlistref) eq 'ARRAY') {
                   12074:         foreach my $line (@{$dirlistref}) {
                   12075:             my ($file_name,$rest)=split(/\&/,$line,2);
                   12076:             if ($file_name eq $fname){
                   12077:                 $file_name = $path.$file_name;
                   12078:                 if ($group ne '') {
                   12079:                     $file_name = $group.$file_name;
                   12080:                 }
                   12081:                 $found_file = 1;
                   12082:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   12083:                     foreach my $lock (@lockers) {
                   12084:                         if (ref($lock) eq 'ARRAY') {
                   12085:                             my ($symb,$crsid) = @{$lock};
                   12086:                             if ($crsid eq $env{'request.course.id'}) {
                   12087:                                 if (ref($navmap)) {
                   12088:                                     my $res = $navmap->getBySymb($symb);
                   12089:                                     foreach my $part (@{$res->parts()}) { 
                   12090:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   12091:                                         unless (($slot_status == $res->RESERVED) ||
                   12092:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   12093:                                             $locked_file = 1;
                   12094:                                         }
1.991     raeburn  12095:                                     }
1.1021    raeburn  12096:                                 } else {
                   12097:                                     $locked_file = 1;
1.991     raeburn  12098:                                 }
                   12099:                             } else {
                   12100:                                 $locked_file = 1;
                   12101:                             }
                   12102:                         }
1.1021    raeburn  12103:                    }
                   12104:                 } else {
                   12105:                     my @info = split(/\&/,$rest);
                   12106:                     my $currsize = $info[6]/1000;
                   12107:                     if ($currsize < $filesize) {
                   12108:                         my $extra = $filesize - $currsize;
                   12109:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1075.2.69  raeburn  12110:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  12111:                                       &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  12112:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   12113:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   12114:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  12115:                             return ('will_exceed_quota',$msg);
                   12116:                         }
1.984     raeburn  12117:                     }
                   12118:                 }
1.661     raeburn  12119:             }
                   12120:         }
                   12121:     }
                   12122:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1075.2.69  raeburn  12123:         my $msg = '<p class="LC_warning">'.
                   12124:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
                   12125:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  12126:         return ('will_exceed_quota',$msg);
                   12127:     } elsif ($found_file) {
                   12128:         if ($locked_file) {
1.1075.2.69  raeburn  12129:             my $msg = '<p class="LC_warning">';
1.661     raeburn  12130:             $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  12131:             $msg .= '</p>';
1.661     raeburn  12132:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   12133:             return ('file_locked',$msg);
                   12134:         } else {
1.1075.2.69  raeburn  12135:             my $msg = '<p class="LC_error">';
1.984     raeburn  12136:             $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  12137:             $msg .= '</p>';
1.984     raeburn  12138:             return ('existingfile',$msg);
1.661     raeburn  12139:         }
                   12140:     }
                   12141: }
                   12142: 
1.987     raeburn  12143: sub check_for_traversal {
                   12144:     my ($path,$url,$toplevel) = @_;
                   12145:     my @parts=split(/\//,$path);
                   12146:     my $cleanpath;
                   12147:     my $fullpath = $url;
                   12148:     for (my $i=0;$i<@parts;$i++) {
                   12149:         next if ($parts[$i] eq '.');
                   12150:         if ($parts[$i] eq '..') {
                   12151:             $fullpath =~ s{([^/]+/)$}{};
                   12152:         } else {
                   12153:             $fullpath .= $parts[$i].'/';
                   12154:         }
                   12155:     }
                   12156:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   12157:         $cleanpath = $1;
                   12158:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   12159:         my $curr_toprel = $1;
                   12160:         my @parts = split(/\//,$curr_toprel);
                   12161:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   12162:         my @urlparts = split(/\//,$url_toprel);
                   12163:         my $doubledots;
                   12164:         my $startdiff = -1;
                   12165:         for (my $i=0; $i<@urlparts; $i++) {
                   12166:             if ($startdiff == -1) {
                   12167:                 unless ($urlparts[$i] eq $parts[$i]) {
                   12168:                     $startdiff = $i;
                   12169:                     $doubledots .= '../';
                   12170:                 }
                   12171:             } else {
                   12172:                 $doubledots .= '../';
                   12173:             }
                   12174:         }
                   12175:         if ($startdiff > -1) {
                   12176:             $cleanpath = $doubledots;
                   12177:             for (my $i=$startdiff; $i<@parts; $i++) {
                   12178:                 $cleanpath .= $parts[$i].'/';
                   12179:             }
                   12180:         }
                   12181:     }
                   12182:     $cleanpath =~ s{(/)$}{};
                   12183:     return $cleanpath;
                   12184: }
1.31      albertel 12185: 
1.1053    raeburn  12186: sub is_archive_file {
                   12187:     my ($mimetype) = @_;
                   12188:     if (($mimetype eq 'application/octet-stream') ||
                   12189:         ($mimetype eq 'application/x-stuffit') ||
                   12190:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   12191:         return 1;
                   12192:     }
                   12193:     return;
                   12194: }
                   12195: 
                   12196: sub decompress_form {
1.1065    raeburn  12197:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  12198:     my %lt = &Apache::lonlocal::texthash (
                   12199:         this => 'This file is an archive file.',
1.1067    raeburn  12200:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  12201:         itsc => 'Its contents are as follows:',
1.1053    raeburn  12202:         youm => 'You may wish to extract its contents.',
                   12203:         extr => 'Extract contents',
1.1067    raeburn  12204:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   12205:         proa => 'Process automatically?',
1.1053    raeburn  12206:         yes  => 'Yes',
                   12207:         no   => 'No',
1.1067    raeburn  12208:         fold => 'Title for folder containing movie',
                   12209:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  12210:     );
1.1065    raeburn  12211:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  12212:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  12213:     my $info = &list_archive_contents($fileloc,\@paths);
                   12214:     if (@paths) {
                   12215:         foreach my $path (@paths) {
                   12216:             $path =~ s{^/}{};
1.1067    raeburn  12217:             if ($path =~ m{^([^/]+)/$}) {
                   12218:                 $topdir = $1;
                   12219:             }
1.1065    raeburn  12220:             if ($path =~ m{^([^/]+)/}) {
                   12221:                 $toplevel{$1} = $path;
                   12222:             } else {
                   12223:                 $toplevel{$path} = $path;
                   12224:             }
                   12225:         }
                   12226:     }
1.1067    raeburn  12227:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1075.2.59  raeburn  12228:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  12229:                         "$topdir/media/",
                   12230:                         "$topdir/media/$topdir.mp4",
                   12231:                         "$topdir/media/FirstFrame.png",
                   12232:                         "$topdir/media/player.swf",
                   12233:                         "$topdir/media/swfobject.js",
                   12234:                         "$topdir/media/expressInstall.swf");
1.1075.2.81  raeburn  12235:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1075.2.59  raeburn  12236:                          "$topdir/$topdir.mp4",
                   12237:                          "$topdir/$topdir\_config.xml",
                   12238:                          "$topdir/$topdir\_controller.swf",
                   12239:                          "$topdir/$topdir\_embed.css",
                   12240:                          "$topdir/$topdir\_First_Frame.png",
                   12241:                          "$topdir/$topdir\_player.html",
                   12242:                          "$topdir/$topdir\_Thumbnails.png",
                   12243:                          "$topdir/playerProductInstall.swf",
                   12244:                          "$topdir/scripts/",
                   12245:                          "$topdir/scripts/config_xml.js",
                   12246:                          "$topdir/scripts/handlebars.js",
                   12247:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   12248:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   12249:                          "$topdir/scripts/modernizr.js",
                   12250:                          "$topdir/scripts/player-min.js",
                   12251:                          "$topdir/scripts/swfobject.js",
                   12252:                          "$topdir/skins/",
                   12253:                          "$topdir/skins/configuration_express.xml",
                   12254:                          "$topdir/skins/express_show/",
                   12255:                          "$topdir/skins/express_show/player-min.css",
                   12256:                          "$topdir/skins/express_show/spritesheet.png");
1.1075.2.81  raeburn  12257:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   12258:                          "$topdir/$topdir.mp4",
                   12259:                          "$topdir/$topdir\_config.xml",
                   12260:                          "$topdir/$topdir\_controller.swf",
                   12261:                          "$topdir/$topdir\_embed.css",
                   12262:                          "$topdir/$topdir\_First_Frame.png",
                   12263:                          "$topdir/$topdir\_player.html",
                   12264:                          "$topdir/$topdir\_Thumbnails.png",
                   12265:                          "$topdir/playerProductInstall.swf",
                   12266:                          "$topdir/scripts/",
                   12267:                          "$topdir/scripts/config_xml.js",
                   12268:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   12269:                          "$topdir/skins/",
                   12270:                          "$topdir/skins/configuration_express.xml",
                   12271:                          "$topdir/skins/express_show/",
                   12272:                          "$topdir/skins/express_show/spritesheet.min.css",
                   12273:                          "$topdir/skins/express_show/spritesheet.png",
                   12274:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1075.2.59  raeburn  12275:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  12276:         if (@diffs == 0) {
1.1075.2.59  raeburn  12277:             $is_camtasia = 6;
                   12278:         } else {
1.1075.2.81  raeburn  12279:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1075.2.59  raeburn  12280:             if (@diffs == 0) {
                   12281:                 $is_camtasia = 8;
1.1075.2.81  raeburn  12282:             } else {
                   12283:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   12284:                 if (@diffs == 0) {
                   12285:                     $is_camtasia = 8;
                   12286:                 }
1.1075.2.59  raeburn  12287:             }
1.1067    raeburn  12288:         }
                   12289:     }
                   12290:     my $output;
                   12291:     if ($is_camtasia) {
                   12292:         $output = <<"ENDCAM";
                   12293: <script type="text/javascript" language="Javascript">
                   12294: // <![CDATA[
                   12295: 
                   12296: function camtasiaToggle() {
                   12297:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   12298:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1075.2.59  raeburn  12299:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  12300:                 document.getElementById('camtasia_titles').style.display='block';
                   12301:             } else {
                   12302:                 document.getElementById('camtasia_titles').style.display='none';
                   12303:             }
                   12304:         }
                   12305:     }
                   12306:     return;
                   12307: }
                   12308: 
                   12309: // ]]>
                   12310: </script>
                   12311: <p>$lt{'camt'}</p>
                   12312: ENDCAM
1.1065    raeburn  12313:     } else {
1.1067    raeburn  12314:         $output = '<p>'.$lt{'this'};
                   12315:         if ($info eq '') {
                   12316:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   12317:         } else {
                   12318:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   12319:                        '<div><pre>'.$info.'</pre></div>';
                   12320:         }
1.1065    raeburn  12321:     }
1.1067    raeburn  12322:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  12323:     my $duplicates;
                   12324:     my $num = 0;
                   12325:     if (ref($dirlist) eq 'ARRAY') {
                   12326:         foreach my $item (@{$dirlist}) {
                   12327:             if (ref($item) eq 'ARRAY') {
                   12328:                 if (exists($toplevel{$item->[0]})) {
                   12329:                     $duplicates .= 
                   12330:                         &start_data_table_row().
                   12331:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12332:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   12333:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   12334:                         'value="1" />'.&mt('Yes').'</label>'.
                   12335:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   12336:                         '<td>'.$item->[0].'</td>';
                   12337:                     if ($item->[2]) {
                   12338:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   12339:                     } else {
                   12340:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   12341:                     }
                   12342:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   12343:                                    '<td>'.
                   12344:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   12345:                                    '</td>'.
                   12346:                                    &end_data_table_row();
                   12347:                     $num ++;
                   12348:                 }
                   12349:             }
                   12350:         }
                   12351:     }
                   12352:     my $itemcount;
                   12353:     if (@paths > 0) {
                   12354:         $itemcount = scalar(@paths);
                   12355:     } else {
                   12356:         $itemcount = 1;
                   12357:     }
1.1067    raeburn  12358:     if ($is_camtasia) {
                   12359:         $output .= $lt{'auto'}.'<br />'.
                   12360:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1075.2.59  raeburn  12361:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  12362:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   12363:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   12364:                    $lt{'no'}.'</label></span><br />'.
                   12365:                    '<div id="camtasia_titles" style="display:block">'.
                   12366:                    &Apache::lonhtmlcommon::start_pick_box().
                   12367:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   12368:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   12369:                    &Apache::lonhtmlcommon::row_closure().
                   12370:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   12371:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   12372:                    &Apache::lonhtmlcommon::row_closure(1).
                   12373:                    &Apache::lonhtmlcommon::end_pick_box().
                   12374:                    '</div>';
                   12375:     }
1.1065    raeburn  12376:     $output .= 
                   12377:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  12378:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   12379:         "\n";
1.1065    raeburn  12380:     if ($duplicates ne '') {
                   12381:         $output .= '<p><span class="LC_warning">'.
                   12382:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   12383:                    &start_data_table().
                   12384:                    &start_data_table_header_row().
                   12385:                    '<th>'.&mt('Overwrite?').'</th>'.
                   12386:                    '<th>'.&mt('Name').'</th>'.
                   12387:                    '<th>'.&mt('Type').'</th>'.
                   12388:                    '<th>'.&mt('Size').'</th>'.
                   12389:                    '<th>'.&mt('Last modified').'</th>'.
                   12390:                    &end_data_table_header_row().
                   12391:                    $duplicates.
                   12392:                    &end_data_table().
                   12393:                    '</p>';
                   12394:     }
1.1067    raeburn  12395:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  12396:     if (ref($hiddenelements) eq 'HASH') {
                   12397:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   12398:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   12399:         }
                   12400:     }
                   12401:     $output .= <<"END";
1.1067    raeburn  12402: <br />
1.1053    raeburn  12403: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   12404: </form>
                   12405: $noextract
                   12406: END
                   12407:     return $output;
                   12408: }
                   12409: 
1.1065    raeburn  12410: sub decompression_utility {
                   12411:     my ($program) = @_;
                   12412:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   12413:     my $location;
                   12414:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   12415:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   12416:                          '/usr/sbin/') {
                   12417:             if (-x $dir.$program) {
                   12418:                 $location = $dir.$program;
                   12419:                 last;
                   12420:             }
                   12421:         }
                   12422:     }
                   12423:     return $location;
                   12424: }
                   12425: 
                   12426: sub list_archive_contents {
                   12427:     my ($file,$pathsref) = @_;
                   12428:     my (@cmd,$output);
                   12429:     my $needsregexp;
                   12430:     if ($file =~ /\.zip$/) {
                   12431:         @cmd = (&decompression_utility('unzip'),"-l");
                   12432:         $needsregexp = 1;
                   12433:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   12434:              ($file =~ /\.tgz$/)) {
                   12435:         @cmd = (&decompression_utility('tar'),"-ztf");
                   12436:     } elsif ($file =~ /\.tar\.bz2$/) {
                   12437:         @cmd = (&decompression_utility('tar'),"-jtf");
                   12438:     } elsif ($file =~ m|\.tar$|) {
                   12439:         @cmd = (&decompression_utility('tar'),"-tf");
                   12440:     }
                   12441:     if (@cmd) {
                   12442:         undef($!);
                   12443:         undef($@);
                   12444:         if (open(my $fh,"-|", @cmd, $file)) {
                   12445:             while (my $line = <$fh>) {
                   12446:                 $output .= $line;
                   12447:                 chomp($line);
                   12448:                 my $item;
                   12449:                 if ($needsregexp) {
                   12450:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   12451:                 } else {
                   12452:                     $item = $line;
                   12453:                 }
                   12454:                 if ($item ne '') {
                   12455:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   12456:                         push(@{$pathsref},$item);
                   12457:                     } 
                   12458:                 }
                   12459:             }
                   12460:             close($fh);
                   12461:         }
                   12462:     }
                   12463:     return $output;
                   12464: }
                   12465: 
1.1053    raeburn  12466: sub decompress_uploaded_file {
                   12467:     my ($file,$dir) = @_;
                   12468:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   12469:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   12470:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   12471:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   12472:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   12473:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   12474:     my $decompressed = $env{'cgi.decompressed'};
                   12475:     &Apache::lonnet::delenv('cgi.file');
                   12476:     &Apache::lonnet::delenv('cgi.dir');
                   12477:     &Apache::lonnet::delenv('cgi.decompressed');
                   12478:     return ($decompressed,$result);
                   12479: }
                   12480: 
1.1055    raeburn  12481: sub process_decompression {
                   12482:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1075.2.128  raeburn  12483:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   12484:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12485:                &mt('Unexpected file path.').'</p>'."\n";
                   12486:     }
                   12487:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   12488:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12489:                &mt('Unexpected course context.').'</p>'."\n";
                   12490:     }
                   12491:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
                   12492:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12493:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   12494:     }
1.1055    raeburn  12495:     my ($dir,$error,$warning,$output);
1.1075.2.69  raeburn  12496:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1075.2.34  raeburn  12497:         $error = &mt('Filename not a supported archive file type.').
                   12498:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  12499:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   12500:     } else {
                   12501:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   12502:         if ($docuhome eq 'no_host') {
                   12503:             $error = &mt('Could not determine home server for course.');
                   12504:         } else {
                   12505:             my @ids=&Apache::lonnet::current_machine_ids();
                   12506:             my $currdir = "$dir_root/$destination";
                   12507:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   12508:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   12509:                        "$dir_root/$destination";
                   12510:             } else {
                   12511:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   12512:                        "$dir_root/$docudom/$docuname/$destination";
                   12513:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   12514:                     $error = &mt('Archive file not found.');
                   12515:                 }
                   12516:             }
1.1065    raeburn  12517:             my (@to_overwrite,@to_skip);
                   12518:             if ($env{'form.archive_overwrite_total'} > 0) {
                   12519:                 my $total = $env{'form.archive_overwrite_total'};
                   12520:                 for (my $i=0; $i<$total; $i++) {
                   12521:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   12522:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   12523:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   12524:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   12525:                     }
                   12526:                 }
                   12527:             }
                   12528:             my $numskip = scalar(@to_skip);
1.1075.2.128  raeburn  12529:             my $numoverwrite = scalar(@to_overwrite);
                   12530:             if (($numskip) && (!$numoverwrite)) {
1.1065    raeburn  12531:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   12532:             } elsif ($dir eq '') {
1.1055    raeburn  12533:                 $error = &mt('Directory containing archive file unavailable.');
                   12534:             } elsif (!$error) {
1.1065    raeburn  12535:                 my ($decompressed,$display);
1.1075.2.128  raeburn  12536:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  12537:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   12538:                     mkdir("$dir/$tempdir",0755);
1.1075.2.128  raeburn  12539:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   12540:                         ($decompressed,$display) =
                   12541:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   12542:                         foreach my $item (@to_skip) {
                   12543:                             if (($item ne '') && ($item !~ /\.\./)) {
                   12544:                                 if (-f "$dir/$tempdir/$item") {
                   12545:                                     unlink("$dir/$tempdir/$item");
                   12546:                                 } elsif (-d "$dir/$tempdir/$item") {
                   12547:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
                   12548:                                 }
                   12549:                             }
                   12550:                         }
                   12551:                         foreach my $item (@to_overwrite) {
                   12552:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   12553:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   12554:                                     if (-f "$dir/$item") {
                   12555:                                         unlink("$dir/$item");
                   12556:                                     } elsif (-d "$dir/$item") {
                   12557:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
                   12558:                                     }
                   12559:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   12560:                                 }
1.1065    raeburn  12561:                             }
                   12562:                         }
1.1075.2.128  raeburn  12563:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
                   12564:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
                   12565:                         }
1.1065    raeburn  12566:                     }
                   12567:                 } else {
                   12568:                     ($decompressed,$display) = 
                   12569:                         &decompress_uploaded_file($file,$dir);
                   12570:                 }
1.1055    raeburn  12571:                 if ($decompressed eq 'ok') {
1.1065    raeburn  12572:                     $output = '<p class="LC_info">'.
                   12573:                               &mt('Files extracted successfully from archive.').
                   12574:                               '</p>'."\n";
1.1055    raeburn  12575:                     my ($warning,$result,@contents);
                   12576:                     my ($newdirlistref,$newlisterror) =
                   12577:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   12578:                                                  $docuname,1);
                   12579:                     my (%is_dir,%changes,@newitems);
                   12580:                     my $dirptr = 16384;
1.1065    raeburn  12581:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  12582:                         foreach my $dir_line (@{$newdirlistref}) {
                   12583:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1075.2.128  raeburn  12584:                             unless (($item =~ /^\.+$/) || ($item eq $file)) { 
1.1055    raeburn  12585:                                 push(@newitems,$item);
                   12586:                                 if ($dirptr&$testdir) {
                   12587:                                     $is_dir{$item} = 1;
                   12588:                                 }
                   12589:                                 $changes{$item} = 1;
                   12590:                             }
                   12591:                         }
                   12592:                     }
                   12593:                     if (keys(%changes) > 0) {
                   12594:                         foreach my $item (sort(@newitems)) {
                   12595:                             if ($changes{$item}) {
                   12596:                                 push(@contents,$item);
                   12597:                             }
                   12598:                         }
                   12599:                     }
                   12600:                     if (@contents > 0) {
1.1067    raeburn  12601:                         my $wantform;
                   12602:                         unless ($env{'form.autoextract_camtasia'}) {
                   12603:                             $wantform = 1;
                   12604:                         }
1.1056    raeburn  12605:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  12606:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   12607:                                                                 $currdir,\%is_dir,
                   12608:                                                                 \%children,\%parent,
1.1056    raeburn  12609:                                                                 \@contents,\%dirorder,
                   12610:                                                                 \%titles,$wantform);
1.1055    raeburn  12611:                         if ($datatable ne '') {
                   12612:                             $output .= &archive_options_form('decompressed',$datatable,
                   12613:                                                              $count,$hiddenelem);
1.1065    raeburn  12614:                             my $startcount = 6;
1.1055    raeburn  12615:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  12616:                                                            \%titles,\%children);
1.1055    raeburn  12617:                         }
1.1067    raeburn  12618:                         if ($env{'form.autoextract_camtasia'}) {
1.1075.2.59  raeburn  12619:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  12620:                             my %displayed;
                   12621:                             my $total = 1;
                   12622:                             $env{'form.archive_directory'} = [];
                   12623:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   12624:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   12625:                                 $path =~ s{/$}{};
                   12626:                                 my $item;
                   12627:                                 if ($path ne '') {
                   12628:                                     $item = "$path/$titles{$i}";
                   12629:                                 } else {
                   12630:                                     $item = $titles{$i};
                   12631:                                 }
                   12632:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   12633:                                 if ($item eq $contents[0]) {
                   12634:                                     push(@{$env{'form.archive_directory'}},$i);
                   12635:                                     $env{'form.archive_'.$i} = 'display';
                   12636:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   12637:                                     $displayed{'folder'} = $i;
1.1075.2.59  raeburn  12638:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   12639:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) {
1.1067    raeburn  12640:                                     $env{'form.archive_'.$i} = 'display';
                   12641:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   12642:                                     $displayed{'web'} = $i;
                   12643:                                 } else {
1.1075.2.59  raeburn  12644:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   12645:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   12646:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  12647:                                         push(@{$env{'form.archive_directory'}},$i);
                   12648:                                     }
                   12649:                                     $env{'form.archive_'.$i} = 'dependency';
                   12650:                                 }
                   12651:                                 $total ++;
                   12652:                             }
                   12653:                             for (my $i=1; $i<$total; $i++) {
                   12654:                                 next if ($i == $displayed{'web'});
                   12655:                                 next if ($i == $displayed{'folder'});
                   12656:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   12657:                             }
                   12658:                             $env{'form.phase'} = 'decompress_cleanup';
                   12659:                             $env{'form.archivedelete'} = 1;
                   12660:                             $env{'form.archive_count'} = $total-1;
                   12661:                             $output .=
                   12662:                                 &process_extracted_files('coursedocs',$docudom,
                   12663:                                                          $docuname,$destination,
                   12664:                                                          $dir_root,$hiddenelem);
                   12665:                         }
1.1055    raeburn  12666:                     } else {
                   12667:                         $warning = &mt('No new items extracted from archive file.');
                   12668:                     }
                   12669:                 } else {
                   12670:                     $output = $display;
                   12671:                     $error = &mt('An error occurred during extraction from the archive file.');
                   12672:                 }
                   12673:             }
                   12674:         }
                   12675:     }
                   12676:     if ($error) {
                   12677:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   12678:                    $error.'</p>'."\n";
                   12679:     }
                   12680:     if ($warning) {
                   12681:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   12682:     }
                   12683:     return $output;
                   12684: }
                   12685: 
                   12686: sub get_extracted {
1.1056    raeburn  12687:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   12688:         $titles,$wantform) = @_;
1.1055    raeburn  12689:     my $count = 0;
                   12690:     my $depth = 0;
                   12691:     my $datatable;
1.1056    raeburn  12692:     my @hierarchy;
1.1055    raeburn  12693:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  12694:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   12695:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  12696:     foreach my $item (@{$contents}) {
                   12697:         $count ++;
1.1056    raeburn  12698:         @{$dirorder->{$count}} = @hierarchy;
                   12699:         $titles->{$count} = $item;
1.1055    raeburn  12700:         &archive_hierarchy($depth,$count,$parent,$children);
                   12701:         if ($wantform) {
                   12702:             $datatable .= &archive_row($is_dir->{$item},$item,
                   12703:                                        $currdir,$depth,$count);
                   12704:         }
                   12705:         if ($is_dir->{$item}) {
                   12706:             $depth ++;
1.1056    raeburn  12707:             push(@hierarchy,$count);
                   12708:             $parent->{$depth} = $count;
1.1055    raeburn  12709:             $datatable .=
                   12710:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  12711:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   12712:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  12713:             $depth --;
1.1056    raeburn  12714:             pop(@hierarchy);
1.1055    raeburn  12715:         }
                   12716:     }
                   12717:     return ($count,$datatable);
                   12718: }
                   12719: 
                   12720: sub recurse_extracted_archive {
1.1056    raeburn  12721:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   12722:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  12723:     my $result='';
1.1056    raeburn  12724:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   12725:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   12726:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  12727:         return $result;
                   12728:     }
                   12729:     my $dirptr = 16384;
                   12730:     my ($newdirlistref,$newlisterror) =
                   12731:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   12732:     if (ref($newdirlistref) eq 'ARRAY') {
                   12733:         foreach my $dir_line (@{$newdirlistref}) {
                   12734:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   12735:             unless ($item =~ /^\.+$/) {
                   12736:                 $$count ++;
1.1056    raeburn  12737:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   12738:                 $titles->{$$count} = $item;
1.1055    raeburn  12739:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  12740: 
1.1055    raeburn  12741:                 my $is_dir;
                   12742:                 if ($dirptr&$testdir) {
                   12743:                     $is_dir = 1;
                   12744:                 }
                   12745:                 if ($wantform) {
                   12746:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   12747:                 }
                   12748:                 if ($is_dir) {
                   12749:                     $$depth ++;
1.1056    raeburn  12750:                     push(@{$hierarchy},$$count);
                   12751:                     $parent->{$$depth} = $$count;
1.1055    raeburn  12752:                     $result .=
                   12753:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   12754:                                                    $docuname,$depth,$count,
1.1056    raeburn  12755:                                                    $hierarchy,$dirorder,$children,
                   12756:                                                    $parent,$titles,$wantform);
1.1055    raeburn  12757:                     $$depth --;
1.1056    raeburn  12758:                     pop(@{$hierarchy});
1.1055    raeburn  12759:                 }
                   12760:             }
                   12761:         }
                   12762:     }
                   12763:     return $result;
                   12764: }
                   12765: 
                   12766: sub archive_hierarchy {
                   12767:     my ($depth,$count,$parent,$children) =@_;
                   12768:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   12769:         if (exists($parent->{$depth})) {
                   12770:              $children->{$parent->{$depth}} .= $count.':';
                   12771:         }
                   12772:     }
                   12773:     return;
                   12774: }
                   12775: 
                   12776: sub archive_row {
                   12777:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   12778:     my ($name) = ($item =~ m{([^/]+)$});
                   12779:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  12780:                                        'display'    => 'Add as file',
1.1055    raeburn  12781:                                        'dependency' => 'Include as dependency',
                   12782:                                        'discard'    => 'Discard',
                   12783:                                       );
                   12784:     if ($is_dir) {
1.1059    raeburn  12785:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  12786:     }
1.1056    raeburn  12787:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   12788:     my $offset = 0;
1.1055    raeburn  12789:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  12790:         $offset ++;
1.1065    raeburn  12791:         if ($action ne 'display') {
                   12792:             $offset ++;
                   12793:         }  
1.1055    raeburn  12794:         $output .= '<td><span class="LC_nobreak">'.
                   12795:                    '<label><input type="radio" name="archive_'.$count.
                   12796:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   12797:         my $text = $choices{$action};
                   12798:         if ($is_dir) {
                   12799:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   12800:             if ($action eq 'display') {
1.1059    raeburn  12801:                 $text = &mt('Add as folder');
1.1055    raeburn  12802:             }
1.1056    raeburn  12803:         } else {
                   12804:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   12805: 
                   12806:         }
                   12807:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   12808:         if ($action eq 'dependency') {
                   12809:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   12810:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   12811:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   12812:                        '<option value=""></option>'."\n".
                   12813:                        '</select>'."\n".
                   12814:                        '</div>';
1.1059    raeburn  12815:         } elsif ($action eq 'display') {
                   12816:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   12817:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   12818:                        '</div>';
1.1055    raeburn  12819:         }
1.1056    raeburn  12820:         $output .= '</td>';
1.1055    raeburn  12821:     }
                   12822:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   12823:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   12824:     for (my $i=0; $i<$depth; $i++) {
                   12825:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   12826:     }
                   12827:     if ($is_dir) {
                   12828:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   12829:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   12830:     } else {
                   12831:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   12832:     }
                   12833:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   12834:                &end_data_table_row();
                   12835:     return $output;
                   12836: }
                   12837: 
                   12838: sub archive_options_form {
1.1065    raeburn  12839:     my ($form,$display,$count,$hiddenelem) = @_;
                   12840:     my %lt = &Apache::lonlocal::texthash(
                   12841:                perm => 'Permanently remove archive file?',
                   12842:                hows => 'How should each extracted item be incorporated in the course?',
                   12843:                cont => 'Content actions for all',
                   12844:                addf => 'Add as folder/file',
                   12845:                incd => 'Include as dependency for a displayed file',
                   12846:                disc => 'Discard',
                   12847:                no   => 'No',
                   12848:                yes  => 'Yes',
                   12849:                save => 'Save',
                   12850:     );
                   12851:     my $output = <<"END";
                   12852: <form name="$form" method="post" action="">
                   12853: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   12854: <label>
                   12855:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   12856: </label>
                   12857: &nbsp;
                   12858: <label>
                   12859:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   12860: </span>
                   12861: </p>
                   12862: <input type="hidden" name="phase" value="decompress_cleanup" />
                   12863: <br />$lt{'hows'}
                   12864: <div class="LC_columnSection">
                   12865:   <fieldset>
                   12866:     <legend>$lt{'cont'}</legend>
                   12867:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   12868:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   12869:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   12870:   </fieldset>
                   12871: </div>
                   12872: END
                   12873:     return $output.
1.1055    raeburn  12874:            &start_data_table()."\n".
1.1065    raeburn  12875:            $display."\n".
1.1055    raeburn  12876:            &end_data_table()."\n".
                   12877:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   12878:            $hiddenelem.
1.1065    raeburn  12879:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  12880:            '</form>';
                   12881: }
                   12882: 
                   12883: sub archive_javascript {
1.1056    raeburn  12884:     my ($startcount,$numitems,$titles,$children) = @_;
                   12885:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  12886:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  12887:     my $scripttag = <<START;
                   12888: <script type="text/javascript">
                   12889: // <![CDATA[
                   12890: 
                   12891: function checkAll(form,prefix) {
                   12892:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   12893:     for (var i=0; i < form.elements.length; i++) {
                   12894:         var id = form.elements[i].id;
                   12895:         if ((id != '') && (id != undefined)) {
                   12896:             if (idstr.test(id)) {
                   12897:                 if (form.elements[i].type == 'radio') {
                   12898:                     form.elements[i].checked = true;
1.1056    raeburn  12899:                     var nostart = i-$startcount;
1.1059    raeburn  12900:                     var offset = nostart%7;
                   12901:                     var count = (nostart-offset)/7;    
1.1056    raeburn  12902:                     dependencyCheck(form,count,offset);
1.1055    raeburn  12903:                 }
                   12904:             }
                   12905:         }
                   12906:     }
                   12907: }
                   12908: 
                   12909: function propagateCheck(form,count) {
                   12910:     if (count > 0) {
1.1059    raeburn  12911:         var startelement = $startcount + ((count-1) * 7);
                   12912:         for (var j=1; j<6; j++) {
                   12913:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  12914:                 var item = startelement + j; 
                   12915:                 if (form.elements[item].type == 'radio') {
                   12916:                     if (form.elements[item].checked) {
                   12917:                         containerCheck(form,count,j);
                   12918:                         break;
                   12919:                     }
1.1055    raeburn  12920:                 }
                   12921:             }
                   12922:         }
                   12923:     }
                   12924: }
                   12925: 
                   12926: numitems = $numitems
1.1056    raeburn  12927: var titles = new Array(numitems);
                   12928: var parents = new Array(numitems);
1.1055    raeburn  12929: for (var i=0; i<numitems; i++) {
1.1056    raeburn  12930:     parents[i] = new Array;
1.1055    raeburn  12931: }
1.1059    raeburn  12932: var maintitle = '$maintitle';
1.1055    raeburn  12933: 
                   12934: START
                   12935: 
1.1056    raeburn  12936:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   12937:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  12938:         for (my $i=0; $i<@contents; $i ++) {
                   12939:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   12940:         }
                   12941:     }
                   12942: 
1.1056    raeburn  12943:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   12944:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   12945:     }
                   12946: 
1.1055    raeburn  12947:     $scripttag .= <<END;
                   12948: 
                   12949: function containerCheck(form,count,offset) {
                   12950:     if (count > 0) {
1.1056    raeburn  12951:         dependencyCheck(form,count,offset);
1.1059    raeburn  12952:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  12953:         form.elements[item].checked = true;
                   12954:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   12955:             if (parents[count].length > 0) {
                   12956:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  12957:                     containerCheck(form,parents[count][j],offset);
                   12958:                 }
                   12959:             }
                   12960:         }
                   12961:     }
                   12962: }
                   12963: 
                   12964: function dependencyCheck(form,count,offset) {
                   12965:     if (count > 0) {
1.1059    raeburn  12966:         var chosen = (offset+$startcount)+7*(count-1);
                   12967:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  12968:         var currtype = form.elements[depitem].type;
                   12969:         if (form.elements[chosen].value == 'dependency') {
                   12970:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   12971:             form.elements[depitem].options.length = 0;
                   12972:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1075.2.11  raeburn  12973:             for (var i=1; i<=numitems; i++) {
                   12974:                 if (i == count) {
                   12975:                     continue;
                   12976:                 }
1.1059    raeburn  12977:                 var startelement = $startcount + (i-1) * 7;
                   12978:                 for (var j=1; j<6; j++) {
                   12979:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  12980:                         var item = startelement + j;
                   12981:                         if (form.elements[item].type == 'radio') {
                   12982:                             if (form.elements[item].checked) {
                   12983:                                 if (form.elements[item].value == 'display') {
                   12984:                                     var n = form.elements[depitem].options.length;
                   12985:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   12986:                                 }
                   12987:                             }
                   12988:                         }
                   12989:                     }
                   12990:                 }
                   12991:             }
                   12992:         } else {
                   12993:             document.getElementById('arc_depon_'+count).style.display='none';
                   12994:             form.elements[depitem].options.length = 0;
                   12995:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   12996:         }
1.1059    raeburn  12997:         titleCheck(form,count,offset);
1.1056    raeburn  12998:     }
                   12999: }
                   13000: 
                   13001: function propagateSelect(form,count,offset) {
                   13002:     if (count > 0) {
1.1065    raeburn  13003:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  13004:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   13005:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13006:             if (parents[count].length > 0) {
                   13007:                 for (var j=0; j<parents[count].length; j++) {
                   13008:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  13009:                 }
                   13010:             }
                   13011:         }
                   13012:     }
                   13013: }
1.1056    raeburn  13014: 
                   13015: function containerSelect(form,count,offset,picked) {
                   13016:     if (count > 0) {
1.1065    raeburn  13017:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  13018:         if (form.elements[item].type == 'radio') {
                   13019:             if (form.elements[item].value == 'dependency') {
                   13020:                 if (form.elements[item+1].type == 'select-one') {
                   13021:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   13022:                         if (form.elements[item+1].options[i].value == picked) {
                   13023:                             form.elements[item+1].selectedIndex = i;
                   13024:                             break;
                   13025:                         }
                   13026:                     }
                   13027:                 }
                   13028:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   13029:                     if (parents[count].length > 0) {
                   13030:                         for (var j=0; j<parents[count].length; j++) {
                   13031:                             containerSelect(form,parents[count][j],offset,picked);
                   13032:                         }
                   13033:                     }
                   13034:                 }
                   13035:             }
                   13036:         }
                   13037:     }
                   13038: }
                   13039: 
1.1059    raeburn  13040: function titleCheck(form,count,offset) {
                   13041:     if (count > 0) {
                   13042:         var chosen = (offset+$startcount)+7*(count-1);
                   13043:         var depitem = $startcount + ((count-1) * 7) + 2;
                   13044:         var currtype = form.elements[depitem].type;
                   13045:         if (form.elements[chosen].value == 'display') {
                   13046:             document.getElementById('arc_title_'+count).style.display='block';
                   13047:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   13048:                 document.getElementById('archive_title_'+count).value=maintitle;
                   13049:             }
                   13050:         } else {
                   13051:             document.getElementById('arc_title_'+count).style.display='none';
                   13052:             if (currtype == 'text') { 
                   13053:                 document.getElementById('archive_title_'+count).value='';
                   13054:             }
                   13055:         }
                   13056:     }
                   13057:     return;
                   13058: }
                   13059: 
1.1055    raeburn  13060: // ]]>
                   13061: </script>
                   13062: END
                   13063:     return $scripttag;
                   13064: }
                   13065: 
                   13066: sub process_extracted_files {
1.1067    raeburn  13067:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  13068:     my $numitems = $env{'form.archive_count'};
1.1075.2.128  raeburn  13069:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  13070:     my @ids=&Apache::lonnet::current_machine_ids();
                   13071:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  13072:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  13073:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   13074:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   13075:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   13076:         $pathtocheck = "$dir_root/$destination";
                   13077:         $dir = $dir_root;
                   13078:         $ishome = 1;
                   13079:     } else {
                   13080:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   13081:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1075.2.128  raeburn  13082:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  13083:     }
                   13084:     my $currdir = "$dir_root/$destination";
                   13085:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   13086:     if ($env{'form.folderpath'}) {
                   13087:         my @items = split('&',$env{'form.folderpath'});
                   13088:         $folders{'0'} = $items[-2];
1.1075.2.17  raeburn  13089:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   13090:             $containers{'0'}='page';
                   13091:         } else {
                   13092:             $containers{'0'}='sequence';
                   13093:         }
1.1055    raeburn  13094:     }
                   13095:     my @archdirs = &get_env_multiple('form.archive_directory');
                   13096:     if ($numitems) {
                   13097:         for (my $i=1; $i<=$numitems; $i++) {
                   13098:             my $path = $env{'form.archive_content_'.$i};
                   13099:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   13100:                 my $item = $1;
                   13101:                 $toplevelitems{$item} = $i;
                   13102:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   13103:                     $is_dir{$item} = 1;
                   13104:                 }
                   13105:             }
                   13106:         }
                   13107:     }
1.1067    raeburn  13108:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  13109:     if (keys(%toplevelitems) > 0) {
                   13110:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  13111:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   13112:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  13113:     }
1.1066    raeburn  13114:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  13115:     if ($numitems) {
                   13116:         for (my $i=1; $i<=$numitems; $i++) {
1.1075.2.11  raeburn  13117:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  13118:             my $path = $env{'form.archive_content_'.$i};
                   13119:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13120:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   13121:                     if ($prefix ne '' && $path ne '') {
                   13122:                         if (-e $prefix.$path) {
1.1066    raeburn  13123:                             if ((@archdirs > 0) && 
                   13124:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   13125:                                 $todeletedir{$prefix.$path} = 1;
                   13126:                             } else {
                   13127:                                 $todelete{$prefix.$path} = 1;
                   13128:                             }
1.1055    raeburn  13129:                         }
                   13130:                     }
                   13131:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  13132:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  13133:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  13134:                     $docstitle = $env{'form.archive_title_'.$i};
                   13135:                     if ($docstitle eq '') {
                   13136:                         $docstitle = $title;
                   13137:                     }
1.1055    raeburn  13138:                     $outer = 0;
1.1056    raeburn  13139:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13140:                         if (@{$dirorder{$i}} > 0) {
                   13141:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  13142:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   13143:                                     $outer = $item;
                   13144:                                     last;
                   13145:                                 }
                   13146:                             }
                   13147:                         }
                   13148:                     }
                   13149:                     my ($errtext,$fatal) = 
                   13150:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   13151:                                                '/'.$folders{$outer}.'.'.
                   13152:                                                $containers{$outer});
                   13153:                     next if ($fatal);
                   13154:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   13155:                         if ($context eq 'coursedocs') {
1.1056    raeburn  13156:                             $mapinner{$i} = time;
1.1055    raeburn  13157:                             $folders{$i} = 'default_'.$mapinner{$i};
                   13158:                             $containers{$i} = 'sequence';
                   13159:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13160:                                       $folders{$i}.'.'.$containers{$i};
                   13161:                             my $newidx = &LONCAPA::map::getresidx();
                   13162:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  13163:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  13164:                             push(@LONCAPA::map::order,$newidx);
                   13165:                             my ($outtext,$errtext) =
                   13166:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13167:                                                         $docuname.'/'.$folders{$outer}.
1.1075.2.11  raeburn  13168:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  13169:                             $newseqid{$i} = $newidx;
1.1067    raeburn  13170:                             unless ($errtext) {
1.1075.2.128  raeburn  13171:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   13172:                                                        &HTML::Entities::encode($docstitle,'<>&"'))..
                   13173:                                             '</li>'."\n";
1.1067    raeburn  13174:                             }
1.1055    raeburn  13175:                         }
                   13176:                     } else {
                   13177:                         if ($context eq 'coursedocs') {
                   13178:                             my $newidx=&LONCAPA::map::getresidx();
                   13179:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   13180:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   13181:                                       $title;
1.1075.2.167! raeburn  13182:                             if (($outer !~ /\D/) &&
        !          13183:                                 (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
        !          13184:                                 ($newidx !~ /\D/)) {
1.1075.2.128  raeburn  13185:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   13186:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
1.1067    raeburn  13187:                                 }
1.1075.2.128  raeburn  13188:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13189:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   13190:                                 }
                   13191:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   13192:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   13193:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   13194:                                         unless ($ishome) {
                   13195:                                             my $fetch = "$newdest{$i}/$title";
                   13196:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   13197:                                             $prompttofetch{$fetch} = 1;
                   13198:                                         }
                   13199:                                    }
                   13200:                                 }
                   13201:                                 $LONCAPA::map::resources[$newidx]=
                   13202:                                     $docstitle.':'.$url.':false:normal:res';
                   13203:                                 push(@LONCAPA::map::order, $newidx);
                   13204:                                 my ($outtext,$errtext)=
                   13205:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   13206:                                                             $docuname.'/'.$folders{$outer}.
                   13207:                                                             '.'.$containers{$outer},1,1);
                   13208:                                 unless ($errtext) {
                   13209:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   13210:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   13211:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   13212:                                                    '</li>'."\n";
                   13213:                                     }
1.1067    raeburn  13214:                                 }
1.1075.2.128  raeburn  13215:                             } else {
                   13216:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13217:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1067    raeburn  13218:                             }
1.1055    raeburn  13219:                         }
                   13220:                     }
1.1075.2.11  raeburn  13221:                 }
                   13222:             } else {
1.1075.2.128  raeburn  13223:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13224:                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1075.2.11  raeburn  13225:             }
                   13226:         }
                   13227:         for (my $i=1; $i<=$numitems; $i++) {
                   13228:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   13229:             my $path = $env{'form.archive_content_'.$i};
                   13230:             if ($path =~ /^\Q$pathtocheck\E/) {
                   13231:                 my ($title) = ($path =~ m{/([^/]+)$});
                   13232:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   13233:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   13234:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   13235:                         my ($itemidx,$fullpath,$relpath);
                   13236:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   13237:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  13238:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1075.2.11  raeburn  13239:                                 if ($dirorder{$i}->[$j] eq $container) {
                   13240:                                     $itemidx = $j;
1.1056    raeburn  13241:                                 }
                   13242:                             }
1.1075.2.11  raeburn  13243:                         }
                   13244:                         if ($itemidx eq '') {
                   13245:                             $itemidx =  0;
                   13246:                         }
                   13247:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   13248:                             if ($mapinner{$referrer{$i}}) {
                   13249:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   13250:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13251:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13252:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13253:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13254:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13255:                                             if (!-e $fullpath) {
                   13256:                                                 mkdir($fullpath,0755);
1.1056    raeburn  13257:                                             }
                   13258:                                         }
1.1075.2.11  raeburn  13259:                                     } else {
                   13260:                                         last;
1.1056    raeburn  13261:                                     }
1.1075.2.11  raeburn  13262:                                 }
                   13263:                             }
                   13264:                         } elsif ($newdest{$referrer{$i}}) {
                   13265:                             $fullpath = $newdest{$referrer{$i}};
                   13266:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   13267:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   13268:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   13269:                                     last;
                   13270:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   13271:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   13272:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13273:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   13274:                                         if (!-e $fullpath) {
                   13275:                                             mkdir($fullpath,0755);
1.1056    raeburn  13276:                                         }
                   13277:                                     }
1.1075.2.11  raeburn  13278:                                 } else {
                   13279:                                     last;
1.1056    raeburn  13280:                                 }
1.1075.2.11  raeburn  13281:                             }
                   13282:                         }
                   13283:                         if ($fullpath ne '') {
                   13284:                             if (-e "$prefix$path") {
1.1075.2.128  raeburn  13285:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   13286:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   13287:                                 }
1.1075.2.11  raeburn  13288:                             }
                   13289:                             if (-e "$fullpath/$title") {
                   13290:                                 my $showpath;
                   13291:                                 if ($relpath ne '') {
                   13292:                                     $showpath = "$relpath/$title";
                   13293:                                 } else {
                   13294:                                     $showpath = "/$title";
1.1056    raeburn  13295:                                 }
1.1075.2.128  raeburn  13296:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   13297:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   13298:                                            '</li>'."\n";
                   13299:                                 unless ($ishome) {
                   13300:                                     my $fetch = "$fullpath/$title";
                   13301:                                     $fetch =~ s/^\Q$prefix$dir\E//;
                   13302:                                     $prompttofetch{$fetch} = 1;
                   13303:                                 }
1.1055    raeburn  13304:                             }
                   13305:                         }
                   13306:                     }
1.1075.2.11  raeburn  13307:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   13308:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1075.2.128  raeburn  13309:                                     &HTML::Entities::encode($path,'<>&"'),
                   13310:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   13311:                                 '<br />';
1.1055    raeburn  13312:                 }
                   13313:             } else {
1.1075.2.128  raeburn  13314:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   13315:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  13316:             }
                   13317:         }
                   13318:         if (keys(%todelete)) {
                   13319:             foreach my $key (keys(%todelete)) {
                   13320:                 unlink($key);
1.1066    raeburn  13321:             }
                   13322:         }
                   13323:         if (keys(%todeletedir)) {
                   13324:             foreach my $key (keys(%todeletedir)) {
                   13325:                 rmdir($key);
                   13326:             }
                   13327:         }
                   13328:         foreach my $dir (sort(keys(%is_dir))) {
                   13329:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   13330:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  13331:             }
                   13332:         }
1.1067    raeburn  13333:         if ($result ne '') {
                   13334:             $output .= '<ul>'."\n".
                   13335:                        $result."\n".
                   13336:                        '</ul>';
                   13337:         }
                   13338:         unless ($ishome) {
                   13339:             my $replicationfail;
                   13340:             foreach my $item (keys(%prompttofetch)) {
                   13341:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   13342:                 unless ($fetchresult eq 'ok') {
                   13343:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   13344:                 }
                   13345:             }
                   13346:             if ($replicationfail) {
                   13347:                 $output .= '<p class="LC_error">'.
                   13348:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   13349:                            $replicationfail.
                   13350:                            '</ul></p>';
                   13351:             }
                   13352:         }
1.1055    raeburn  13353:     } else {
                   13354:         $warning = &mt('No items found in archive.');
                   13355:     }
                   13356:     if ($error) {
                   13357:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   13358:                    $error.'</p>'."\n";
                   13359:     }
                   13360:     if ($warning) {
                   13361:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   13362:     }
                   13363:     return $output;
                   13364: }
                   13365: 
1.1066    raeburn  13366: sub cleanup_empty_dirs {
                   13367:     my ($path) = @_;
                   13368:     if (($path ne '') && (-d $path)) {
                   13369:         if (opendir(my $dirh,$path)) {
                   13370:             my @dircontents = grep(!/^\./,readdir($dirh));
                   13371:             my $numitems = 0;
                   13372:             foreach my $item (@dircontents) {
                   13373:                 if (-d "$path/$item") {
1.1075.2.28  raeburn  13374:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  13375:                     if (-e "$path/$item") {
                   13376:                         $numitems ++;
                   13377:                     }
                   13378:                 } else {
                   13379:                     $numitems ++;
                   13380:                 }
                   13381:             }
                   13382:             if ($numitems == 0) {
                   13383:                 rmdir($path);
                   13384:             }
                   13385:             closedir($dirh);
                   13386:         }
                   13387:     }
                   13388:     return;
                   13389: }
                   13390: 
1.41      ng       13391: =pod
1.45      matthew  13392: 
1.1075.2.56  raeburn  13393: =item * &get_folder_hierarchy()
1.1068    raeburn  13394: 
                   13395: Provides hierarchy of names of folders/sub-folders containing the current
                   13396: item,
                   13397: 
                   13398: Inputs: 3
                   13399:      - $navmap - navmaps object
                   13400: 
                   13401:      - $map - url for map (either the trigger itself, or map containing
                   13402:                            the resource, which is the trigger).
                   13403: 
                   13404:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   13405: 
                   13406: Outputs: 1 @pathitems - array of folder/subfolder names.
                   13407: 
                   13408: =cut
                   13409: 
                   13410: sub get_folder_hierarchy {
                   13411:     my ($navmap,$map,$showitem) = @_;
                   13412:     my @pathitems;
                   13413:     if (ref($navmap)) {
                   13414:         my $mapres = $navmap->getResourceByUrl($map);
                   13415:         if (ref($mapres)) {
                   13416:             my $pcslist = $mapres->map_hierarchy();
                   13417:             if ($pcslist ne '') {
                   13418:                 my @pcs = split(/,/,$pcslist);
                   13419:                 foreach my $pc (@pcs) {
                   13420:                     if ($pc == 1) {
1.1075.2.38  raeburn  13421:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  13422:                     } else {
                   13423:                         my $res = $navmap->getByMapPc($pc);
                   13424:                         if (ref($res)) {
                   13425:                             my $title = $res->compTitle();
                   13426:                             $title =~ s/\W+/_/g;
                   13427:                             if ($title ne '') {
                   13428:                                 push(@pathitems,$title);
                   13429:                             }
                   13430:                         }
                   13431:                     }
                   13432:                 }
                   13433:             }
1.1071    raeburn  13434:             if ($showitem) {
                   13435:                 if ($mapres->{ID} eq '0.0') {
1.1075.2.38  raeburn  13436:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  13437:                 } else {
                   13438:                     my $maptitle = $mapres->compTitle();
                   13439:                     $maptitle =~ s/\W+/_/g;
                   13440:                     if ($maptitle ne '') {
                   13441:                         push(@pathitems,$maptitle);
                   13442:                     }
1.1068    raeburn  13443:                 }
                   13444:             }
                   13445:         }
                   13446:     }
                   13447:     return @pathitems;
                   13448: }
                   13449: 
                   13450: =pod
                   13451: 
1.1015    raeburn  13452: =item * &get_turnedin_filepath()
                   13453: 
                   13454: Determines path in a user's portfolio file for storage of files uploaded
                   13455: to a specific essayresponse or dropbox item.
                   13456: 
                   13457: Inputs: 3 required + 1 optional.
                   13458: $symb is symb for resource, $uname and $udom are for current user (required).
                   13459: $caller is optional (can be "submission", if routine is called when storing
                   13460: an upoaded file when "Submit Answer" button was pressed).
                   13461: 
                   13462: Returns array containing $path and $multiresp. 
                   13463: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   13464: than one file upload item.  Callers of routine should append partid as a 
                   13465: subdirectory to $path in cases where $multiresp is 1.
                   13466: 
                   13467: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   13468: 
                   13469: =cut
                   13470: 
                   13471: sub get_turnedin_filepath {
                   13472:     my ($symb,$uname,$udom,$caller) = @_;
                   13473:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   13474:     my $turnindir;
                   13475:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   13476:     $turnindir = $userhash{'turnindir'};
                   13477:     my ($path,$multiresp);
                   13478:     if ($turnindir eq '') {
                   13479:         if ($caller eq 'submission') {
                   13480:             $turnindir = &mt('turned in');
                   13481:             $turnindir =~ s/\W+/_/g;
                   13482:             my %newhash = (
                   13483:                             'turnindir' => $turnindir,
                   13484:                           );
                   13485:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   13486:         }
                   13487:     }
                   13488:     if ($turnindir ne '') {
                   13489:         $path = '/'.$turnindir.'/';
                   13490:         my ($multipart,$turnin,@pathitems);
                   13491:         my $navmap = Apache::lonnavmaps::navmap->new();
                   13492:         if (defined($navmap)) {
                   13493:             my $mapres = $navmap->getResourceByUrl($map);
                   13494:             if (ref($mapres)) {
                   13495:                 my $pcslist = $mapres->map_hierarchy();
                   13496:                 if ($pcslist ne '') {
                   13497:                     foreach my $pc (split(/,/,$pcslist)) {
                   13498:                         my $res = $navmap->getByMapPc($pc);
                   13499:                         if (ref($res)) {
                   13500:                             my $title = $res->compTitle();
                   13501:                             $title =~ s/\W+/_/g;
                   13502:                             if ($title ne '') {
1.1075.2.48  raeburn  13503:                                 if (($pc > 1) && (length($title) > 12)) {
                   13504:                                     $title = substr($title,0,12);
                   13505:                                 }
1.1015    raeburn  13506:                                 push(@pathitems,$title);
                   13507:                             }
                   13508:                         }
                   13509:                     }
                   13510:                 }
                   13511:                 my $maptitle = $mapres->compTitle();
                   13512:                 $maptitle =~ s/\W+/_/g;
                   13513:                 if ($maptitle ne '') {
1.1075.2.48  raeburn  13514:                     if (length($maptitle) > 12) {
                   13515:                         $maptitle = substr($maptitle,0,12);
                   13516:                     }
1.1015    raeburn  13517:                     push(@pathitems,$maptitle);
                   13518:                 }
                   13519:                 unless ($env{'request.state'} eq 'construct') {
                   13520:                     my $res = $navmap->getBySymb($symb);
                   13521:                     if (ref($res)) {
                   13522:                         my $partlist = $res->parts();
                   13523:                         my $totaluploads = 0;
                   13524:                         if (ref($partlist) eq 'ARRAY') {
                   13525:                             foreach my $part (@{$partlist}) {
                   13526:                                 my @types = $res->responseType($part);
                   13527:                                 my @ids = $res->responseIds($part);
                   13528:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   13529:                                     if ($types[$i] eq 'essay') {
                   13530:                                         my $partid = $part.'_'.$ids[$i];
                   13531:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   13532:                                             $totaluploads ++;
                   13533:                                         }
                   13534:                                     }
                   13535:                                 }
                   13536:                             }
                   13537:                             if ($totaluploads > 1) {
                   13538:                                 $multiresp = 1;
                   13539:                             }
                   13540:                         }
                   13541:                     }
                   13542:                 }
                   13543:             } else {
                   13544:                 return;
                   13545:             }
                   13546:         } else {
                   13547:             return;
                   13548:         }
                   13549:         my $restitle=&Apache::lonnet::gettitle($symb);
                   13550:         $restitle =~ s/\W+/_/g;
                   13551:         if ($restitle eq '') {
                   13552:             $restitle = ($resurl =~ m{/[^/]+$});
                   13553:             if ($restitle eq '') {
                   13554:                 $restitle = time;
                   13555:             }
                   13556:         }
1.1075.2.48  raeburn  13557:         if (length($restitle) > 12) {
                   13558:             $restitle = substr($restitle,0,12);
                   13559:         }
1.1015    raeburn  13560:         push(@pathitems,$restitle);
                   13561:         $path .= join('/',@pathitems);
                   13562:     }
                   13563:     return ($path,$multiresp);
                   13564: }
                   13565: 
                   13566: =pod
                   13567: 
1.464     albertel 13568: =back
1.41      ng       13569: 
1.112     bowersj2 13570: =head1 CSV Upload/Handling functions
1.38      albertel 13571: 
1.41      ng       13572: =over 4
                   13573: 
1.648     raeburn  13574: =item * &upfile_store($r)
1.41      ng       13575: 
                   13576: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 13577: needs $env{'form.upfile'}
1.41      ng       13578: returns $datatoken to be put into hidden field
                   13579: 
                   13580: =cut
1.31      albertel 13581: 
                   13582: sub upfile_store {
                   13583:     my $r=shift;
1.258     albertel 13584:     $env{'form.upfile'}=~s/\r/\n/gs;
                   13585:     $env{'form.upfile'}=~s/\f/\n/gs;
                   13586:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   13587:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 13588: 
1.1075.2.128  raeburn  13589:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   13590:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   13591:                                      time.'_'.$$);
                   13592:     return if ($datatoken eq '');
                   13593: 
1.31      albertel 13594:     {
1.158     raeburn  13595:         my $datafile = $r->dir_config('lonDaemons').
                   13596:                            '/tmp/'.$datatoken.'.tmp';
1.1075.2.128  raeburn  13597:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 13598:             print $fh $env{'form.upfile'};
1.158     raeburn  13599:             close($fh);
                   13600:         }
1.31      albertel 13601:     }
                   13602:     return $datatoken;
                   13603: }
                   13604: 
1.56      matthew  13605: =pod
                   13606: 
1.1075.2.128  raeburn  13607: =item * &load_tmp_file($r,$datatoken)
1.41      ng       13608: 
                   13609: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1075.2.128  raeburn  13610: $datatoken is the name to assign to the temporary file.
1.258     albertel 13611: sets $env{'form.upfile'} to the contents of the file
1.41      ng       13612: 
                   13613: =cut
1.31      albertel 13614: 
                   13615: sub load_tmp_file {
1.1075.2.128  raeburn  13616:     my ($r,$datatoken) = @_;
                   13617:     return if ($datatoken eq '');
1.31      albertel 13618:     my @studentdata=();
                   13619:     {
1.158     raeburn  13620:         my $studentfile = $r->dir_config('lonDaemons').
1.1075.2.128  raeburn  13621:                               '/tmp/'.$datatoken.'.tmp';
                   13622:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  13623:             @studentdata=<$fh>;
                   13624:             close($fh);
                   13625:         }
1.31      albertel 13626:     }
1.258     albertel 13627:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 13628: }
                   13629: 
1.1075.2.128  raeburn  13630: sub valid_datatoken {
                   13631:     my ($datatoken) = @_;
1.1075.2.131  raeburn  13632:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1075.2.128  raeburn  13633:         return $datatoken;
                   13634:     }
                   13635:     return;
                   13636: }
                   13637: 
1.56      matthew  13638: =pod
                   13639: 
1.648     raeburn  13640: =item * &upfile_record_sep()
1.41      ng       13641: 
                   13642: Separate uploaded file into records
                   13643: returns array of records,
1.258     albertel 13644: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       13645: 
                   13646: =cut
1.31      albertel 13647: 
                   13648: sub upfile_record_sep {
1.258     albertel 13649:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 13650:     } else {
1.248     albertel 13651: 	my @records;
1.258     albertel 13652: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 13653: 	    if ($line=~/^\s*$/) { next; }
                   13654: 	    push(@records,$line);
                   13655: 	}
                   13656: 	return @records;
1.31      albertel 13657:     }
                   13658: }
                   13659: 
1.56      matthew  13660: =pod
                   13661: 
1.648     raeburn  13662: =item * &record_sep($record)
1.41      ng       13663: 
1.258     albertel 13664: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       13665: 
                   13666: =cut
                   13667: 
1.263     www      13668: sub takeleft {
                   13669:     my $index=shift;
                   13670:     return substr('0000'.$index,-4,4);
                   13671: }
                   13672: 
1.31      albertel 13673: sub record_sep {
                   13674:     my $record=shift;
                   13675:     my %components=();
1.258     albertel 13676:     if ($env{'form.upfiletype'} eq 'xml') {
                   13677:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 13678:         my $i=0;
1.356     albertel 13679:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 13680:             $field=~s/^(\"|\')//;
                   13681:             $field=~s/(\"|\')$//;
1.263     www      13682:             $components{&takeleft($i)}=$field;
1.31      albertel 13683:             $i++;
                   13684:         }
1.258     albertel 13685:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 13686:         my $i=0;
1.356     albertel 13687:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 13688:             $field=~s/^(\"|\')//;
                   13689:             $field=~s/(\"|\')$//;
1.263     www      13690:             $components{&takeleft($i)}=$field;
1.31      albertel 13691:             $i++;
                   13692:         }
                   13693:     } else {
1.561     www      13694:         my $separator=',';
1.480     banghart 13695:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      13696:             $separator=';';
1.480     banghart 13697:         }
1.31      albertel 13698:         my $i=0;
1.561     www      13699: # the character we are looking for to indicate the end of a quote or a record 
                   13700:         my $looking_for=$separator;
                   13701: # do not add the characters to the fields
                   13702:         my $ignore=0;
                   13703: # we just encountered a separator (or the beginning of the record)
                   13704:         my $just_found_separator=1;
                   13705: # store the field we are working on here
                   13706:         my $field='';
                   13707: # work our way through all characters in record
                   13708:         foreach my $character ($record=~/(.)/g) {
                   13709:             if ($character eq $looking_for) {
                   13710:                if ($character ne $separator) {
                   13711: # Found the end of a quote, again looking for separator
                   13712:                   $looking_for=$separator;
                   13713:                   $ignore=1;
                   13714:                } else {
                   13715: # Found a separator, store away what we got
                   13716:                   $components{&takeleft($i)}=$field;
                   13717: 	          $i++;
                   13718:                   $just_found_separator=1;
                   13719:                   $ignore=0;
                   13720:                   $field='';
                   13721:                }
                   13722:                next;
                   13723:             }
                   13724: # single or double quotation marks after a separator indicate beginning of a quote
                   13725: # we are now looking for the end of the quote and need to ignore separators
                   13726:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   13727:                $looking_for=$character;
                   13728:                next;
                   13729:             }
                   13730: # ignore would be true after we reached the end of a quote
                   13731:             if ($ignore) { next; }
                   13732:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   13733:             $field.=$character;
                   13734:             $just_found_separator=0; 
1.31      albertel 13735:         }
1.561     www      13736: # catch the very last entry, since we never encountered the separator
                   13737:         $components{&takeleft($i)}=$field;
1.31      albertel 13738:     }
                   13739:     return %components;
                   13740: }
                   13741: 
1.144     matthew  13742: ######################################################
                   13743: ######################################################
                   13744: 
1.56      matthew  13745: =pod
                   13746: 
1.648     raeburn  13747: =item * &upfile_select_html()
1.41      ng       13748: 
1.144     matthew  13749: Return HTML code to select a file from the users machine and specify 
                   13750: the file type.
1.41      ng       13751: 
                   13752: =cut
                   13753: 
1.144     matthew  13754: ######################################################
                   13755: ######################################################
1.31      albertel 13756: sub upfile_select_html {
1.144     matthew  13757:     my %Types = (
                   13758:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 13759:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  13760:                  space => &mt('Space separated'),
                   13761:                  tab   => &mt('Tabulator separated'),
                   13762: #                 xml   => &mt('HTML/XML'),
                   13763:                  );
                   13764:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  13765:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  13766:     foreach my $type (sort(keys(%Types))) {
                   13767:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   13768:     }
                   13769:     $Str .= "</select>\n";
                   13770:     return $Str;
1.31      albertel 13771: }
                   13772: 
1.301     albertel 13773: sub get_samples {
                   13774:     my ($records,$toget) = @_;
                   13775:     my @samples=({});
                   13776:     my $got=0;
                   13777:     foreach my $rec (@$records) {
                   13778: 	my %temp = &record_sep($rec);
                   13779: 	if (! grep(/\S/, values(%temp))) { next; }
                   13780: 	if (%temp) {
                   13781: 	    $samples[$got]=\%temp;
                   13782: 	    $got++;
                   13783: 	    if ($got == $toget) { last; }
                   13784: 	}
                   13785:     }
                   13786:     return \@samples;
                   13787: }
                   13788: 
1.144     matthew  13789: ######################################################
                   13790: ######################################################
                   13791: 
1.56      matthew  13792: =pod
                   13793: 
1.648     raeburn  13794: =item * &csv_print_samples($r,$records)
1.41      ng       13795: 
                   13796: Prints a table of sample values from each column uploaded $r is an
                   13797: Apache Request ref, $records is an arrayref from
                   13798: &Apache::loncommon::upfile_record_sep
                   13799: 
                   13800: =cut
                   13801: 
1.144     matthew  13802: ######################################################
                   13803: ######################################################
1.31      albertel 13804: sub csv_print_samples {
                   13805:     my ($r,$records) = @_;
1.662     bisitz   13806:     my $samples = &get_samples($records,5);
1.301     albertel 13807: 
1.594     raeburn  13808:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   13809:               &start_data_table_header_row());
1.356     albertel 13810:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   13811:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  13812:     $r->print(&end_data_table_header_row());
1.301     albertel 13813:     foreach my $hash (@$samples) {
1.594     raeburn  13814: 	$r->print(&start_data_table_row());
1.356     albertel 13815: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 13816: 	    $r->print('<td>');
1.356     albertel 13817: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 13818: 	    $r->print('</td>');
                   13819: 	}
1.594     raeburn  13820: 	$r->print(&end_data_table_row());
1.31      albertel 13821:     }
1.594     raeburn  13822:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 13823: }
                   13824: 
1.144     matthew  13825: ######################################################
                   13826: ######################################################
                   13827: 
1.56      matthew  13828: =pod
                   13829: 
1.648     raeburn  13830: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       13831: 
                   13832: Prints a table to create associations between values and table columns.
1.144     matthew  13833: 
1.41      ng       13834: $r is an Apache Request ref,
                   13835: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  13836: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       13837: 
                   13838: =cut
                   13839: 
1.144     matthew  13840: ######################################################
                   13841: ######################################################
1.31      albertel 13842: sub csv_print_select_table {
                   13843:     my ($r,$records,$d) = @_;
1.301     albertel 13844:     my $i=0;
                   13845:     my $samples = &get_samples($records,1);
1.144     matthew  13846:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  13847: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  13848:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  13849:               '<th>'.&mt('Column').'</th>'.
                   13850:               &end_data_table_header_row()."\n");
1.356     albertel 13851:     foreach my $array_ref (@$d) {
                   13852: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  13853: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 13854: 
1.875     bisitz   13855: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  13856: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 13857: 	$r->print('<option value="none"></option>');
1.356     albertel 13858: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   13859: 	    $r->print('<option value="'.$sample.'"'.
                   13860:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   13861:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 13862: 	}
1.594     raeburn  13863: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 13864: 	$i++;
                   13865:     }
1.594     raeburn  13866:     $r->print(&end_data_table());
1.31      albertel 13867:     $i--;
                   13868:     return $i;
                   13869: }
1.56      matthew  13870: 
1.144     matthew  13871: ######################################################
                   13872: ######################################################
                   13873: 
1.56      matthew  13874: =pod
1.31      albertel 13875: 
1.648     raeburn  13876: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       13877: 
                   13878: Prints a table of sample values from the upload and can make associate samples to internal names.
                   13879: 
                   13880: $r is an Apache Request ref,
                   13881: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   13882: $d is an array of 2 element arrays (internal name, displayed name)
                   13883: 
                   13884: =cut
                   13885: 
1.144     matthew  13886: ######################################################
                   13887: ######################################################
1.31      albertel 13888: sub csv_samples_select_table {
                   13889:     my ($r,$records,$d) = @_;
                   13890:     my $i=0;
1.144     matthew  13891:     #
1.662     bisitz   13892:     my $max_samples = 5;
                   13893:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  13894:     $r->print(&start_data_table().
                   13895:               &start_data_table_header_row().'<th>'.
                   13896:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   13897:               &end_data_table_header_row());
1.301     albertel 13898: 
                   13899:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  13900: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  13901: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 13902: 	foreach my $option (@$d) {
                   13903: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  13904: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 13905:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  13906:                       $display.'</option>');
1.31      albertel 13907: 	}
                   13908: 	$r->print('</select></td><td>');
1.662     bisitz   13909: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 13910: 	    if (defined($samples->[$line]{$key})) { 
                   13911: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   13912: 	    }
                   13913: 	}
1.594     raeburn  13914: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 13915: 	$i++;
                   13916:     }
1.594     raeburn  13917:     $r->print(&end_data_table());
1.31      albertel 13918:     $i--;
                   13919:     return($i);
1.115     matthew  13920: }
                   13921: 
1.144     matthew  13922: ######################################################
                   13923: ######################################################
                   13924: 
1.115     matthew  13925: =pod
                   13926: 
1.648     raeburn  13927: =item * &clean_excel_name($name)
1.115     matthew  13928: 
                   13929: Returns a replacement for $name which does not contain any illegal characters.
                   13930: 
                   13931: =cut
                   13932: 
1.144     matthew  13933: ######################################################
                   13934: ######################################################
1.115     matthew  13935: sub clean_excel_name {
                   13936:     my ($name) = @_;
                   13937:     $name =~ s/[:\*\?\/\\]//g;
                   13938:     if (length($name) > 31) {
                   13939:         $name = substr($name,0,31);
                   13940:     }
                   13941:     return $name;
1.25      albertel 13942: }
1.84      albertel 13943: 
1.85      albertel 13944: =pod
                   13945: 
1.648     raeburn  13946: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 13947: 
                   13948: Returns either 1 or undef
                   13949: 
                   13950: 1 if the part is to be hidden, undef if it is to be shown
                   13951: 
                   13952: Arguments are:
                   13953: 
                   13954: $id the id of the part to be checked
                   13955: $symb, optional the symb of the resource to check
                   13956: $udom, optional the domain of the user to check for
                   13957: $uname, optional the username of the user to check for
                   13958: 
                   13959: =cut
1.84      albertel 13960: 
                   13961: sub check_if_partid_hidden {
                   13962:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 13963:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 13964: 					 $symb,$udom,$uname);
1.141     albertel 13965:     my $truth=1;
                   13966:     #if the string starts with !, then the list is the list to show not hide
                   13967:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 13968:     my @hiddenlist=split(/,/,$hiddenparts);
                   13969:     foreach my $checkid (@hiddenlist) {
1.141     albertel 13970: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 13971:     }
1.141     albertel 13972:     return !$truth;
1.84      albertel 13973: }
1.127     matthew  13974: 
1.138     matthew  13975: 
                   13976: ############################################################
                   13977: ############################################################
                   13978: 
                   13979: =pod
                   13980: 
1.157     matthew  13981: =back 
                   13982: 
1.138     matthew  13983: =head1 cgi-bin script and graphing routines
                   13984: 
1.157     matthew  13985: =over 4
                   13986: 
1.648     raeburn  13987: =item * &get_cgi_id()
1.138     matthew  13988: 
                   13989: Inputs: none
                   13990: 
                   13991: Returns an id which can be used to pass environment variables
                   13992: to various cgi-bin scripts.  These environment variables will
                   13993: be removed from the users environment after a given time by
                   13994: the routine &Apache::lonnet::transfer_profile_to_env.
                   13995: 
                   13996: =cut
                   13997: 
                   13998: ############################################################
                   13999: ############################################################
1.152     albertel 14000: my $uniq=0;
1.136     matthew  14001: sub get_cgi_id {
1.154     albertel 14002:     $uniq=($uniq+1)%100000;
1.280     albertel 14003:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  14004: }
                   14005: 
1.127     matthew  14006: ############################################################
                   14007: ############################################################
                   14008: 
                   14009: =pod
                   14010: 
1.648     raeburn  14011: =item * &DrawBarGraph()
1.127     matthew  14012: 
1.138     matthew  14013: Facilitates the plotting of data in a (stacked) bar graph.
                   14014: Puts plot definition data into the users environment in order for 
                   14015: graph.png to plot it.  Returns an <img> tag for the plot.
                   14016: The bars on the plot are labeled '1','2',...,'n'.
                   14017: 
                   14018: Inputs:
                   14019: 
                   14020: =over 4
                   14021: 
                   14022: =item $Title: string, the title of the plot
                   14023: 
                   14024: =item $xlabel: string, text describing the X-axis of the plot
                   14025: 
                   14026: =item $ylabel: string, text describing the Y-axis of the plot
                   14027: 
                   14028: =item $Max: scalar, the maximum Y value to use in the plot
                   14029: If $Max is < any data point, the graph will not be rendered.
                   14030: 
1.140     matthew  14031: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  14032: they are plotted.  If undefined, default values will be used.
                   14033: 
1.178     matthew  14034: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   14035: 
1.138     matthew  14036: =item @Values: An array of array references.  Each array reference holds data
                   14037: to be plotted in a stacked bar chart.
                   14038: 
1.239     matthew  14039: =item If the final element of @Values is a hash reference the key/value
                   14040: pairs will be added to the graph definition.
                   14041: 
1.138     matthew  14042: =back
                   14043: 
                   14044: Returns:
                   14045: 
                   14046: An <img> tag which references graph.png and the appropriate identifying
                   14047: information for the plot.
                   14048: 
1.127     matthew  14049: =cut
                   14050: 
                   14051: ############################################################
                   14052: ############################################################
1.134     matthew  14053: sub DrawBarGraph {
1.178     matthew  14054:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  14055:     #
                   14056:     if (! defined($colors)) {
                   14057:         $colors = ['#33ff00', 
                   14058:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   14059:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   14060:                   ]; 
                   14061:     }
1.228     matthew  14062:     my $extra_settings = {};
                   14063:     if (ref($Values[-1]) eq 'HASH') {
                   14064:         $extra_settings = pop(@Values);
                   14065:     }
1.127     matthew  14066:     #
1.136     matthew  14067:     my $identifier = &get_cgi_id();
                   14068:     my $id = 'cgi.'.$identifier;        
1.129     matthew  14069:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  14070:         return '';
                   14071:     }
1.225     matthew  14072:     #
                   14073:     my @Labels;
                   14074:     if (defined($labels)) {
                   14075:         @Labels = @$labels;
                   14076:     } else {
                   14077:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1075.2.119  raeburn  14078:             push(@Labels,$i+1);
1.225     matthew  14079:         }
                   14080:     }
                   14081:     #
1.129     matthew  14082:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  14083:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  14084:     my %ValuesHash;
                   14085:     my $NumSets=1;
                   14086:     foreach my $array (@Values) {
                   14087:         next if (! ref($array));
1.136     matthew  14088:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  14089:             join(',',@$array);
1.129     matthew  14090:     }
1.127     matthew  14091:     #
1.136     matthew  14092:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  14093:     if ($NumBars < 3) {
                   14094:         $width = 120+$NumBars*32;
1.220     matthew  14095:         $xskip = 1;
1.225     matthew  14096:         $bar_width = 30;
                   14097:     } elsif ($NumBars < 5) {
                   14098:         $width = 120+$NumBars*20;
                   14099:         $xskip = 1;
                   14100:         $bar_width = 20;
1.220     matthew  14101:     } elsif ($NumBars < 10) {
1.136     matthew  14102:         $width = 120+$NumBars*15;
                   14103:         $xskip = 1;
                   14104:         $bar_width = 15;
                   14105:     } elsif ($NumBars <= 25) {
                   14106:         $width = 120+$NumBars*11;
                   14107:         $xskip = 5;
                   14108:         $bar_width = 8;
                   14109:     } elsif ($NumBars <= 50) {
                   14110:         $width = 120+$NumBars*8;
                   14111:         $xskip = 5;
                   14112:         $bar_width = 4;
                   14113:     } else {
                   14114:         $width = 120+$NumBars*8;
                   14115:         $xskip = 5;
                   14116:         $bar_width = 4;
                   14117:     }
                   14118:     #
1.137     matthew  14119:     $Max = 1 if ($Max < 1);
                   14120:     if ( int($Max) < $Max ) {
                   14121:         $Max++;
                   14122:         $Max = int($Max);
                   14123:     }
1.127     matthew  14124:     $Title  = '' if (! defined($Title));
                   14125:     $xlabel = '' if (! defined($xlabel));
                   14126:     $ylabel = '' if (! defined($ylabel));
1.369     www      14127:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   14128:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   14129:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  14130:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  14131:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   14132:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   14133:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   14134:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14135:     $ValuesHash{$id.'.height'}   = $height;
                   14136:     $ValuesHash{$id.'.width'}    = $width;
                   14137:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   14138:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   14139:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  14140:     #
1.228     matthew  14141:     # Deal with other parameters
                   14142:     while (my ($key,$value) = each(%$extra_settings)) {
                   14143:         $ValuesHash{$id.'.'.$key} = $value;
                   14144:     }
                   14145:     #
1.646     raeburn  14146:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  14147:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14148: }
                   14149: 
                   14150: ############################################################
                   14151: ############################################################
                   14152: 
                   14153: =pod
                   14154: 
1.648     raeburn  14155: =item * &DrawXYGraph()
1.137     matthew  14156: 
1.138     matthew  14157: Facilitates the plotting of data in an XY graph.
                   14158: Puts plot definition data into the users environment in order for 
                   14159: graph.png to plot it.  Returns an <img> tag for the plot.
                   14160: 
                   14161: Inputs:
                   14162: 
                   14163: =over 4
                   14164: 
                   14165: =item $Title: string, the title of the plot
                   14166: 
                   14167: =item $xlabel: string, text describing the X-axis of the plot
                   14168: 
                   14169: =item $ylabel: string, text describing the Y-axis of the plot
                   14170: 
                   14171: =item $Max: scalar, the maximum Y value to use in the plot
                   14172: If $Max is < any data point, the graph will not be rendered.
                   14173: 
                   14174: =item $colors: Array ref containing the hex color codes for the data to be 
                   14175: plotted in.  If undefined, default values will be used.
                   14176: 
                   14177: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14178: 
                   14179: =item $Ydata: Array ref containing Array refs.  
1.185     www      14180: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  14181: 
                   14182: =item %Values: hash indicating or overriding any default values which are 
                   14183: passed to graph.png.  
                   14184: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14185: 
                   14186: =back
                   14187: 
                   14188: Returns:
                   14189: 
                   14190: An <img> tag which references graph.png and the appropriate identifying
                   14191: information for the plot.
                   14192: 
1.137     matthew  14193: =cut
                   14194: 
                   14195: ############################################################
                   14196: ############################################################
                   14197: sub DrawXYGraph {
                   14198:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   14199:     #
                   14200:     # Create the identifier for the graph
                   14201:     my $identifier = &get_cgi_id();
                   14202:     my $id = 'cgi.'.$identifier;
                   14203:     #
                   14204:     $Title  = '' if (! defined($Title));
                   14205:     $xlabel = '' if (! defined($xlabel));
                   14206:     $ylabel = '' if (! defined($ylabel));
                   14207:     my %ValuesHash = 
                   14208:         (
1.369     www      14209:          $id.'.title'  => &escape($Title),
                   14210:          $id.'.xlabel' => &escape($xlabel),
                   14211:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  14212:          $id.'.y_max_value'=> $Max,
                   14213:          $id.'.labels'     => join(',',@$Xlabels),
                   14214:          $id.'.PlotType'   => 'XY',
                   14215:          );
                   14216:     #
                   14217:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14218:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14219:     }
                   14220:     #
                   14221:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   14222:         return '';
                   14223:     }
                   14224:     my $NumSets=1;
1.138     matthew  14225:     foreach my $array (@{$Ydata}){
1.137     matthew  14226:         next if (! ref($array));
                   14227:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   14228:     }
1.138     matthew  14229:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  14230:     #
                   14231:     # Deal with other parameters
                   14232:     while (my ($key,$value) = each(%Values)) {
                   14233:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  14234:     }
                   14235:     #
1.646     raeburn  14236:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  14237:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   14238: }
                   14239: 
                   14240: ############################################################
                   14241: ############################################################
                   14242: 
                   14243: =pod
                   14244: 
1.648     raeburn  14245: =item * &DrawXYYGraph()
1.138     matthew  14246: 
                   14247: Facilitates the plotting of data in an XY graph with two Y axes.
                   14248: Puts plot definition data into the users environment in order for 
                   14249: graph.png to plot it.  Returns an <img> tag for the plot.
                   14250: 
                   14251: Inputs:
                   14252: 
                   14253: =over 4
                   14254: 
                   14255: =item $Title: string, the title of the plot
                   14256: 
                   14257: =item $xlabel: string, text describing the X-axis of the plot
                   14258: 
                   14259: =item $ylabel: string, text describing the Y-axis of the plot
                   14260: 
                   14261: =item $colors: Array ref containing the hex color codes for the data to be 
                   14262: plotted in.  If undefined, default values will be used.
                   14263: 
                   14264: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   14265: 
                   14266: =item $Ydata1: The first data set
                   14267: 
                   14268: =item $Min1: The minimum value of the left Y-axis
                   14269: 
                   14270: =item $Max1: The maximum value of the left Y-axis
                   14271: 
                   14272: =item $Ydata2: The second data set
                   14273: 
                   14274: =item $Min2: The minimum value of the right Y-axis
                   14275: 
                   14276: =item $Max2: The maximum value of the left Y-axis
                   14277: 
                   14278: =item %Values: hash indicating or overriding any default values which are 
                   14279: passed to graph.png.  
                   14280: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   14281: 
                   14282: =back
                   14283: 
                   14284: Returns:
                   14285: 
                   14286: An <img> tag which references graph.png and the appropriate identifying
                   14287: information for the plot.
1.136     matthew  14288: 
                   14289: =cut
                   14290: 
                   14291: ############################################################
                   14292: ############################################################
1.137     matthew  14293: sub DrawXYYGraph {
                   14294:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   14295:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  14296:     #
                   14297:     # Create the identifier for the graph
                   14298:     my $identifier = &get_cgi_id();
                   14299:     my $id = 'cgi.'.$identifier;
                   14300:     #
                   14301:     $Title  = '' if (! defined($Title));
                   14302:     $xlabel = '' if (! defined($xlabel));
                   14303:     $ylabel = '' if (! defined($ylabel));
                   14304:     my %ValuesHash = 
                   14305:         (
1.369     www      14306:          $id.'.title'  => &escape($Title),
                   14307:          $id.'.xlabel' => &escape($xlabel),
                   14308:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  14309:          $id.'.labels' => join(',',@$Xlabels),
                   14310:          $id.'.PlotType' => 'XY',
                   14311:          $id.'.NumSets' => 2,
1.137     matthew  14312:          $id.'.two_axes' => 1,
                   14313:          $id.'.y1_max_value' => $Max1,
                   14314:          $id.'.y1_min_value' => $Min1,
                   14315:          $id.'.y2_max_value' => $Max2,
                   14316:          $id.'.y2_min_value' => $Min2,
1.136     matthew  14317:          );
                   14318:     #
1.137     matthew  14319:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   14320:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   14321:     }
                   14322:     #
                   14323:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   14324:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  14325:         return '';
                   14326:     }
                   14327:     my $NumSets=1;
1.137     matthew  14328:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  14329:         next if (! ref($array));
                   14330:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  14331:     }
                   14332:     #
                   14333:     # Deal with other parameters
                   14334:     while (my ($key,$value) = each(%Values)) {
                   14335:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  14336:     }
                   14337:     #
1.646     raeburn  14338:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 14339:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  14340: }
                   14341: 
                   14342: ############################################################
                   14343: ############################################################
                   14344: 
                   14345: =pod
                   14346: 
1.157     matthew  14347: =back 
                   14348: 
1.139     matthew  14349: =head1 Statistics helper routines?  
                   14350: 
                   14351: Bad place for them but what the hell.
                   14352: 
1.157     matthew  14353: =over 4
                   14354: 
1.648     raeburn  14355: =item * &chartlink()
1.139     matthew  14356: 
                   14357: Returns a link to the chart for a specific student.  
                   14358: 
                   14359: Inputs:
                   14360: 
                   14361: =over 4
                   14362: 
                   14363: =item $linktext: The text of the link
                   14364: 
                   14365: =item $sname: The students username
                   14366: 
                   14367: =item $sdomain: The students domain
                   14368: 
                   14369: =back
                   14370: 
1.157     matthew  14371: =back
                   14372: 
1.139     matthew  14373: =cut
                   14374: 
                   14375: ############################################################
                   14376: ############################################################
                   14377: sub chartlink {
                   14378:     my ($linktext, $sname, $sdomain) = @_;
                   14379:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      14380:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 14381:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  14382:        '">'.$linktext.'</a>';
1.153     matthew  14383: }
                   14384: 
                   14385: #######################################################
                   14386: #######################################################
                   14387: 
                   14388: =pod
                   14389: 
                   14390: =head1 Course Environment Routines
1.157     matthew  14391: 
                   14392: =over 4
1.153     matthew  14393: 
1.648     raeburn  14394: =item * &restore_course_settings()
1.153     matthew  14395: 
1.648     raeburn  14396: =item * &store_course_settings()
1.153     matthew  14397: 
                   14398: Restores/Store indicated form parameters from the course environment.
                   14399: Will not overwrite existing values of the form parameters.
                   14400: 
                   14401: Inputs: 
                   14402: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   14403: 
                   14404: a hash ref describing the data to be stored.  For example:
                   14405:    
                   14406: %Save_Parameters = ('Status' => 'scalar',
                   14407:     'chartoutputmode' => 'scalar',
                   14408:     'chartoutputdata' => 'scalar',
                   14409:     'Section' => 'array',
1.373     raeburn  14410:     'Group' => 'array',
1.153     matthew  14411:     'StudentData' => 'array',
                   14412:     'Maps' => 'array');
                   14413: 
                   14414: Returns: both routines return nothing
                   14415: 
1.631     raeburn  14416: =back
                   14417: 
1.153     matthew  14418: =cut
                   14419: 
                   14420: #######################################################
                   14421: #######################################################
                   14422: sub store_course_settings {
1.496     albertel 14423:     return &store_settings($env{'request.course.id'},@_);
                   14424: }
                   14425: 
                   14426: sub store_settings {
1.153     matthew  14427:     # save to the environment
                   14428:     # appenv the same items, just to be safe
1.300     albertel 14429:     my $udom  = $env{'user.domain'};
                   14430:     my $uname = $env{'user.name'};
1.496     albertel 14431:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14432:     my %SaveHash;
                   14433:     my %AppHash;
                   14434:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 14435:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 14436:         my $envname = 'environment.'.$basename;
1.258     albertel 14437:         if (exists($env{'form.'.$setting})) {
1.153     matthew  14438:             # Save this value away
                   14439:             if ($type eq 'scalar' &&
1.258     albertel 14440:                 (! exists($env{$envname}) || 
                   14441:                  $env{$envname} ne $env{'form.'.$setting})) {
                   14442:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   14443:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  14444:             } elsif ($type eq 'array') {
                   14445:                 my $stored_form;
1.258     albertel 14446:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  14447:                     $stored_form = join(',',
                   14448:                                         map {
1.369     www      14449:                                             &escape($_);
1.258     albertel 14450:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  14451:                 } else {
                   14452:                     $stored_form = 
1.369     www      14453:                         &escape($env{'form.'.$setting});
1.153     matthew  14454:                 }
                   14455:                 # Determine if the array contents are the same.
1.258     albertel 14456:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  14457:                     $SaveHash{$basename} = $stored_form;
                   14458:                     $AppHash{$envname}   = $stored_form;
                   14459:                 }
                   14460:             }
                   14461:         }
                   14462:     }
                   14463:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 14464:                                           $udom,$uname);
1.153     matthew  14465:     if ($put_result !~ /^(ok|delayed)/) {
                   14466:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   14467:                                  'got error:'.$put_result);
                   14468:     }
                   14469:     # Make sure these settings stick around in this session, too
1.646     raeburn  14470:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  14471:     return;
                   14472: }
                   14473: 
                   14474: sub restore_course_settings {
1.499     albertel 14475:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 14476: }
                   14477: 
                   14478: sub restore_settings {
                   14479:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  14480:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 14481:         next if (exists($env{'form.'.$setting}));
1.496     albertel 14482:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  14483:             '.'.$setting;
1.258     albertel 14484:         if (exists($env{$envname})) {
1.153     matthew  14485:             if ($type eq 'scalar') {
1.258     albertel 14486:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  14487:             } elsif ($type eq 'array') {
1.258     albertel 14488:                 $env{'form.'.$setting} = [ 
1.153     matthew  14489:                                            map { 
1.369     www      14490:                                                &unescape($_); 
1.258     albertel 14491:                                            } split(',',$env{$envname})
1.153     matthew  14492:                                            ];
                   14493:             }
                   14494:         }
                   14495:     }
1.127     matthew  14496: }
                   14497: 
1.618     raeburn  14498: #######################################################
                   14499: #######################################################
                   14500: 
                   14501: =pod
                   14502: 
                   14503: =head1 Domain E-mail Routines  
                   14504: 
                   14505: =over 4
                   14506: 
1.648     raeburn  14507: =item * &build_recipient_list()
1.618     raeburn  14508: 
1.1075.2.44  raeburn  14509: Build recipient lists for following types of e-mail:
1.766     raeburn  14510: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1075.2.44  raeburn  14511: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   14512: module change checking, student/employee ID conflict checks, as
                   14513: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   14514: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  14515: 
                   14516: Inputs:
1.1075.2.44  raeburn  14517: defmail (scalar - email address of default recipient),
                   14518: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   14519: requestsmail, updatesmail, or idconflictsmail).
                   14520: 
1.619     raeburn  14521: defdom (domain for which to retrieve configuration settings),
1.1075.2.44  raeburn  14522: 
                   14523: origmail (scalar - email address of recipient from loncapa.conf,
                   14524: i.e., predates configuration by DC via domainprefs.pm
1.618     raeburn  14525: 
1.1075.2.139  raeburn  14526: $requname username of requester (if mailing type is helpdeskmail)
                   14527: 
                   14528: $requdom domain of requester (if mailing type is helpdeskmail)
                   14529: 
                   14530: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   14531: 
1.655     raeburn  14532: Returns: comma separated list of addresses to which to send e-mail.
                   14533: 
                   14534: =back
1.618     raeburn  14535: 
                   14536: =cut
                   14537: 
                   14538: ############################################################
                   14539: ############################################################
                   14540: sub build_recipient_list {
1.1075.2.139  raeburn  14541:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  14542:     my @recipients;
1.1075.2.122  raeburn  14543:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  14544:     my %domconfig =
1.1075.2.122  raeburn  14545:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  14546:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  14547:         if (exists($domconfig{'contacts'}{$mailing})) {
                   14548:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   14549:                 my @contacts = ('adminemail','supportemail');
                   14550:                 foreach my $item (@contacts) {
                   14551:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   14552:                         my $addr = $domconfig{'contacts'}{$item}; 
                   14553:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14554:                             push(@recipients,$addr);
                   14555:                         }
1.619     raeburn  14556:                     }
1.1075.2.122  raeburn  14557:                 }
                   14558:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   14559:                 if ($mailing eq 'helpdeskmail') {
                   14560:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   14561:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   14562:                         my @ok_bccs;
                   14563:                         foreach my $bcc (@bccs) {
                   14564:                             $bcc =~ s/^\s+//g;
                   14565:                             $bcc =~ s/\s+$//g;
                   14566:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14567:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14568:                                     push(@ok_bccs,$bcc);
                   14569:                                 }
                   14570:                             }
                   14571:                         }
                   14572:                         if (@ok_bccs > 0) {
                   14573:                             $allbcc = join(', ',@ok_bccs);
                   14574:                         }
                   14575:                     }
                   14576:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  14577:                 }
                   14578:             }
1.766     raeburn  14579:         } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14580:             $lastresort = $origmail;
1.618     raeburn  14581:         }
1.1075.2.139  raeburn  14582:         if ($mailing eq 'helpdeskmail') {
                   14583:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   14584:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   14585:                 my ($inststatus,$inststatus_checked);
                   14586:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   14587:                     ($env{'user.domain'} ne 'public')) {
                   14588:                     $inststatus_checked = 1;
                   14589:                     $inststatus = $env{'environment.inststatus'};
                   14590:                 }
                   14591:                 unless ($inststatus_checked) {
                   14592:                     if (($requname ne '') && ($requdom ne '')) {
                   14593:                         if (($requname =~ /^$match_username$/) &&
                   14594:                             ($requdom =~ /^$match_domain$/) &&
                   14595:                             (&Apache::lonnet::domain($requdom))) {
                   14596:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   14597:                                                                       $requdom);
                   14598:                             unless ($requhome eq 'no_host') {
                   14599:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   14600:                                 $inststatus = $userenv{'inststatus'};
                   14601:                                 $inststatus_checked = 1;
                   14602:                             }
                   14603:                         }
                   14604:                     }
                   14605:                 }
                   14606:                 unless ($inststatus_checked) {
                   14607:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   14608:                         my %srch = (srchby     => 'email',
                   14609:                                     srchdomain => $defdom,
                   14610:                                     srchterm   => $reqemail,
                   14611:                                     srchtype   => 'exact');
                   14612:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   14613:                         foreach my $uname (keys(%srch_results)) {
                   14614:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14615:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14616:                                 $inststatus_checked = 1;
                   14617:                                 last;
                   14618:                             }
                   14619:                         }
                   14620:                         unless ($inststatus_checked) {
                   14621:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   14622:                             if ($dirsrchres eq 'ok') {
                   14623:                                 foreach my $uname (keys(%srch_results)) {
                   14624:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   14625:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   14626:                                         $inststatus_checked = 1;
                   14627:                                         last;
                   14628:                                     }
                   14629:                                 }
                   14630:                             }
                   14631:                         }
                   14632:                     }
                   14633:                 }
                   14634:                 if ($inststatus ne '') {
                   14635:                     foreach my $status (split(/\:/,$inststatus)) {
                   14636:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   14637:                             my @contacts = ('adminemail','supportemail');
                   14638:                             foreach my $item (@contacts) {
                   14639:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   14640:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   14641:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14642:                                         push(@recipients,$addr);
                   14643:                                     }
                   14644:                                 }
                   14645:                             }
                   14646:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   14647:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   14648:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   14649:                                 my @ok_bccs;
                   14650:                                 foreach my $bcc (@bccs) {
                   14651:                                     $bcc =~ s/^\s+//g;
                   14652:                                     $bcc =~ s/\s+$//g;
                   14653:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14654:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14655:                                             push(@ok_bccs,$bcc);
                   14656:                                         }
                   14657:                                     }
                   14658:                                 }
                   14659:                                 if (@ok_bccs > 0) {
                   14660:                                     $allbcc = join(', ',@ok_bccs);
                   14661:                                 }
                   14662:                             }
                   14663:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   14664:                             last;
                   14665:                         }
                   14666:                     }
                   14667:                 }
                   14668:             }
                   14669:         }
1.619     raeburn  14670:     } elsif ($origmail ne '') {
1.1075.2.122  raeburn  14671:         $lastresort = $origmail;
                   14672:     }
1.1075.2.128  raeburn  14673:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1075.2.122  raeburn  14674:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   14675:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   14676:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   14677:             my %what = (
                   14678:                           perlvar => 1,
                   14679:                        );
                   14680:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   14681:             if ($primary) {
                   14682:                 my $gotaddr;
                   14683:                 my ($result,$returnhash) =
                   14684:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   14685:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   14686:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   14687:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   14688:                         $gotaddr = 1;
                   14689:                     }
                   14690:                 }
                   14691:                 unless ($gotaddr) {
                   14692:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   14693:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   14694:                     unless ($uintdom eq $intdom) {
                   14695:                         my %domconfig =
                   14696:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   14697:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   14698:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   14699:                                 my @contacts = ('adminemail','supportemail');
                   14700:                                 foreach my $item (@contacts) {
                   14701:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   14702:                                         my $addr = $domconfig{'contacts'}{$item};
                   14703:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14704:                                             push(@recipients,$addr);
                   14705:                                         }
                   14706:                                     }
                   14707:                                 }
                   14708:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   14709:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   14710:                                 }
                   14711:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   14712:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   14713:                                     my @ok_bccs;
                   14714:                                     foreach my $bcc (@bccs) {
                   14715:                                         $bcc =~ s/^\s+//g;
                   14716:                                         $bcc =~ s/\s+$//g;
                   14717:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   14718:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   14719:                                                 push(@ok_bccs,$bcc);
                   14720:                                             }
                   14721:                                         }
                   14722:                                     }
                   14723:                                     if (@ok_bccs > 0) {
                   14724:                                         $allbcc = join(', ',@ok_bccs);
                   14725:                                     }
                   14726:                                 }
                   14727:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   14728:                             }
                   14729:                         }
                   14730:                     }
                   14731:                 }
                   14732:             }
                   14733:         }
1.618     raeburn  14734:     }
1.688     raeburn  14735:     if (defined($defmail)) {
                   14736:         if ($defmail ne '') {
                   14737:             push(@recipients,$defmail);
                   14738:         }
1.618     raeburn  14739:     }
                   14740:     if ($otheremails) {
1.619     raeburn  14741:         my @others;
                   14742:         if ($otheremails =~ /,/) {
                   14743:             @others = split(/,/,$otheremails);
1.618     raeburn  14744:         } else {
1.619     raeburn  14745:             push(@others,$otheremails);
                   14746:         }
                   14747:         foreach my $addr (@others) {
                   14748:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   14749:                 push(@recipients,$addr);
                   14750:             }
1.618     raeburn  14751:         }
                   14752:     }
1.1075.2.128  raeburn  14753:     if ($mailing eq 'helpdeskmail') {
1.1075.2.122  raeburn  14754:         if ((!@recipients) && ($lastresort ne '')) {
                   14755:             push(@recipients,$lastresort);
                   14756:         }
                   14757:     } elsif ($lastresort ne '') {
                   14758:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   14759:             push(@recipients,$lastresort);
                   14760:         }
                   14761:     }
                   14762:     my $recipientlist = join(',',@recipients);
                   14763:     if (wantarray) {
                   14764:         return ($recipientlist,$allbcc,$addtext);
                   14765:     } else {
                   14766:         return $recipientlist;
                   14767:     }
1.618     raeburn  14768: }
                   14769: 
1.127     matthew  14770: ############################################################
                   14771: ############################################################
1.154     albertel 14772: 
1.655     raeburn  14773: =pod
                   14774: 
                   14775: =head1 Course Catalog Routines
                   14776: 
                   14777: =over 4
                   14778: 
                   14779: =item * &gather_categories()
                   14780: 
                   14781: Converts category definitions - keys of categories hash stored in  
                   14782: coursecategories in configuration.db on the primary library server in a 
                   14783: domain - to an array.  Also generates javascript and idx hash used to 
                   14784: generate Domain Coordinator interface for editing Course Categories.
                   14785: 
                   14786: Inputs:
1.663     raeburn  14787: 
1.655     raeburn  14788: categories (reference to hash of category definitions).
1.663     raeburn  14789: 
1.655     raeburn  14790: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14791:       categories and subcategories).
1.663     raeburn  14792: 
1.655     raeburn  14793: idx (reference to hash of counters used in Domain Coordinator interface for 
                   14794:       editing Course Categories).
1.663     raeburn  14795: 
1.655     raeburn  14796: jsarray (reference to array of categories used to create Javascript arrays for
                   14797:          Domain Coordinator interface for editing Course Categories).
                   14798: 
                   14799: Returns: nothing
                   14800: 
                   14801: Side effects: populates cats, idx and jsarray. 
                   14802: 
                   14803: =cut
                   14804: 
                   14805: sub gather_categories {
                   14806:     my ($categories,$cats,$idx,$jsarray) = @_;
                   14807:     my %counters;
                   14808:     my $num = 0;
                   14809:     foreach my $item (keys(%{$categories})) {
                   14810:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   14811:         if ($container eq '' && $depth == 0) {
                   14812:             $cats->[$depth][$categories->{$item}] = $cat;
                   14813:         } else {
                   14814:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   14815:         }
                   14816:         my ($escitem,$tail) = split(/:/,$item,2);
                   14817:         if ($counters{$tail} eq '') {
                   14818:             $counters{$tail} = $num;
                   14819:             $num ++;
                   14820:         }
                   14821:         if (ref($idx) eq 'HASH') {
                   14822:             $idx->{$item} = $counters{$tail};
                   14823:         }
                   14824:         if (ref($jsarray) eq 'ARRAY') {
                   14825:             push(@{$jsarray->[$counters{$tail}]},$item);
                   14826:         }
                   14827:     }
                   14828:     return;
                   14829: }
                   14830: 
                   14831: =pod
                   14832: 
                   14833: =item * &extract_categories()
                   14834: 
                   14835: Used to generate breadcrumb trails for course categories.
                   14836: 
                   14837: Inputs:
1.663     raeburn  14838: 
1.655     raeburn  14839: categories (reference to hash of category definitions).
1.663     raeburn  14840: 
1.655     raeburn  14841: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14842:       categories and subcategories).
1.663     raeburn  14843: 
1.655     raeburn  14844: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  14845: 
1.655     raeburn  14846: allitems (reference to hash - key is category key 
                   14847:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14848: 
1.655     raeburn  14849: idx (reference to hash of counters used in Domain Coordinator interface for
                   14850:       editing Course Categories).
1.663     raeburn  14851: 
1.655     raeburn  14852: jsarray (reference to array of categories used to create Javascript arrays for
                   14853:          Domain Coordinator interface for editing Course Categories).
                   14854: 
1.665     raeburn  14855: subcats (reference to hash of arrays containing all subcategories within each 
                   14856:          category, -recursive)
                   14857: 
1.1075.2.132  raeburn  14858: maxd (reference to hash used to hold max depth for all top-level categories).
                   14859: 
1.655     raeburn  14860: Returns: nothing
                   14861: 
                   14862: Side effects: populates trails and allitems hash references.
                   14863: 
                   14864: =cut
                   14865: 
                   14866: sub extract_categories {
1.1075.2.132  raeburn  14867:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  14868:     if (ref($categories) eq 'HASH') {
                   14869:         &gather_categories($categories,$cats,$idx,$jsarray);
                   14870:         if (ref($cats->[0]) eq 'ARRAY') {
                   14871:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   14872:                 my $name = $cats->[0][$i];
                   14873:                 my $item = &escape($name).'::0';
                   14874:                 my $trailstr;
                   14875:                 if ($name eq 'instcode') {
                   14876:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  14877:                 } elsif ($name eq 'communities') {
                   14878:                     $trailstr = &mt('Communities');
1.655     raeburn  14879:                 } else {
                   14880:                     $trailstr = $name;
                   14881:                 }
                   14882:                 if ($allitems->{$item} eq '') {
                   14883:                     push(@{$trails},$trailstr);
                   14884:                     $allitems->{$item} = scalar(@{$trails})-1;
                   14885:                 }
                   14886:                 my @parents = ($name);
                   14887:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   14888:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   14889:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  14890:                         if (ref($subcats) eq 'HASH') {
                   14891:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   14892:                         }
1.1075.2.132  raeburn  14893:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  14894:                     }
                   14895:                 } else {
                   14896:                     if (ref($subcats) eq 'HASH') {
                   14897:                         $subcats->{$item} = [];
1.655     raeburn  14898:                     }
1.1075.2.132  raeburn  14899:                     if (ref($maxd) eq 'HASH') {
                   14900:                         $maxd->{$name} = 1;
                   14901:                     }
1.655     raeburn  14902:                 }
                   14903:             }
                   14904:         }
                   14905:     }
                   14906:     return;
                   14907: }
                   14908: 
                   14909: =pod
                   14910: 
1.1075.2.56  raeburn  14911: =item * &recurse_categories()
1.655     raeburn  14912: 
                   14913: Recursively used to generate breadcrumb trails for course categories.
                   14914: 
                   14915: Inputs:
1.663     raeburn  14916: 
1.655     raeburn  14917: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   14918:       categories and subcategories).
1.663     raeburn  14919: 
1.655     raeburn  14920: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  14921: 
                   14922: category (current course category, for which breadcrumb trail is being generated).
                   14923: 
                   14924: trails (reference to array of breadcrumb trails for each category).
                   14925: 
1.655     raeburn  14926: allitems (reference to hash - key is category key
                   14927:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  14928: 
1.655     raeburn  14929: parents (array containing containers directories for current category, 
                   14930:          back to top level). 
                   14931: 
                   14932: Returns: nothing
                   14933: 
                   14934: Side effects: populates trails and allitems hash references
                   14935: 
                   14936: =cut
                   14937: 
                   14938: sub recurse_categories {
1.1075.2.132  raeburn  14939:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  14940:     my $shallower = $depth - 1;
                   14941:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   14942:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   14943:             my $name = $cats->[$depth]{$category}[$k];
                   14944:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.164  raeburn  14945:             my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  14946:             if ($allitems->{$item} eq '') {
                   14947:                 push(@{$trails},$trailstr);
                   14948:                 $allitems->{$item} = scalar(@{$trails})-1;
                   14949:             }
                   14950:             my $deeper = $depth+1;
                   14951:             push(@{$parents},$category);
1.665     raeburn  14952:             if (ref($subcats) eq 'HASH') {
                   14953:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   14954:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   14955:                     my $higher;
                   14956:                     if ($j > 0) {
                   14957:                         $higher = &escape($parents->[$j]).':'.
                   14958:                                   &escape($parents->[$j-1]).':'.$j;
                   14959:                     } else {
                   14960:                         $higher = &escape($parents->[$j]).'::'.$j;
                   14961:                     }
                   14962:                     push(@{$subcats->{$higher}},$subcat);
                   14963:                 }
                   14964:             }
                   14965:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1075.2.132  raeburn  14966:                                 $subcats,$maxd);
1.655     raeburn  14967:             pop(@{$parents});
                   14968:         }
                   14969:     } else {
                   14970:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1075.2.132  raeburn  14971:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  14972:         if ($allitems->{$item} eq '') {
                   14973:             push(@{$trails},$trailstr);
                   14974:             $allitems->{$item} = scalar(@{$trails})-1;
                   14975:         }
1.1075.2.132  raeburn  14976:         if (ref($maxd) eq 'HASH') {
                   14977:             if ($depth > $maxd->{$parents->[0]}) {
                   14978:                 $maxd->{$parents->[0]} = $depth;
                   14979:             }
                   14980:         }
1.655     raeburn  14981:     }
                   14982:     return;
                   14983: }
                   14984: 
1.663     raeburn  14985: =pod
                   14986: 
1.1075.2.56  raeburn  14987: =item * &assign_categories_table()
1.663     raeburn  14988: 
                   14989: Create a datatable for display of hierarchical categories in a domain,
                   14990: with checkboxes to allow a course to be categorized. 
                   14991: 
                   14992: Inputs:
                   14993: 
                   14994: cathash - reference to hash of categories defined for the domain (from
                   14995:           configuration.db)
                   14996: 
                   14997: currcat - scalar with an & separated list of categories assigned to a course. 
                   14998: 
1.919     raeburn  14999: type    - scalar contains course type (Course or Community).
                   15000: 
1.1075.2.117  raeburn  15001: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15002:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15003: 
1.663     raeburn  15004: Returns: $output (markup to be displayed) 
                   15005: 
                   15006: =cut
                   15007: 
                   15008: sub assign_categories_table {
1.1075.2.117  raeburn  15009:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  15010:     my $output;
                   15011:     if (ref($cathash) eq 'HASH') {
1.1075.2.132  raeburn  15012:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   15013:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  15014:         $maxdepth = scalar(@cats);
                   15015:         if (@cats > 0) {
                   15016:             my $itemcount = 0;
                   15017:             if (ref($cats[0]) eq 'ARRAY') {
                   15018:                 my @currcategories;
                   15019:                 if ($currcat ne '') {
                   15020:                     @currcategories = split('&',$currcat);
                   15021:                 }
1.919     raeburn  15022:                 my $table;
1.663     raeburn  15023:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   15024:                     my $parent = $cats[0][$i];
1.919     raeburn  15025:                     next if ($parent eq 'instcode');
                   15026:                     if ($type eq 'Community') {
                   15027:                         next unless ($parent eq 'communities');
                   15028:                     } else {
                   15029:                         next if ($parent eq 'communities');
                   15030:                     }
1.663     raeburn  15031:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   15032:                     my $item = &escape($parent).'::0';
                   15033:                     my $checked = '';
                   15034:                     if (@currcategories > 0) {
                   15035:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   15036:                             $checked = ' checked="checked"';
1.663     raeburn  15037:                         }
                   15038:                     }
1.919     raeburn  15039:                     my $parent_title = $parent;
                   15040:                     if ($parent eq 'communities') {
                   15041:                         $parent_title = &mt('Communities');
                   15042:                     }
                   15043:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   15044:                               '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15045:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  15046:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  15047:                     my $depth = 1;
                   15048:                     push(@path,$parent);
1.1075.2.117  raeburn  15049:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  15050:                     pop(@path);
1.919     raeburn  15051:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  15052:                     $itemcount ++;
                   15053:                 }
1.919     raeburn  15054:                 if ($itemcount) {
                   15055:                     $output = &Apache::loncommon::start_data_table().
                   15056:                               $table.
                   15057:                               &Apache::loncommon::end_data_table();
                   15058:                 }
1.663     raeburn  15059:             }
                   15060:         }
                   15061:     }
                   15062:     return $output;
                   15063: }
                   15064: 
                   15065: =pod
                   15066: 
1.1075.2.56  raeburn  15067: =item * &assign_category_rows()
1.663     raeburn  15068: 
                   15069: Create a datatable row for display of nested categories in a domain,
                   15070: with checkboxes to allow a course to be categorized,called recursively.
                   15071: 
                   15072: Inputs:
                   15073: 
                   15074: itemcount - track row number for alternating colors
                   15075: 
                   15076: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   15077:       categories and subcategories.
                   15078: 
                   15079: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   15080: 
                   15081: parent - parent of current category item
                   15082: 
                   15083: path - Array containing all categories back up through the hierarchy from the
                   15084:        current category to the top level.
                   15085: 
                   15086: currcategories - reference to array of current categories assigned to the course
                   15087: 
1.1075.2.117  raeburn  15088: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   15089:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   15090: 
1.663     raeburn  15091: Returns: $output (markup to be displayed).
                   15092: 
                   15093: =cut
                   15094: 
                   15095: sub assign_category_rows {
1.1075.2.117  raeburn  15096:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  15097:     my ($text,$name,$item,$chgstr);
                   15098:     if (ref($cats) eq 'ARRAY') {
                   15099:         my $maxdepth = scalar(@{$cats});
                   15100:         if (ref($cats->[$depth]) eq 'HASH') {
                   15101:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   15102:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   15103:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1075.2.45  raeburn  15104:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  15105:                 for (my $j=0; $j<$numchildren; $j++) {
                   15106:                     $name = $cats->[$depth]{$parent}[$j];
                   15107:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   15108:                     my $deeper = $depth+1;
                   15109:                     my $checked = '';
                   15110:                     if (ref($currcategories) eq 'ARRAY') {
                   15111:                         if (@{$currcategories} > 0) {
                   15112:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   15113:                                 $checked = ' checked="checked"';
1.663     raeburn  15114:                             }
                   15115:                         }
                   15116:                     }
1.664     raeburn  15117:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   15118:                              '<input type="checkbox" name="usecategory" value="'.
1.1075.2.117  raeburn  15119:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  15120:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   15121:                              '</td><td>';
1.663     raeburn  15122:                     if (ref($path) eq 'ARRAY') {
                   15123:                         push(@{$path},$name);
1.1075.2.117  raeburn  15124:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  15125:                         pop(@{$path});
                   15126:                     }
                   15127:                     $text .= '</td></tr>';
                   15128:                 }
                   15129:                 $text .= '</table></td>';
                   15130:             }
                   15131:         }
                   15132:     }
                   15133:     return $text;
                   15134: }
                   15135: 
1.1075.2.69  raeburn  15136: =pod
                   15137: 
                   15138: =back
                   15139: 
                   15140: =cut
                   15141: 
1.655     raeburn  15142: ############################################################
                   15143: ############################################################
                   15144: 
                   15145: 
1.443     albertel 15146: sub commit_customrole {
1.664     raeburn  15147:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  15148:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 15149:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   15150:                          ($end?', ending '.localtime($end):'').': <b>'.
                   15151:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  15152:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 15153:                  '</b><br />';
                   15154:     return $output;
                   15155: }
                   15156: 
                   15157: sub commit_standardrole {
1.1075.2.31  raeburn  15158:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits) = @_;
1.541     raeburn  15159:     my ($output,$logmsg,$linefeed);
                   15160:     if ($context eq 'auto') {
                   15161:         $linefeed = "\n";
                   15162:     } else {
                   15163:         $linefeed = "<br />\n";
                   15164:     }  
1.443     albertel 15165:     if ($three eq 'st') {
1.541     raeburn  15166:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1075.2.31  raeburn  15167:                                          $one,$two,$sec,$context,$credits);
1.541     raeburn  15168:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  15169:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   15170:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 15171:         } else {
1.541     raeburn  15172:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 15173:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15174:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   15175:             if ($context eq 'auto') {
                   15176:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   15177:             } else {
                   15178:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   15179:                &mt('Add to classlist').': <b>ok</b>';
                   15180:             }
                   15181:             $output .= $linefeed;
1.443     albertel 15182:         }
                   15183:     } else {
                   15184:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   15185:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  15186:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  15187:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  15188:         if ($context eq 'auto') {
                   15189:             $output .= $result.$linefeed;
                   15190:         } else {
                   15191:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   15192:         }
1.443     albertel 15193:     }
                   15194:     return $output;
                   15195: }
                   15196: 
                   15197: sub commit_studentrole {
1.1075.2.31  raeburn  15198:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
                   15199:         $credits) = @_;
1.626     raeburn  15200:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  15201:     if ($context eq 'auto') {
                   15202:         $linefeed = "\n";
                   15203:     } else {
                   15204:         $linefeed = '<br />'."\n";
                   15205:     }
1.443     albertel 15206:     if (defined($one) && defined($two)) {
                   15207:         my $cid=$one.'_'.$two;
                   15208:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   15209:         my $secchange = 0;
                   15210:         my $expire_role_result;
                   15211:         my $modify_section_result;
1.628     raeburn  15212:         if ($oldsec ne '-1') { 
                   15213:             if ($oldsec ne $sec) {
1.443     albertel 15214:                 $secchange = 1;
1.628     raeburn  15215:                 my $now = time;
1.443     albertel 15216:                 my $uurl='/'.$cid;
                   15217:                 $uurl=~s/\_/\//g;
                   15218:                 if ($oldsec) {
                   15219:                     $uurl.='/'.$oldsec;
                   15220:                 }
1.626     raeburn  15221:                 $oldsecurl = $uurl;
1.628     raeburn  15222:                 $expire_role_result = 
1.1075.2.167! raeburn  15223:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
        !          15224:                                                 '','','',$context);
1.628     raeburn  15225:                 if ($env{'request.course.sec'} ne '') { 
                   15226:                     if ($expire_role_result eq 'refused') {
                   15227:                         my @roles = ('st');
                   15228:                         my @statuses = ('previous');
                   15229:                         my @roledoms = ($one);
                   15230:                         my $withsec = 1;
                   15231:                         my %roleshash = 
                   15232:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   15233:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   15234:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   15235:                             my ($oldstart,$oldend) = 
                   15236:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   15237:                             if ($oldend > 0 && $oldend <= $now) {
                   15238:                                 $expire_role_result = 'ok';
                   15239:                             }
                   15240:                         }
                   15241:                     }
                   15242:                 }
1.443     albertel 15243:                 $result = $expire_role_result;
                   15244:             }
                   15245:         }
                   15246:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1075.2.31  raeburn  15247:             $modify_section_result = 
                   15248:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   15249:                                                            undef,undef,undef,$sec,
                   15250:                                                            $end,$start,'','',$cid,
                   15251:                                                            '',$context,$credits);
1.443     albertel 15252:             if ($modify_section_result =~ /^ok/) {
                   15253:                 if ($secchange == 1) {
1.628     raeburn  15254:                     if ($sec eq '') {
                   15255:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   15256:                     } else {
                   15257:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   15258:                     }
1.443     albertel 15259:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  15260:                     if ($sec eq '') {
                   15261:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   15262:                     } else {
                   15263:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15264:                     }
1.443     albertel 15265:                 } else {
1.628     raeburn  15266:                     if ($sec eq '') {
                   15267:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   15268:                     } else {
                   15269:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   15270:                     }
1.443     albertel 15271:                 }
                   15272:             } else {
1.628     raeburn  15273:                 if ($secchange) {       
                   15274:                     $$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;
                   15275:                 } else {
                   15276:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   15277:                 }
1.443     albertel 15278:             }
                   15279:             $result = $modify_section_result;
                   15280:         } elsif ($secchange == 1) {
1.628     raeburn  15281:             if ($oldsec eq '') {
1.1075.2.20  raeburn  15282:                 $$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  15283:             } else {
                   15284:                 $$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;
                   15285:             }
1.626     raeburn  15286:             if ($expire_role_result eq 'refused') {
                   15287:                 my $newsecurl = '/'.$cid;
                   15288:                 $newsecurl =~ s/\_/\//g;
                   15289:                 if ($sec ne '') {
                   15290:                     $newsecurl.='/'.$sec;
                   15291:                 }
                   15292:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   15293:                     if ($sec eq '') {
                   15294:                         $$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;
                   15295:                     } else {
                   15296:                         $$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;
                   15297:                     }
                   15298:                 }
                   15299:             }
1.443     albertel 15300:         }
                   15301:     } else {
1.626     raeburn  15302:         $$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 15303:         $result = "error: incomplete course id\n";
                   15304:     }
                   15305:     return $result;
                   15306: }
                   15307: 
1.1075.2.25  raeburn  15308: sub show_role_extent {
                   15309:     my ($scope,$context,$role) = @_;
                   15310:     $scope =~ s{^/}{};
                   15311:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   15312:     push(@courseroles,'co');
                   15313:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   15314:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   15315:         $scope =~ s{/}{_};
                   15316:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   15317:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   15318:         my ($audom,$auname) = split(/\//,$scope);
                   15319:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   15320:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   15321:     } else {
                   15322:         $scope =~ s{/$}{};
                   15323:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   15324:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   15325:     }
                   15326: }
                   15327: 
1.443     albertel 15328: ############################################################
                   15329: ############################################################
                   15330: 
1.566     albertel 15331: sub check_clone {
1.578     raeburn  15332:     my ($args,$linefeed) = @_;
1.566     albertel 15333:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   15334:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   15335:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   15336:     my $clonemsg;
                   15337:     my $can_clone = 0;
1.944     raeburn  15338:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  15339:     if ($lctype ne 'community') {
                   15340:         $lctype = 'course';
                   15341:     }
1.566     albertel 15342:     if ($clonehome eq 'no_host') {
1.944     raeburn  15343:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15344:             $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'});
                   15345:         } else {
                   15346:             $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'});
                   15347:         }     
1.566     albertel 15348:     } else {
                   15349: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.944     raeburn  15350:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  15351:             if ($clonedesc{'type'} ne 'Community') {
                   15352:                  $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'});
                   15353:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15354:             }
                   15355:         }
1.1075.2.119  raeburn  15356: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  15357:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 15358: 	    $can_clone = 1;
                   15359: 	} else {
1.1075.2.95  raeburn  15360: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 15361: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1075.2.95  raeburn  15362:             if ($clonehash{'cloners'} eq '') {
                   15363:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   15364:                 if ($domdefs{'canclone'}) {
                   15365:                     unless ($domdefs{'canclone'} eq 'none') {
                   15366:                         if ($domdefs{'canclone'} eq 'domain') {
                   15367:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   15368:                                 $can_clone = 1;
                   15369:                             }
                   15370:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15371:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   15372:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   15373:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   15374:                                 $can_clone = 1;
                   15375:                             }
                   15376:                         }
                   15377:                     }
1.908     raeburn  15378:                 }
1.1075.2.95  raeburn  15379:             } else {
                   15380: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   15381:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  15382:                     $can_clone = 1;
1.1075.2.95  raeburn  15383:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  15384:                     $can_clone = 1;
1.1075.2.96  raeburn  15385:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   15386:                     $can_clone = 1;
1.1075.2.95  raeburn  15387:                 }
                   15388:                 unless ($can_clone) {
1.1075.2.96  raeburn  15389:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) &&
                   15390:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1075.2.95  raeburn  15391:                         my (%gotdomdefaults,%gotcodedefaults);
                   15392:                         foreach my $cloner (@cloners) {
                   15393:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   15394:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   15395:                                 my (%codedefaults,@code_order);
                   15396:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   15397:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   15398:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   15399:                                     }
                   15400:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   15401:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   15402:                                     }
                   15403:                                 } else {
                   15404:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   15405:                                                                             \%codedefaults,
                   15406:                                                                             \@code_order);
                   15407:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   15408:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   15409:                                 }
                   15410:                                 if (@code_order > 0) {
                   15411:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   15412:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   15413:                                                                                 $args->{'crscode'})) {
                   15414:                                         $can_clone = 1;
                   15415:                                         last;
                   15416:                                     }
                   15417:                                 }
                   15418:                             }
                   15419:                         }
                   15420:                     }
1.1075.2.96  raeburn  15421:                 }
                   15422:             }
                   15423:             unless ($can_clone) {
                   15424:                 my $ccrole = 'cc';
                   15425:                 if ($args->{'crstype'} eq 'Community') {
                   15426:                     $ccrole = 'co';
                   15427:                 }
                   15428:                 my %roleshash =
                   15429:                     &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   15430:                                                   $args->{'ccdomain'},
                   15431:                                                   'userroles',['active'],[$ccrole],
                   15432:                                                   [$args->{'clonedomain'}]);
                   15433:                 if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   15434:                     $can_clone = 1;
                   15435:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   15436:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   15437:                     $can_clone = 1;
1.1075.2.95  raeburn  15438:                 }
                   15439:             }
                   15440:             unless ($can_clone) {
                   15441:                 if ($args->{'crstype'} eq 'Community') {
                   15442:                     $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'});
                   15443:                 } else {
                   15444:                     $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  15445: 	        }
1.566     albertel 15446: 	    }
1.578     raeburn  15447:         }
1.566     albertel 15448:     }
                   15449:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15450: }
                   15451: 
1.444     albertel 15452: sub construct_course {
1.1075.2.119  raeburn  15453:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
                   15454:         $cnum,$category,$coderef) = @_;
1.444     albertel 15455:     my $outcome;
1.541     raeburn  15456:     my $linefeed =  '<br />'."\n";
                   15457:     if ($context eq 'auto') {
                   15458:         $linefeed = "\n";
                   15459:     }
1.566     albertel 15460: 
                   15461: #
                   15462: # Are we cloning?
                   15463: #
                   15464:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   15465:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  15466: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 15467: 	if ($context ne 'auto') {
1.578     raeburn  15468:             if ($clonemsg ne '') {
                   15469: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   15470:             }
1.566     albertel 15471: 	}
                   15472: 	$outcome .= $clonemsg.$linefeed;
                   15473: 
                   15474:         if (!$can_clone) {
                   15475: 	    return (0,$outcome);
                   15476: 	}
                   15477:     }
                   15478: 
1.444     albertel 15479: #
                   15480: # Open course
                   15481: #
                   15482:     my $crstype = lc($args->{'crstype'});
                   15483:     my %cenv=();
                   15484:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   15485:                                              $args->{'cdescr'},
                   15486:                                              $args->{'curl'},
                   15487:                                              $args->{'course_home'},
                   15488:                                              $args->{'nonstandard'},
                   15489:                                              $args->{'crscode'},
                   15490:                                              $args->{'ccuname'}.':'.
                   15491:                                              $args->{'ccdomain'},
1.882     raeburn  15492:                                              $args->{'crstype'},
1.885     raeburn  15493:                                              $cnum,$context,$category);
1.444     albertel 15494: 
                   15495:     # Note: The testing routines depend on this being output; see 
                   15496:     # Utils::Course. This needs to at least be output as a comment
                   15497:     # if anyone ever decides to not show this, and Utils::Course::new
                   15498:     # will need to be suitably modified.
1.541     raeburn  15499:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.943     raeburn  15500:     if ($$courseid =~ /^error:/) {
                   15501:         return (0,$outcome);
                   15502:     }
                   15503: 
1.444     albertel 15504: #
                   15505: # Check if created correctly
                   15506: #
1.479     albertel 15507:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 15508:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  15509:     if ($crsuhome eq 'no_host') {
                   15510:         $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed;
                   15511:         return (0,$outcome);
                   15512:     }
1.541     raeburn  15513:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 15514: 
1.444     albertel 15515: #
1.566     albertel 15516: # Do the cloning
                   15517: #   
                   15518:     if ($can_clone && $cloneid) {
                   15519: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   15520: 	if ($context ne 'auto') {
                   15521: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   15522: 	}
                   15523: 	$outcome .= $clonemsg.$linefeed;
                   15524: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 15525: # Copy all files
1.637     www      15526: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 15527: # Restore URL
1.566     albertel 15528: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 15529: # Restore title
1.566     albertel 15530: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  15531: # Restore creation date, creator and creation context.
                   15532:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   15533:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   15534:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 15535: # Mark as cloned
1.566     albertel 15536: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      15537: # Need to clone grading mode
                   15538:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   15539:         $cenv{'grading'}=$newenv{'grading'};
                   15540: # Do not clone these environment entries
                   15541:         &Apache::lonnet::del('environment',
                   15542:                   ['default_enrollment_start_date',
                   15543:                    'default_enrollment_end_date',
                   15544:                    'question.email',
                   15545:                    'policy.email',
                   15546:                    'comment.email',
                   15547:                    'pch.users.denied',
1.725     raeburn  15548:                    'plc.users.denied',
                   15549:                    'hidefromcat',
1.1075.2.36  raeburn  15550:                    'checkforpriv',
1.1075.2.158  raeburn  15551:                    'categories'],
1.638     www      15552:                    $$crsudom,$$crsunum);
1.1075.2.63  raeburn  15553:         if ($args->{'textbook'}) {
                   15554:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   15555:         }
1.444     albertel 15556:     }
1.566     albertel 15557: 
1.444     albertel 15558: #
                   15559: # Set environment (will override cloned, if existing)
                   15560: #
                   15561:     my @sections = ();
                   15562:     my @xlists = ();
                   15563:     if ($args->{'crstype'}) {
                   15564:         $cenv{'type'}=$args->{'crstype'};
                   15565:     }
                   15566:     if ($args->{'crsid'}) {
                   15567:         $cenv{'courseid'}=$args->{'crsid'};
                   15568:     }
                   15569:     if ($args->{'crscode'}) {
                   15570:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   15571:     }
                   15572:     if ($args->{'crsquota'} ne '') {
                   15573:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   15574:     } else {
                   15575:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   15576:     }
                   15577:     if ($args->{'ccuname'}) {
                   15578:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   15579:                                         ':'.$args->{'ccdomain'};
                   15580:     } else {
                   15581:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   15582:     }
1.1075.2.31  raeburn  15583:     if ($args->{'defaultcredits'}) {
                   15584:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   15585:     }
1.444     albertel 15586:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1075.2.166  raeburn  15587:     my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444     albertel 15588:     if ($args->{'crssections'}) {
                   15589:         $cenv{'internal.sectionnums'} = '';
                   15590:         if ($args->{'crssections'} =~ m/,/) {
                   15591:             @sections = split/,/,$args->{'crssections'};
                   15592:         } else {
                   15593:             $sections[0] = $args->{'crssections'};
                   15594:         }
                   15595:         if (@sections > 0) {
                   15596:             foreach my $item (@sections) {
                   15597:                 my ($sec,$gp) = split/:/,$item;
                   15598:                 my $class = $args->{'crscode'}.$sec;
                   15599:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   15600:                 $cenv{'internal.sectionnums'} .= $item.',';
1.1075.2.166  raeburn  15601:                 if ($addcheck eq 'ok') {
                   15602:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   15603:                         push(@oklcsecs,$gp);
                   15604:                     }
                   15605:                 } else {
1.1075.2.119  raeburn  15606:                     push(@badclasses,$class);
1.444     albertel 15607:                 }
                   15608:             }
                   15609:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   15610:         }
                   15611:     }
                   15612: # do not hide course coordinator from staff listing, 
                   15613: # even if privileged
                   15614:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1075.2.36  raeburn  15615: # add course coordinator's domain to domains to check for privileged users
                   15616: # if different to course domain
                   15617:     if ($$crsudom ne $args->{'ccdomain'}) {
                   15618:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   15619:     }
1.444     albertel 15620: # add crosslistings
                   15621:     if ($args->{'crsxlist'}) {
                   15622:         $cenv{'internal.crosslistings'}='';
                   15623:         if ($args->{'crsxlist'} =~ m/,/) {
                   15624:             @xlists = split/,/,$args->{'crsxlist'};
                   15625:         } else {
                   15626:             $xlists[0] = $args->{'crsxlist'};
                   15627:         }
                   15628:         if (@xlists > 0) {
                   15629:             foreach my $item (@xlists) {
                   15630:                 my ($xl,$gp) = split/:/,$item;
                   15631:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   15632:                 $cenv{'internal.crosslistings'} .= $item.',';
1.1075.2.166  raeburn  15633:                 if ($addcheck eq 'ok') {
                   15634:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   15635:                         push(@oklcsecs,$gp);
                   15636:                     }
                   15637:                 } else {
1.1075.2.119  raeburn  15638:                     push(@badclasses,$xl);
1.444     albertel 15639:                 }
                   15640:             }
                   15641:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   15642:         }
                   15643:     }
                   15644:     if ($args->{'autoadds'}) {
                   15645:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   15646:     }
                   15647:     if ($args->{'autodrops'}) {
                   15648:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   15649:     }
                   15650: # check for notification of enrollment changes
                   15651:     my @notified = ();
                   15652:     if ($args->{'notify_owner'}) {
                   15653:         if ($args->{'ccuname'} ne '') {
                   15654:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   15655:         }
                   15656:     }
                   15657:     if ($args->{'notify_dc'}) {
                   15658:         if ($uname ne '') { 
1.630     raeburn  15659:             push(@notified,$uname.':'.$udom);
1.444     albertel 15660:         }
                   15661:     }
                   15662:     if (@notified > 0) {
                   15663:         my $notifylist;
                   15664:         if (@notified > 1) {
                   15665:             $notifylist = join(',',@notified);
                   15666:         } else {
                   15667:             $notifylist = $notified[0];
                   15668:         }
                   15669:         $cenv{'internal.notifylist'} = $notifylist;
                   15670:     }
                   15671:     if (@badclasses > 0) {
                   15672:         my %lt=&Apache::lonlocal::texthash(
1.1075.2.119  raeburn  15673:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   15674:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   15675:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 15676:         );
1.1075.2.119  raeburn  15677:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   15678:                            &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  15679:         if ($context eq 'auto') {
                   15680:             $outcome .= $badclass_msg.$linefeed;
1.1075.2.119  raeburn  15681:         } else {
1.566     albertel 15682:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1075.2.119  raeburn  15683:         }
                   15684:         foreach my $item (@badclasses) {
1.541     raeburn  15685:             if ($context eq 'auto') {
1.1075.2.119  raeburn  15686:                 $outcome .= " - $item\n";
1.541     raeburn  15687:             } else {
1.1075.2.119  raeburn  15688:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  15689:             }
1.1075.2.119  raeburn  15690:         }
                   15691:         if ($context eq 'auto') {
                   15692:             $outcome .= $linefeed;
                   15693:         } else {
                   15694:             $outcome .= "</ul><br /><br /></div>\n";
                   15695:         }
1.444     albertel 15696:     }
                   15697:     if ($args->{'no_end_date'}) {
                   15698:         $args->{'endaccess'} = 0;
                   15699:     }
1.1075.2.166  raeburn  15700: #  If an official course with institutional sections is created by cloning
                   15701: #  an existing course, section-specific hiding of course totals in student's
                   15702: #  view of grades as copied from cloned course, will be checked for valid
                   15703: #  sections.
                   15704:     if (($can_clone && $cloneid) &&
                   15705:         ($cenv{'internal.coursecode'} ne '') &&
                   15706:         ($cenv{'grading'} eq 'standard') &&
                   15707:         ($cenv{'hidetotals'} ne '') &&
                   15708:         ($cenv{'hidetotals'} ne 'all')) {
                   15709:         my @hidesecs;
                   15710:         my $deletehidetotals;
                   15711:         if (@oklcsecs) {
                   15712:             foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
                   15713:                 if (grep(/^\Q$sec$/,@oklcsecs)) {
                   15714:                     push(@hidesecs,$sec);
                   15715:                 }
                   15716:             }
                   15717:             if (@hidesecs) {
                   15718:                 $cenv{'hidetotals'} = join(',',@hidesecs);
                   15719:             } else {
                   15720:                 $deletehidetotals = 1;
                   15721:             }
                   15722:         } else {
                   15723:             $deletehidetotals = 1;
                   15724:         }
                   15725:         if ($deletehidetotals) {
                   15726:             delete($cenv{'hidetotals'});
                   15727:             &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
                   15728:         }
                   15729:     }
1.444     albertel 15730:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   15731:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   15732:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   15733:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   15734:     if ($args->{'showphotos'}) {
                   15735:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   15736:     }
                   15737:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   15738:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   15739:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   15740:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  15741:             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'); 
                   15742:             if ($context eq 'auto') {
                   15743:                 $outcome .= $krb_msg;
                   15744:             } else {
1.566     albertel 15745:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  15746:             }
                   15747:             $outcome .= $linefeed;
1.444     albertel 15748:         }
                   15749:     }
                   15750:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   15751:        if ($args->{'setpolicy'}) {
                   15752:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15753:        }
                   15754:        if ($args->{'setcontent'}) {
                   15755:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15756:        }
1.1075.2.110  raeburn  15757:        if ($args->{'setcomment'}) {
                   15758:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   15759:        }
1.444     albertel 15760:     }
                   15761:     if ($args->{'reshome'}) {
                   15762: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   15763: 	$cenv{'reshome'}=~s/\/+$/\//;
                   15764:     }
                   15765: #
                   15766: # course has keyed access
                   15767: #
                   15768:     if ($args->{'setkeys'}) {
                   15769:        $cenv{'keyaccess'}='yes';
                   15770:     }
                   15771: # if specified, key authority is not course, but user
                   15772: # only active if keyaccess is yes
                   15773:     if ($args->{'keyauth'}) {
1.487     albertel 15774: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   15775: 	$user = &LONCAPA::clean_username($user);
                   15776: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     15777: 	if ($user ne '' && $domain ne '') {
1.487     albertel 15778: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 15779: 	}
                   15780:     }
                   15781: 
1.1075.2.59  raeburn  15782: #
                   15783: #  generate and store uniquecode (available to course requester), if course should have one.
                   15784: #
                   15785:     if ($args->{'uniquecode'}) {
                   15786:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   15787:         if ($code) {
                   15788:             $cenv{'internal.uniquecode'} = $code;
                   15789:             my %crsinfo =
                   15790:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   15791:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   15792:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   15793:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   15794:             }
                   15795:             if (ref($coderef)) {
                   15796:                 $$coderef = $code;
                   15797:             }
                   15798:         }
                   15799:     }
                   15800: 
1.444     albertel 15801:     if ($args->{'disresdis'}) {
                   15802:         $cenv{'pch.roles.denied'}='st';
                   15803:     }
                   15804:     if ($args->{'disablechat'}) {
                   15805:         $cenv{'plc.roles.denied'}='st';
                   15806:     }
                   15807: 
                   15808:     # Record we've not yet viewed the Course Initialization Helper for this 
                   15809:     # course
                   15810:     $cenv{'course.helper.not.run'} = 1;
                   15811:     #
                   15812:     # Use new Randomseed
                   15813:     #
                   15814:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   15815:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   15816:     #
                   15817:     # The encryption code and receipt prefix for this course
                   15818:     #
                   15819:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   15820:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   15821:     #
                   15822:     # By default, use standard grading
                   15823:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   15824: 
1.541     raeburn  15825:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   15826:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15827: #
                   15828: # Open all assignments
                   15829: #
                   15830:     if ($args->{'openall'}) {
1.1075.2.146  raeburn  15831:        my $opendate = time;
                   15832:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   15833:            $opendate = $args->{'openallfrom'};
                   15834:        }
1.444     albertel 15835:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1075.2.146  raeburn  15836:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 15837:                            $storeunder.'.type' => 'date_start');
1.1075.2.146  raeburn  15838:        $outcome .= &mt('All assignments open starting [_1]',
                   15839:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   15840:                    &Apache::lonnet::cput
                   15841:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 15842:    }
                   15843: #
                   15844: # Set first page
                   15845: #
                   15846:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   15847: 	    || ($cloneid)) {
1.445     albertel 15848: 	use LONCAPA::map;
1.444     albertel 15849: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 15850: 
                   15851: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   15852:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   15853: 
1.444     albertel 15854:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   15855:         my $title; my $url;
                   15856:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   15857: 	    $title=&mt('Syllabus');
1.444     albertel 15858:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   15859:         } else {
1.963     raeburn  15860:             $title=&mt('Table of Contents');
1.444     albertel 15861:             $url='/adm/navmaps';
                   15862:         }
1.445     albertel 15863: 
                   15864:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   15865: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   15866: 
                   15867: 	if ($errtext) { $fatal=2; }
1.541     raeburn  15868:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 15869:     }
1.566     albertel 15870: 
                   15871:     return (1,$outcome);
1.444     albertel 15872: }
                   15873: 
1.1075.2.59  raeburn  15874: sub make_unique_code {
                   15875:     my ($cdom,$cnum) = @_;
                   15876:     # get lock on uniquecodes db
                   15877:     my $lockhash = {
                   15878:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   15879:                                                   ':'.$env{'user.domain'},
                   15880:                    };
                   15881:     my $tries = 0;
                   15882:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15883:     my ($code,$error);
                   15884: 
                   15885:     while (($gotlock ne 'ok') && ($tries<3)) {
                   15886:         $tries ++;
                   15887:         sleep 1;
                   15888:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   15889:     }
                   15890:     if ($gotlock eq 'ok') {
                   15891:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   15892:         my $gotcode;
                   15893:         my $attempts = 0;
                   15894:         while ((!$gotcode) && ($attempts < 100)) {
                   15895:             $code = &generate_code();
                   15896:             if (!exists($currcodes{$code})) {
                   15897:                 $gotcode = 1;
                   15898:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   15899:                     $error = 'nostore';
                   15900:                 }
                   15901:             }
                   15902:             $attempts ++;
                   15903:         }
                   15904:         my @del_lock = ($cnum."\0".'uniquecodes');
                   15905:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   15906:     } else {
                   15907:         $error = 'nolock';
                   15908:     }
                   15909:     return ($code,$error);
                   15910: }
                   15911: 
                   15912: sub generate_code {
                   15913:     my $code;
                   15914:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   15915:     for (my $i=0; $i<6; $i++) {
                   15916:         my $lettnum = int (rand 2);
                   15917:         my $item = '';
                   15918:         if ($lettnum) {
                   15919:             $item = $letts[int( rand(18) )];
                   15920:         } else {
                   15921:             $item = 1+int( rand(8) );
                   15922:         }
                   15923:         $code .= $item;
                   15924:     }
                   15925:     return $code;
                   15926: }
                   15927: 
1.444     albertel 15928: ############################################################
                   15929: ############################################################
                   15930: 
1.953     droeschl 15931: #SD
                   15932: # only Community and Course, or anything else?
1.378     raeburn  15933: sub course_type {
                   15934:     my ($cid) = @_;
                   15935:     if (!defined($cid)) {
                   15936:         $cid = $env{'request.course.id'};
                   15937:     }
1.404     albertel 15938:     if (defined($env{'course.'.$cid.'.type'})) {
                   15939:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  15940:     } else {
                   15941:         return 'Course';
1.377     raeburn  15942:     }
                   15943: }
1.156     albertel 15944: 
1.406     raeburn  15945: sub group_term {
                   15946:     my $crstype = &course_type();
                   15947:     my %names = (
                   15948:                   'Course' => 'group',
1.865     raeburn  15949:                   'Community' => 'group',
1.406     raeburn  15950:                 );
                   15951:     return $names{$crstype};
                   15952: }
                   15953: 
1.902     raeburn  15954: sub course_types {
1.1075.2.59  raeburn  15955:     my @types = ('official','unofficial','community','textbook');
1.902     raeburn  15956:     my %typename = (
                   15957:                          official   => 'Official course',
                   15958:                          unofficial => 'Unofficial course',
                   15959:                          community  => 'Community',
1.1075.2.59  raeburn  15960:                          textbook   => 'Textbook course',
1.902     raeburn  15961:                    );
                   15962:     return (\@types,\%typename);
                   15963: }
                   15964: 
1.156     albertel 15965: sub icon {
                   15966:     my ($file)=@_;
1.505     albertel 15967:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 15968:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 15969:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 15970:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   15971: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   15972: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15973: 	            $curfext.".gif") {
                   15974: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   15975: 		$curfext.".gif";
                   15976: 	}
                   15977:     }
1.249     albertel 15978:     return &lonhttpdurl($iconname);
1.154     albertel 15979: } 
1.84      albertel 15980: 
1.575     albertel 15981: sub lonhttpdurl {
1.692     www      15982: #
                   15983: # Had been used for "small fry" static images on separate port 8080.
                   15984: # Modify here if lightweight http functionality desired again.
                   15985: # Currently eliminated due to increasing firewall issues.
                   15986: #
1.575     albertel 15987:     my ($url)=@_;
1.692     www      15988:     return $url;
1.215     albertel 15989: }
                   15990: 
1.213     albertel 15991: sub connection_aborted {
                   15992:     my ($r)=@_;
                   15993:     $r->print(" ");$r->rflush();
                   15994:     my $c = $r->connection;
                   15995:     return $c->aborted();
                   15996: }
                   15997: 
1.221     foxr     15998: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     15999: #    strings as 'strings'.
                   16000: sub escape_single {
1.221     foxr     16001:     my ($input) = @_;
1.223     albertel 16002:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     16003:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   16004:     return $input;
                   16005: }
1.223     albertel 16006: 
1.222     foxr     16007: #  Same as escape_single, but escape's "'s  This 
                   16008: #  can be used for  "strings"
                   16009: sub escape_double {
                   16010:     my ($input) = @_;
                   16011:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   16012:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   16013:     return $input;
                   16014: }
1.223     albertel 16015:  
1.222     foxr     16016: #   Escapes the last element of a full URL.
                   16017: sub escape_url {
                   16018:     my ($url)   = @_;
1.238     raeburn  16019:     my @urlslices = split(/\//, $url,-1);
1.369     www      16020:     my $lastitem = &escape(pop(@urlslices));
1.1075.2.83  raeburn  16021:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     16022: }
1.462     albertel 16023: 
1.820     raeburn  16024: sub compare_arrays {
                   16025:     my ($arrayref1,$arrayref2) = @_;
                   16026:     my (@difference,%count);
                   16027:     @difference = ();
                   16028:     %count = ();
                   16029:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   16030:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   16031:         foreach my $element (keys(%count)) {
                   16032:             if ($count{$element} == 1) {
                   16033:                 push(@difference,$element);
                   16034:             }
                   16035:         }
                   16036:     }
                   16037:     return @difference;
                   16038: }
                   16039: 
1.1075.2.152  raeburn  16040: sub lon_status_items {
                   16041:     my %defaults = (
                   16042:                      E         => 100,
                   16043:                      W         => 4,
                   16044:                      N         => 1,
                   16045:                      U         => 5,
                   16046:                      threshold => 200,
                   16047:                      sysmail   => 2500,
                   16048:                    );
                   16049:     my %names = (
                   16050:                    E => 'Errors',
                   16051:                    W => 'Warnings',
                   16052:                    N => 'Notices',
                   16053:                    U => 'Unsent',
                   16054:                 );
                   16055:     return (\%defaults,\%names);
                   16056: }
                   16057: 
1.817     bisitz   16058: # -------------------------------------------------------- Initialize user login
1.462     albertel 16059: sub init_user_environment {
1.463     albertel 16060:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 16061:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   16062: 
                   16063:     my $public=($username eq 'public' && $domain eq 'public');
                   16064: 
                   16065: # See if old ID present, if so, remove
                   16066: 
1.1062    raeburn  16067:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv);
1.462     albertel 16068:     my $now=time;
                   16069: 
                   16070:     if ($public) {
                   16071: 	my $max_public=100;
                   16072: 	my $oldest;
                   16073: 	my $oldest_time=0;
                   16074: 	for(my $next=1;$next<=$max_public;$next++) {
                   16075: 	    if (-e $lonids."/publicuser_$next.id") {
                   16076: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   16077: 		if ($mtime<$oldest_time || !$oldest_time) {
                   16078: 		    $oldest_time=$mtime;
                   16079: 		    $oldest=$next;
                   16080: 		}
                   16081: 	    } else {
                   16082: 		$cookie="publicuser_$next";
                   16083: 		last;
                   16084: 	    }
                   16085: 	}
                   16086: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   16087:     } else {
1.463     albertel 16088: 	# if this isn't a robot, kill any existing non-robot sessions
                   16089: 	if (!$args->{'robot'}) {
                   16090: 	    opendir(DIR,$lonids);
                   16091: 	    while ($filename=readdir(DIR)) {
                   16092: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1075.2.136  raeburn  16093:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   16094:                             &GDBM_READER(),0640)) {
                   16095:                         my $linkedfile;
                   16096:                         if (exists($oldenv{'user.linkedenv'})) {
                   16097:                             $linkedfile = $oldenv{'user.linkedenv'};
                   16098:                         }
                   16099:                         untie(%oldenv);
                   16100:                         if (unlink("$lonids/$filename")) {
                   16101:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   16102:                                 if (-l "$lonids/$linkedfile.id") {
                   16103:                                     unlink("$lonids/$linkedfile.id");
                   16104:                                 }
                   16105:                             }
                   16106:                         }
                   16107:                     } else {
                   16108:                         unlink($lonids.'/'.$filename);
                   16109:                     }
1.463     albertel 16110: 		}
1.462     albertel 16111: 	    }
1.463     albertel 16112: 	    closedir(DIR);
1.1075.2.84  raeburn  16113: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   16114:             my $namespace = 'nohist_courseeditor';
                   16115:             my $lockingkey = 'paste'."\0".'locked_num';
                   16116:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   16117:                                                 $domain,$username);
                   16118:             if (exists($lockhash{$lockingkey})) {
                   16119:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   16120:                 unless ($delresult eq 'ok') {
                   16121:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   16122:                 }
                   16123:             }
1.462     albertel 16124: 	}
                   16125: # Give them a new cookie
1.463     albertel 16126: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      16127: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 16128: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 16129:     
                   16130: # Initialize roles
                   16131: 
1.1062    raeburn  16132: 	($userroles,$firstaccenv,$timerintenv) = 
                   16133:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 16134:     }
                   16135: # ------------------------------------ Check browser type and MathML capability
                   16136: 
1.1075.2.77  raeburn  16137:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   16138:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 16139: 
                   16140: # ------------------------------------------------------------- Get environment
                   16141: 
                   16142:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   16143:     my ($tmp) = keys(%userenv);
                   16144:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   16145:     } else {
                   16146: 	undef(%userenv);
                   16147:     }
                   16148:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   16149: 	$form->{'interface'}=$userenv{'interface'};
                   16150:     }
                   16151:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   16152: 
                   16153: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   16154:     foreach my $option ('interface','localpath','localres') {
                   16155:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 16156:     }
                   16157: # --------------------------------------------------------- Write first profile
                   16158: 
                   16159:     {
1.1075.2.150  raeburn  16160:         my $ip = &Apache::lonnet::get_requestor_ip();
1.462     albertel 16161: 	my %initial_env = 
                   16162: 	    ("user.name"          => $username,
                   16163: 	     "user.domain"        => $domain,
                   16164: 	     "user.home"          => $authhost,
                   16165: 	     "browser.type"       => $clientbrowser,
                   16166: 	     "browser.version"    => $clientversion,
                   16167: 	     "browser.mathml"     => $clientmathml,
                   16168: 	     "browser.unicode"    => $clientunicode,
                   16169: 	     "browser.os"         => $clientos,
1.1075.2.42  raeburn  16170:              "browser.mobile"     => $clientmobile,
                   16171:              "browser.info"       => $clientinfo,
1.1075.2.77  raeburn  16172:              "browser.osversion"  => $clientosversion,
1.462     albertel 16173: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   16174: 	     "request.course.fn"  => '',
                   16175: 	     "request.course.uri" => '',
                   16176: 	     "request.course.sec" => '',
                   16177: 	     "request.role"       => 'cm',
                   16178: 	     "request.role.adv"   => $env{'user.adv'},
1.1075.2.150  raeburn  16179: 	     "request.host"       => $ip,);
1.462     albertel 16180: 
                   16181:         if ($form->{'localpath'}) {
                   16182: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   16183: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   16184:         }
                   16185: 	
                   16186: 	if ($form->{'interface'}) {
                   16187: 	    $form->{'interface'}=~s/\W//gs;
                   16188: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   16189: 	    $env{'browser.interface'}=$form->{'interface'};
                   16190: 	}
                   16191: 
1.1075.2.54  raeburn  16192:         if ($form->{'iptoken'}) {
                   16193:             my $lonhost = $r->dir_config('lonHostID');
                   16194:             $initial_env{"user.noloadbalance"} = $lonhost;
                   16195:             $env{'user.noloadbalance'} = $lonhost;
                   16196:         }
                   16197: 
1.1075.2.120  raeburn  16198:         if ($form->{'noloadbalance'}) {
                   16199:             my @hosts = &Apache::lonnet::current_machine_ids();
                   16200:             my $hosthere = $form->{'noloadbalance'};
                   16201:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   16202:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   16203:                 $env{'user.noloadbalance'} = $hosthere;
                   16204:             }
                   16205:         }
                   16206: 
1.1016    raeburn  16207:         unless ($domain eq 'public') {
1.1075.2.125  raeburn  16208:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   16209:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
1.980     raeburn  16210: 
1.1075.2.125  raeburn  16211:             foreach my $tool ('aboutme','blog','webdav','portfolio') {
                   16212:                 $userenv{'availabletools.'.$tool} = 
                   16213:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   16214:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   16215:             }
1.724     raeburn  16216: 
1.1075.2.125  raeburn  16217:             foreach my $crstype ('official','unofficial','community','textbook') {
                   16218:                 $userenv{'canrequest.'.$crstype} =
                   16219:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   16220:                                                       'reload','requestcourses',
                   16221:                                                       \%userenv,\%domdef,\%is_adv);
                   16222:             }
1.765     raeburn  16223: 
1.1075.2.125  raeburn  16224:             $userenv{'canrequest.author'} =
                   16225:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   16226:                                                   'reload','requestauthor',
                   16227:                                                   \%userenv,\%domdef,\%is_adv);
                   16228:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   16229:                                                  $domain,$username);
                   16230:             my $reqstatus = $reqauthor{'author_status'};
                   16231:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') {
                   16232:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   16233:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   16234:                                                       $reqauthor{'author'}{'timestamp'};
                   16235:                 }
1.1075.2.14  raeburn  16236:             }
                   16237:         }
                   16238: 
1.462     albertel 16239: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  16240: 
1.462     albertel 16241: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   16242: 		 &GDBM_WRCREAT(),0640)) {
                   16243: 	    &_add_to_env(\%disk_env,\%initial_env);
                   16244: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   16245: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  16246:             if (ref($firstaccenv) eq 'HASH') {
                   16247:                 &_add_to_env(\%disk_env,$firstaccenv);
                   16248:             }
                   16249:             if (ref($timerintenv) eq 'HASH') {
                   16250:                 &_add_to_env(\%disk_env,$timerintenv);
                   16251:             }
1.463     albertel 16252: 	    if (ref($args->{'extra_env'})) {
                   16253: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   16254: 	    }
1.462     albertel 16255: 	    untie(%disk_env);
                   16256: 	} else {
1.705     tempelho 16257: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   16258: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 16259: 	    return 'error: '.$!;
                   16260: 	}
                   16261:     }
                   16262:     $env{'request.role'}='cm';
                   16263:     $env{'request.role.adv'}=$env{'user.adv'};
                   16264:     $env{'browser.type'}=$clientbrowser;
                   16265: 
                   16266:     return $cookie;
                   16267: 
                   16268: }
                   16269: 
                   16270: sub _add_to_env {
                   16271:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  16272:     if (ref($env_data) eq 'HASH') {
                   16273:         while (my ($key,$value) = each(%$env_data)) {
                   16274: 	    $idf->{$prefix.$key} = $value;
                   16275: 	    $env{$prefix.$key}   = $value;
                   16276:         }
1.462     albertel 16277:     }
                   16278: }
                   16279: 
1.685     tempelho 16280: # --- Get the symbolic name of a problem and the url
                   16281: sub get_symb {
                   16282:     my ($request,$silent) = @_;
1.726     raeburn  16283:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 16284:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   16285:     if ($symb eq '') {
                   16286:         if (!$silent) {
1.1071    raeburn  16287:             if (ref($request)) { 
                   16288:                 $request->print("Unable to handle ambiguous references:$url:.");
                   16289:             }
1.685     tempelho 16290:             return ();
                   16291:         }
                   16292:     }
                   16293:     &Apache::lonenc::check_decrypt(\$symb);
                   16294:     return ($symb);
                   16295: }
                   16296: 
                   16297: # --------------------------------------------------------------Get annotation
                   16298: 
                   16299: sub get_annotation {
                   16300:     my ($symb,$enc) = @_;
                   16301: 
                   16302:     my $key = $symb;
                   16303:     if (!$enc) {
                   16304:         $key =
                   16305:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   16306:     }
                   16307:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   16308:     return $annotation{$key};
                   16309: }
                   16310: 
                   16311: sub clean_symb {
1.731     raeburn  16312:     my ($symb,$delete_enc) = @_;
1.685     tempelho 16313: 
                   16314:     &Apache::lonenc::check_decrypt(\$symb);
                   16315:     my $enc = $env{'request.enc'};
1.731     raeburn  16316:     if ($delete_enc) {
1.730     raeburn  16317:         delete($env{'request.enc'});
                   16318:     }
1.685     tempelho 16319: 
                   16320:     return ($symb,$enc);
                   16321: }
1.462     albertel 16322: 
1.1075.2.69  raeburn  16323: ############################################################
                   16324: ############################################################
                   16325: 
                   16326: =pod
                   16327: 
                   16328: =head1 Routines for building display used to search for courses
                   16329: 
                   16330: 
                   16331: =over 4
                   16332: 
                   16333: =item * &build_filters()
                   16334: 
                   16335: Create markup for a table used to set filters to use when selecting
                   16336: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   16337: and quotacheck.pl
                   16338: 
                   16339: 
                   16340: Inputs:
                   16341: 
                   16342: filterlist - anonymous array of fields to include as potential filters
                   16343: 
                   16344: crstype - course type
                   16345: 
                   16346: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   16347:               to pop-open a course selector (will contain "extra element").
                   16348: 
                   16349: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   16350: 
                   16351: filter - anonymous hash of criteria and their values
                   16352: 
                   16353: action - form action
                   16354: 
                   16355: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   16356: 
                   16357: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
                   16358: 
                   16359: cloneruname - username of owner of new course who wants to clone
                   16360: 
                   16361: clonerudom - domain of owner of new course who wants to clone
                   16362: 
                   16363: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community)
                   16364: 
                   16365: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   16366: 
                   16367: codedom - domain
                   16368: 
                   16369: formname - value of form element named "form".
                   16370: 
                   16371: fixeddom - domain, if fixed.
                   16372: 
                   16373: prevphase - value to assign to form element named "phase" when going back to the previous screen
                   16374: 
                   16375: cnameelement - name of form element in form on opener page which will receive title of selected course
                   16376: 
                   16377: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   16378: 
                   16379: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   16380: 
                   16381: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   16382: 
                   16383: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   16384: 
                   16385: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   16386: 
                   16387: 
                   16388: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   16389: 
                   16390: 
                   16391: Side Effects: None
                   16392: 
                   16393: =cut
                   16394: 
                   16395: # ---------------------------------------------- search for courses based on last activity etc.
                   16396: 
                   16397: sub build_filters {
                   16398:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   16399:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   16400:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   16401:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   16402:         $clonetext,$clonewarning) = @_;
                   16403:     my ($list,$jscript);
                   16404:     my $onchange = 'javascript:updateFilters(this)';
                   16405:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   16406:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   16407:         $typeselectform,$instcodetitle);
                   16408:     if ($formname eq '') {
                   16409:         $formname = $caller;
                   16410:     }
                   16411:     foreach my $item (@{$filterlist}) {
                   16412:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   16413:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   16414:             if ($item eq 'domainfilter') {
                   16415:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   16416:             } elsif ($item eq 'coursefilter') {
                   16417:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   16418:             } elsif ($item eq 'ownerfilter') {
                   16419:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16420:             } elsif ($item eq 'ownerdomfilter') {
                   16421:                 $filter->{'ownerdomfilter'} =
                   16422:                     &LONCAPA::clean_domain($filter->{$item});
                   16423:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   16424:                                                        'ownerdomfilter',1);
                   16425:             } elsif ($item eq 'personfilter') {
                   16426:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   16427:             } elsif ($item eq 'persondomfilter') {
                   16428:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   16429:                                                         'persondomfilter',1);
                   16430:             } else {
                   16431:                 $filter->{$item} =~ s/\W//g;
                   16432:             }
                   16433:             if (!$filter->{$item}) {
                   16434:                 $filter->{$item} = '';
                   16435:             }
                   16436:         }
                   16437:         if ($item eq 'domainfilter') {
                   16438:             my $allow_blank = 1;
                   16439:             if ($formname eq 'portform') {
                   16440:                 $allow_blank=0;
                   16441:             } elsif ($formname eq 'studentform') {
                   16442:                 $allow_blank=0;
                   16443:             }
                   16444:             if ($fixeddom) {
                   16445:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   16446:                                     ' value="'.$codedom.'" />'.
                   16447:                                     &Apache::lonnet::domain($codedom,'description');
                   16448:             } else {
                   16449:                 $domainselectform = &select_dom_form($filter->{$item},
                   16450:                                                      'domainfilter',
                   16451:                                                       $allow_blank,'',$onchange);
                   16452:             }
                   16453:         } else {
                   16454:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   16455:         }
                   16456:     }
                   16457: 
                   16458:     # last course activity filter and selection
                   16459:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   16460: 
                   16461:     # course created filter and selection
                   16462:     if (exists($filter->{'createdfilter'})) {
                   16463:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   16464:     }
                   16465: 
                   16466:     my %lt = &Apache::lonlocal::texthash(
                   16467:                 'cac' => "$crstype Activity",
                   16468:                 'ccr' => "$crstype Created",
                   16469:                 'cde' => "$crstype Title",
                   16470:                 'cdo' => "$crstype Domain",
                   16471:                 'ins' => 'Institutional Code',
                   16472:                 'inc' => 'Institutional Categorization',
                   16473:                 'cow' => "$crstype Owner/Co-owner",
                   16474:                 'cop' => "$crstype Personnel Includes",
                   16475:                 'cog' => 'Type',
                   16476:              );
                   16477: 
                   16478:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16479:         my $typeval = 'Course';
                   16480:         if ($crstype eq 'Community') {
                   16481:             $typeval = 'Community';
                   16482:         }
                   16483:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   16484:     } else {
                   16485:         $typeselectform =  '<select name="type" size="1"';
                   16486:         if ($onchange) {
                   16487:             $typeselectform .= ' onchange="'.$onchange.'"';
                   16488:         }
                   16489:         $typeselectform .= '>'."\n";
                   16490:         foreach my $posstype ('Course','Community') {
                   16491:             $typeselectform.='<option value="'.$posstype.'"'.
                   16492:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".&mt($posstype)."</option>\n";
                   16493:         }
                   16494:         $typeselectform.="</select>";
                   16495:     }
                   16496: 
                   16497:     my ($cloneableonlyform,$cloneabletitle);
                   16498:     if (exists($filter->{'cloneableonly'})) {
                   16499:         my $cloneableon = '';
                   16500:         my $cloneableoff = ' checked="checked"';
                   16501:         if ($filter->{'cloneableonly'}) {
                   16502:             $cloneableon = $cloneableoff;
                   16503:             $cloneableoff = '';
                   16504:         }
                   16505:         $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>';
                   16506:         if ($formname eq 'ccrs') {
1.1075.2.71  raeburn  16507:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1075.2.69  raeburn  16508:         } else {
                   16509:             $cloneabletitle = &mt('Cloneable by you');
                   16510:         }
                   16511:     }
                   16512:     my $officialjs;
                   16513:     if ($crstype eq 'Course') {
                   16514:         if (exists($filter->{'instcodefilter'})) {
                   16515: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   16516: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   16517:             if ($codedom) {
                   16518:                 $officialjs = 1;
                   16519:                 ($instcodeform,$jscript,$$numtitlesref) =
                   16520:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   16521:                                                                   $officialjs,$codetitlesref);
                   16522:                 if ($jscript) {
                   16523:                     $jscript = '<script type="text/javascript">'."\n".
                   16524:                                '// <![CDATA['."\n".
                   16525:                                $jscript."\n".
                   16526:                                '// ]]>'."\n".
                   16527:                                '</script>'."\n";
                   16528:                 }
                   16529:             }
                   16530:             if ($instcodeform eq '') {
                   16531:                 $instcodeform =
                   16532:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   16533:                     $list->{'instcodefilter'}.'" />';
                   16534:                 $instcodetitle = $lt{'ins'};
                   16535:             } else {
                   16536:                 $instcodetitle = $lt{'inc'};
                   16537:             }
                   16538:             if ($fixeddom) {
                   16539:                 $instcodetitle .= '<br />('.$codedom.')';
                   16540:             }
                   16541:         }
                   16542:     }
                   16543:     my $output = qq|
                   16544: <form method="post" name="filterpicker" action="$action">
                   16545: <input type="hidden" name="form" value="$formname" />
                   16546: |;
                   16547:     if ($formname eq 'modifycourse') {
                   16548:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   16549:                    '<input type="hidden" name="prevphase" value="'.
                   16550:                    $prevphase.'" />'."\n";
1.1075.2.82  raeburn  16551:     } elsif ($formname eq 'quotacheck') {
                   16552:         $output .= qq|
                   16553: <input type="hidden" name="sortby" value="" />
                   16554: <input type="hidden" name="sortorder" value="" />
                   16555: |;
                   16556:     } else {
1.1075.2.69  raeburn  16557:         my $name_input;
                   16558:         if ($cnameelement ne '') {
                   16559:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   16560:                           $cnameelement.'" />';
                   16561:         }
                   16562:         $output .= qq|
                   16563: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   16564: <input type="hidden" name="cdomelement" value="$cdomelement" />
                   16565: $name_input
                   16566: $roleelement
                   16567: $multelement
                   16568: $typeelement
                   16569: |;
                   16570:         if ($formname eq 'portform') {
                   16571:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   16572:         }
                   16573:     }
                   16574:     if ($fixeddom) {
                   16575:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   16576:     }
                   16577:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   16578:     if ($sincefilterform) {
                   16579:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   16580:                   .$sincefilterform
                   16581:                   .&Apache::lonhtmlcommon::row_closure();
                   16582:     }
                   16583:     if ($createdfilterform) {
                   16584:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   16585:                   .$createdfilterform
                   16586:                   .&Apache::lonhtmlcommon::row_closure();
                   16587:     }
                   16588:     if ($domainselectform) {
                   16589:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   16590:                   .$domainselectform
                   16591:                   .&Apache::lonhtmlcommon::row_closure();
                   16592:     }
                   16593:     if ($typeselectform) {
                   16594:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   16595:             $output .= $typeselectform;
                   16596:         } else {
                   16597:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   16598:                       .$typeselectform
                   16599:                       .&Apache::lonhtmlcommon::row_closure();
                   16600:         }
                   16601:     }
                   16602:     if ($instcodeform) {
                   16603:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   16604:                   .$instcodeform
                   16605:                   .&Apache::lonhtmlcommon::row_closure();
                   16606:     }
                   16607:     if (exists($filter->{'ownerfilter'})) {
                   16608:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   16609:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16610:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   16611:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16612:                    $ownerdomselectform.'</td></tr></table>'.
                   16613:                    &Apache::lonhtmlcommon::row_closure();
                   16614:     }
                   16615:     if (exists($filter->{'personfilter'})) {
                   16616:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   16617:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   16618:                    '<input type="text" name="personfilter" size="20" value="'.
                   16619:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   16620:                    $persondomselectform.'</td></tr></table>'.
                   16621:                    &Apache::lonhtmlcommon::row_closure();
                   16622:     }
                   16623:     if (exists($filter->{'coursefilter'})) {
                   16624:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   16625:                   .'<input type="text" name="coursefilter" size="25" value="'
                   16626:                   .$list->{'coursefilter'}.'" />'
                   16627:                   .&Apache::lonhtmlcommon::row_closure();
                   16628:     }
                   16629:     if ($cloneableonlyform) {
                   16630:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   16631:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   16632:     }
                   16633:     if (exists($filter->{'descriptfilter'})) {
                   16634:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   16635:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   16636:                   .$list->{'descriptfilter'}.'" />'
                   16637:                   .&Apache::lonhtmlcommon::row_closure(1);
                   16638:     }
                   16639:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   16640:                '<input type="hidden" name="updater" value="" />'."\n".
                   16641:                '<input type="submit" name="gosearch" value="'.
                   16642:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   16643:     return $jscript.$clonewarning.$output;
                   16644: }
                   16645: 
                   16646: =pod
                   16647: 
                   16648: =item * &timebased_select_form()
                   16649: 
                   16650: Create markup for a dropdown list used to select a time-based
                   16651: filter e.g., Course Activity, Course Created, when searching for courses
                   16652: or communities
                   16653: 
                   16654: Inputs:
                   16655: 
                   16656: item - name of form element (sincefilter or createdfilter)
                   16657: 
                   16658: filter - anonymous hash of criteria and their values
                   16659: 
                   16660: Returns: HTML for a select box contained a blank, then six time selections,
                   16661:          with value set in incoming form variables currently selected.
                   16662: 
                   16663: Side Effects: None
                   16664: 
                   16665: =cut
                   16666: 
                   16667: sub timebased_select_form {
                   16668:     my ($item,$filter) = @_;
                   16669:     if (ref($filter) eq 'HASH') {
                   16670:         $filter->{$item} =~ s/[^\d-]//g;
                   16671:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   16672:         return &select_form(
                   16673:                             $filter->{$item},
                   16674:                             $item,
                   16675:                             {      '-1' => '',
                   16676:                                 '86400' => &mt('today'),
                   16677:                                '604800' => &mt('last week'),
                   16678:                               '2592000' => &mt('last month'),
                   16679:                               '7776000' => &mt('last three months'),
                   16680:                              '15552000' => &mt('last six months'),
                   16681:                              '31104000' => &mt('last year'),
                   16682:                     'select_form_order' =>
                   16683:                            ['-1','86400','604800','2592000','7776000',
                   16684:                             '15552000','31104000']});
                   16685:     }
                   16686: }
                   16687: 
                   16688: =pod
                   16689: 
                   16690: =item * &js_changer()
                   16691: 
                   16692: Create script tag containing Javascript used to submit course search form
                   16693: when course type or domain is changed, and also to hide 'Searching ...' on
                   16694: page load completion for page showing search result.
                   16695: 
                   16696: Inputs: None
                   16697: 
                   16698: Returns: markup containing updateFilters() and hideSearching() javascript functions.
                   16699: 
                   16700: Side Effects: None
                   16701: 
                   16702: =cut
                   16703: 
                   16704: sub js_changer {
                   16705:     return <<ENDJS;
                   16706: <script type="text/javascript">
                   16707: // <![CDATA[
                   16708: function updateFilters(caller) {
                   16709:     if (typeof(caller) != "undefined") {
                   16710:         document.filterpicker.updater.value = caller.name;
                   16711:     }
                   16712:     document.filterpicker.submit();
                   16713: }
                   16714: 
                   16715: function hideSearching() {
                   16716:     if (document.getElementById('searching')) {
                   16717:         document.getElementById('searching').style.display = 'none';
                   16718:     }
                   16719:     return;
                   16720: }
                   16721: 
                   16722: // ]]>
                   16723: </script>
                   16724: 
                   16725: ENDJS
                   16726: }
                   16727: 
                   16728: =pod
                   16729: 
                   16730: =item * &search_courses()
                   16731: 
                   16732: Process selected filters form course search form and pass to lonnet::courseiddump
                   16733: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   16734: 
                   16735: Inputs:
                   16736: 
                   16737: dom - domain being searched
                   16738: 
                   16739: type - course type ('Course' or 'Community' or '.' if any).
                   16740: 
                   16741: filter - anonymous hash of criteria and their values
                   16742: 
                   16743: numtitles - for institutional codes - number of categories
                   16744: 
                   16745: cloneruname - optional username of new course owner
                   16746: 
                   16747: clonerudom - optional domain of new course owner
                   16748: 
1.1075.2.95  raeburn  16749: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by,
1.1075.2.69  raeburn  16750:             (used when DC is using course creation form)
                   16751: 
                   16752: codetitles - reference to array of titles of components in institutional codes (official courses).
                   16753: 
1.1075.2.95  raeburn  16754: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   16755:            (and so can clone automatically)
                   16756: 
                   16757: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   16758: 
                   16759: reqinstcode - institutional code of new course, where search_courses is used to identify potential
                   16760:               courses to clone
1.1075.2.69  raeburn  16761: 
                   16762: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   16763: 
                   16764: 
                   16765: Side Effects: None
                   16766: 
                   16767: =cut
                   16768: 
                   16769: 
                   16770: sub search_courses {
1.1075.2.95  raeburn  16771:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   16772:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1075.2.69  raeburn  16773:     my (%courses,%showcourses,$cloner);
                   16774:     if (($filter->{'ownerfilter'} ne '') ||
                   16775:         ($filter->{'ownerdomfilter'} ne '')) {
                   16776:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   16777:                                        $filter->{'ownerdomfilter'};
                   16778:     }
                   16779:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   16780:         if (!$filter->{$item}) {
                   16781:             $filter->{$item}='.';
                   16782:         }
                   16783:     }
                   16784:     my $now = time;
                   16785:     my $timefilter =
                   16786:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   16787:     my ($createdbefore,$createdafter);
                   16788:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   16789:         $createdbefore = $now;
                   16790:         $createdafter = $now-$filter->{'createdfilter'};
                   16791:     }
                   16792:     my ($instcodefilter,$regexpok);
                   16793:     if ($numtitles) {
                   16794:         if ($env{'form.official'} eq 'on') {
                   16795:             $instcodefilter =
                   16796:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16797:             $regexpok = 1;
                   16798:         } elsif ($env{'form.official'} eq 'off') {
                   16799:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   16800:             unless ($instcodefilter eq '') {
                   16801:                 $regexpok = -1;
                   16802:             }
                   16803:         }
                   16804:     } else {
                   16805:         $instcodefilter = $filter->{'instcodefilter'};
                   16806:     }
                   16807:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   16808:     if ($type eq '') { $type = '.'; }
                   16809: 
                   16810:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   16811:         $cloner = $cloneruname.':'.$clonerudom;
                   16812:     }
                   16813:     %courses = &Apache::lonnet::courseiddump($dom,
                   16814:                                              $filter->{'descriptfilter'},
                   16815:                                              $timefilter,
                   16816:                                              $instcodefilter,
                   16817:                                              $filter->{'combownerfilter'},
                   16818:                                              $filter->{'coursefilter'},
                   16819:                                              undef,undef,$type,$regexpok,undef,undef,
1.1075.2.95  raeburn  16820:                                              undef,undef,$cloner,$cc_clone,
1.1075.2.69  raeburn  16821:                                              $filter->{'cloneableonly'},
                   16822:                                              $createdbefore,$createdafter,undef,
1.1075.2.95  raeburn  16823:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1075.2.69  raeburn  16824:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   16825:         my $ccrole;
                   16826:         if ($type eq 'Community') {
                   16827:             $ccrole = 'co';
                   16828:         } else {
                   16829:             $ccrole = 'cc';
                   16830:         }
                   16831:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   16832:                                                      $filter->{'persondomfilter'},
                   16833:                                                      'userroles',undef,
                   16834:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   16835:                                                      $dom);
                   16836:         foreach my $role (keys(%rolehash)) {
                   16837:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   16838:             my $cid = $cdom.'_'.$cnum;
                   16839:             if (exists($courses{$cid})) {
                   16840:                 if (ref($courses{$cid}) eq 'HASH') {
                   16841:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   16842:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1075.2.119  raeburn  16843:                             push(@{$courses{$cid}{roles}},$courserole);
1.1075.2.69  raeburn  16844:                         }
                   16845:                     } else {
                   16846:                         $courses{$cid}{roles} = [$courserole];
                   16847:                     }
                   16848:                     $showcourses{$cid} = $courses{$cid};
                   16849:                 }
                   16850:             }
                   16851:         }
                   16852:         %courses = %showcourses;
                   16853:     }
                   16854:     return %courses;
                   16855: }
                   16856: 
                   16857: =pod
                   16858: 
                   16859: =back
                   16860: 
1.1075.2.88  raeburn  16861: =head1 Routines for version requirements for current course.
                   16862: 
                   16863: =over 4
                   16864: 
                   16865: =item * &check_release_required()
                   16866: 
                   16867: Compares required LON-CAPA version with version on server, and
                   16868: if required version is newer looks for a server with the required version.
                   16869: 
                   16870: Looks first at servers in user's owen domain; if none suitable, looks at
                   16871: servers in course's domain are permitted to host sessions for user's domain.
                   16872: 
                   16873: Inputs:
                   16874: 
                   16875: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16876: 
                   16877: $courseid - Course ID of current course
                   16878: 
                   16879: $rolecode - User's current role in course (for switchserver query string).
                   16880: 
                   16881: $required - LON-CAPA version needed by course (format: Major.Minor).
                   16882: 
                   16883: 
                   16884: Returns:
                   16885: 
                   16886: $switchserver - query string tp append to /adm/switchserver call (if
                   16887:                 current server's LON-CAPA version is too old.
                   16888: 
                   16889: $warning - Message is displayed if no suitable server could be found.
                   16890: 
                   16891: =cut
                   16892: 
                   16893: sub check_release_required {
                   16894:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   16895:     my ($switchserver,$warning);
                   16896:     if ($required ne '') {
                   16897:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   16898:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16899:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   16900:             my $otherserver;
                   16901:             if (($major eq '' && $minor eq '') ||
                   16902:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   16903:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   16904:                 my $switchlcrev =
                   16905:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   16906:                                                            $userdomserver);
                   16907:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   16908:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   16909:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   16910:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   16911:                     if ($cdom ne $env{'user.domain'}) {
                   16912:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   16913:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   16914:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   16915:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   16916:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   16917:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   16918:                         my $canhost =
                   16919:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   16920:                                                               $coursedomserver,
                   16921:                                                               $remoterev,
                   16922:                                                               $udomdefaults{'remotesessions'},
                   16923:                                                               $defdomdefaults{'hostedsessions'});
                   16924: 
                   16925:                         if ($canhost) {
                   16926:                             $otherserver = $coursedomserver;
                   16927:                         } else {
                   16928:                             $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.");
                   16929:                         }
                   16930:                     } else {
                   16931:                         $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).");
                   16932:                     }
                   16933:                 } else {
                   16934:                     $otherserver = $userdomserver;
                   16935:                 }
                   16936:             }
                   16937:             if ($otherserver ne '') {
                   16938:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   16939:             }
                   16940:         }
                   16941:     }
                   16942:     return ($switchserver,$warning);
                   16943: }
                   16944: 
                   16945: =pod
                   16946: 
                   16947: =item * &check_release_result()
                   16948: 
                   16949: Inputs:
                   16950: 
                   16951: $switchwarning - Warning message if no suitable server found to host session.
                   16952: 
                   16953: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   16954:                 and current role.
                   16955: 
                   16956: Returns: HTML to display with information about requirement to switch server.
                   16957:          Either displaying warning with link to Roles/Courses screen or
                   16958:          display link to switchserver.
                   16959: 
1.1075.2.69  raeburn  16960: =cut
                   16961: 
1.1075.2.88  raeburn  16962: sub check_release_result {
                   16963:     my ($switchwarning,$switchserver) = @_;
                   16964:     my $output = &start_page('Selected course unavailable on this server').
                   16965:                  '<p class="LC_warning">';
                   16966:     if ($switchwarning) {
                   16967:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   16968:         if (&show_course()) {
                   16969:             $output .= &mt('Display courses');
                   16970:         } else {
                   16971:             $output .= &mt('Display roles');
                   16972:         }
                   16973:         $output .= '</a>';
                   16974:     } elsif ($switchserver) {
                   16975:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   16976:                    '<br />'.
                   16977:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   16978:                    &mt('Switch Server').
                   16979:                    '</a>';
                   16980:     }
                   16981:     $output .= '</p>'.&end_page();
                   16982:     return $output;
                   16983: }
                   16984: 
                   16985: =pod
                   16986: 
                   16987: =item * &needs_coursereinit()
                   16988: 
                   16989: Determine if course contents stored for user's session needs to be
                   16990: refreshed, because content has changed since "Big Hash" last tied.
                   16991: 
                   16992: Check for change is made if time last checked is more than 10 minutes ago
                   16993: (by default).
                   16994: 
                   16995: Inputs:
                   16996: 
                   16997: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   16998: 
                   16999: $interval (optional) - Time which may elapse (in s) between last check for content
                   17000:                        change in current course. (default: 600 s).
                   17001: 
                   17002: Returns: an array; first element is:
                   17003: 
                   17004: =over 4
                   17005: 
                   17006: 'switch' - if content updates mean user's session
                   17007:            needs to be switched to a server running a newer LON-CAPA version
                   17008: 
                   17009: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   17010:            on current server hosting user's session
                   17011: 
                   17012: ''       - if no action required.
                   17013: 
                   17014: =back
                   17015: 
                   17016: If first item element is 'switch':
                   17017: 
                   17018: second item is $switchwarning - Warning message if no suitable server found to host session.
                   17019: 
                   17020: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   17021:                               and current role.
                   17022: 
                   17023: otherwise: no other elements returned.
                   17024: 
                   17025: =back
                   17026: 
                   17027: =cut
                   17028: 
                   17029: sub needs_coursereinit {
                   17030:     my ($loncaparev,$interval) = @_;
                   17031:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   17032:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   17033:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   17034:     my $now = time;
                   17035:     if ($interval eq '') {
                   17036:         $interval = 600;
                   17037:     }
                   17038:     if (($now-$env{'request.course.timechecked'})>$interval) {
                   17039:         my $lastchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   17040:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
                   17041:         if ($lastchange > $env{'request.course.tied'}) {
                   17042:             my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17043:             if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   17044:                 my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   17045:                 if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   17046:                     &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   17047:                                              $curr_reqd_hash{'internal.releaserequired'}});
                   17048:                     my ($switchserver,$switchwarning) =
                   17049:                         &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   17050:                                                 $curr_reqd_hash{'internal.releaserequired'});
                   17051:                     if ($switchwarning ne '' || $switchserver ne '') {
                   17052:                         return ('switch',$switchwarning,$switchserver);
                   17053:                     }
                   17054:                 }
                   17055:             }
                   17056:             return ('update');
                   17057:         }
                   17058:     }
                   17059:     return ();
                   17060: }
1.1075.2.69  raeburn  17061: 
1.1075.2.11  raeburn  17062: sub update_content_constraints {
                   17063:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17064:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   17065:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
                   17066:     my %checkresponsetypes;
                   17067:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
                   17068:         my ($item,$name,$value) = split(/:/,$key);
                   17069:         if ($item eq 'resourcetag') {
                   17070:             if ($name eq 'responsetype') {
                   17071:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   17072:             }
                   17073:         }
                   17074:     }
                   17075:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17076:     if (defined($navmap)) {
                   17077:         my %allresponses;
                   17078:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() },1,0)) {
                   17079:             my %responses = $res->responseTypes();
                   17080:             foreach my $key (keys(%responses)) {
                   17081:                 next unless(exists($checkresponsetypes{$key}));
                   17082:                 $allresponses{$key} += $responses{$key};
                   17083:             }
                   17084:         }
                   17085:         foreach my $key (keys(%allresponses)) {
                   17086:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   17087:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   17088:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   17089:             }
                   17090:         }
                   17091:         undef($navmap);
                   17092:     }
                   17093:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   17094:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   17095:     }
                   17096:     return;
                   17097: }
                   17098: 
1.1075.2.27  raeburn  17099: sub allmaps_incourse {
                   17100:     my ($cdom,$cnum,$chome,$cid) = @_;
                   17101:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   17102:         $cid = $env{'request.course.id'};
                   17103:         $cdom = $env{'course.'.$cid.'.domain'};
                   17104:         $cnum = $env{'course.'.$cid.'.num'};
                   17105:         $chome = $env{'course.'.$cid.'.home'};
                   17106:     }
                   17107:     my %allmaps = ();
                   17108:     my $lastchange =
                   17109:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   17110:     if ($lastchange > $env{'request.course.tied'}) {
                   17111:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   17112:         unless ($ferr) {
                   17113:             &update_content_constraints($cdom,$cnum,$chome,$cid);
                   17114:         }
                   17115:     }
                   17116:     my $navmap = Apache::lonnavmaps::navmap->new();
                   17117:     if (defined($navmap)) {
                   17118:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   17119:             $allmaps{$res->src()} = 1;
                   17120:         }
                   17121:     }
                   17122:     return \%allmaps;
                   17123: }
                   17124: 
1.1075.2.11  raeburn  17125: sub parse_supplemental_title {
                   17126:     my ($title) = @_;
                   17127: 
                   17128:     my ($foldertitle,$renametitle);
                   17129:     if ($title =~ /&amp;&amp;&amp;/) {
                   17130:         $title = &HTML::Entites::decode($title);
                   17131:     }
                   17132:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   17133:         $renametitle=$4;
                   17134:         my ($time,$uname,$udom) = ($1,$2,$3);
                   17135:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   17136:         my $name =  &plainname($uname,$udom);
                   17137:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   17138:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
                   17139:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.
                   17140:             $name.': <br />'.$foldertitle;
                   17141:     }
                   17142:     if (wantarray) {
                   17143:         return ($title,$foldertitle,$renametitle);
                   17144:     }
                   17145:     return $title;
                   17146: }
                   17147: 
1.1075.2.43  raeburn  17148: sub recurse_supplemental {
                   17149:     my ($cnum,$cdom,$suppmap,$numfiles,$errors) = @_;
                   17150:     if ($suppmap) {
                   17151:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   17152:         if ($fatal) {
                   17153:             $errors ++;
                   17154:         } else {
1.1075.2.167! raeburn  17155:             my @order = @LONCAPA::map::order;
        !          17156:             if (@order > 0) {
        !          17157:                 my @resources = @LONCAPA::map::resources;
        !          17158:                 my @resparms = @LONCAPA::map::resparms;
        !          17159:                 foreach my $idx (@order) {
        !          17160:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1075.2.43  raeburn  17161:                     if (($src ne '') && ($status eq 'res')) {
1.1075.2.46  raeburn  17162:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
                   17163:                             ($numfiles,$errors) = &recurse_supplemental($cnum,$cdom,$1,$numfiles,$errors);
1.1075.2.43  raeburn  17164:                         } else {
                   17165:                             $numfiles ++;
                   17166:                         }
                   17167:                     }
                   17168:                 }
                   17169:             }
                   17170:         }
                   17171:     }
                   17172:     return ($numfiles,$errors);
                   17173: }
                   17174: 
1.1075.2.18  raeburn  17175: sub symb_to_docspath {
1.1075.2.119  raeburn  17176:     my ($symb,$navmapref) = @_;
                   17177:     return unless ($symb && ref($navmapref));
1.1075.2.18  raeburn  17178:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   17179:     if ($resurl=~/\.(sequence|page)$/) {
                   17180:         $mapurl=$resurl;
                   17181:     } elsif ($resurl eq 'adm/navmaps') {
                   17182:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   17183:     }
                   17184:     my $mapresobj;
1.1075.2.119  raeburn  17185:     unless (ref($$navmapref)) {
                   17186:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   17187:     }
                   17188:     if (ref($$navmapref)) {
                   17189:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1075.2.18  raeburn  17190:     }
                   17191:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   17192:     my $type=$2;
                   17193:     my $path;
                   17194:     if (ref($mapresobj)) {
                   17195:         my $pcslist = $mapresobj->map_hierarchy();
                   17196:         if ($pcslist ne '') {
                   17197:             foreach my $pc (split(/,/,$pcslist)) {
                   17198:                 next if ($pc <= 1);
1.1075.2.119  raeburn  17199:                 my $res = $$navmapref->getByMapPc($pc);
1.1075.2.18  raeburn  17200:                 if (ref($res)) {
                   17201:                     my $thisurl = $res->src();
                   17202:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   17203:                     my $thistitle = $res->title();
                   17204:                     $path .= '&'.
                   17205:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1075.2.46  raeburn  17206:                              &escape($thistitle).
1.1075.2.18  raeburn  17207:                              ':'.$res->randompick().
                   17208:                              ':'.$res->randomout().
                   17209:                              ':'.$res->encrypted().
                   17210:                              ':'.$res->randomorder().
                   17211:                              ':'.$res->is_page();
                   17212:                 }
                   17213:             }
                   17214:         }
                   17215:         $path =~ s/^\&//;
                   17216:         my $maptitle = $mapresobj->title();
                   17217:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17218:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17219:         }
                   17220:         $path .= (($path ne '')? '&' : '').
                   17221:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17222:                  &escape($maptitle).
1.1075.2.18  raeburn  17223:                  ':'.$mapresobj->randompick().
                   17224:                  ':'.$mapresobj->randomout().
                   17225:                  ':'.$mapresobj->encrypted().
                   17226:                  ':'.$mapresobj->randomorder().
                   17227:                  ':'.$mapresobj->is_page();
                   17228:     } else {
                   17229:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   17230:         my $ispage = (($type eq 'page')? 1 : '');
                   17231:         if ($mapurl eq 'default') {
1.1075.2.38  raeburn  17232:             $maptitle = 'Main Content';
1.1075.2.18  raeburn  17233:         }
                   17234:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1075.2.46  raeburn  17235:                 &escape($maptitle).':::::'.$ispage;
1.1075.2.18  raeburn  17236:     }
                   17237:     unless ($mapurl eq 'default') {
                   17238:         $path = 'default&'.
1.1075.2.46  raeburn  17239:                 &escape('Main Content').
1.1075.2.18  raeburn  17240:                 ':::::&'.$path;
                   17241:     }
                   17242:     return $path;
                   17243: }
                   17244: 
1.1075.2.14  raeburn  17245: sub captcha_display {
1.1075.2.137  raeburn  17246:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17247:     my ($output,$error);
1.1075.2.107  raeburn  17248:     my ($captcha,$pubkey,$privkey,$version) =
1.1075.2.137  raeburn  17249:         &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17250:     if ($captcha eq 'original') {
                   17251:         $output = &create_captcha();
                   17252:         unless ($output) {
                   17253:             $error = 'captcha';
                   17254:         }
                   17255:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17256:         $output = &create_recaptcha($pubkey,$version);
1.1075.2.14  raeburn  17257:         unless ($output) {
                   17258:             $error = 'recaptcha';
                   17259:         }
                   17260:     }
1.1075.2.107  raeburn  17261:     return ($output,$error,$captcha,$version);
1.1075.2.14  raeburn  17262: }
                   17263: 
                   17264: sub captcha_response {
1.1075.2.137  raeburn  17265:     my ($context,$lonhost,$defdom) = @_;
1.1075.2.14  raeburn  17266:     my ($captcha_chk,$captcha_error);
1.1075.2.137  raeburn  17267:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1075.2.14  raeburn  17268:     if ($captcha eq 'original') {
                   17269:         ($captcha_chk,$captcha_error) = &check_captcha();
                   17270:     } elsif ($captcha eq 'recaptcha') {
1.1075.2.107  raeburn  17271:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1075.2.14  raeburn  17272:     } else {
                   17273:         $captcha_chk = 1;
                   17274:     }
                   17275:     return ($captcha_chk,$captcha_error);
                   17276: }
                   17277: 
                   17278: sub get_captcha_config {
1.1075.2.137  raeburn  17279:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1075.2.107  raeburn  17280:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1075.2.14  raeburn  17281:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   17282:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   17283:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   17284:     if ($context eq 'usercreation') {
                   17285:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   17286:         if (ref($domconfig{$context}) eq 'HASH') {
                   17287:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   17288:             if (ref($hashtocheck) eq 'HASH') {
                   17289:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   17290:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   17291:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   17292:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   17293:                     }
                   17294:                     if ($privkey && $pubkey) {
                   17295:                         $captcha = 'recaptcha';
1.1075.2.107  raeburn  17296:                         $version = $hashtocheck->{'recaptchaversion'};
                   17297:                         if ($version ne '2') {
                   17298:                             $version = 1;
                   17299:                         }
1.1075.2.14  raeburn  17300:                     } else {
                   17301:                         $captcha = 'original';
                   17302:                     }
                   17303:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   17304:                     $captcha = 'original';
                   17305:                 }
                   17306:             }
                   17307:         } else {
                   17308:             $captcha = 'captcha';
                   17309:         }
                   17310:     } elsif ($context eq 'login') {
                   17311:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   17312:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   17313:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   17314:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
                   17315:             if ($privkey && $pubkey) {
                   17316:                 $captcha = 'recaptcha';
1.1075.2.107  raeburn  17317:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   17318:                 if ($version ne '2') {
                   17319:                     $version = 1;
                   17320:                 }
1.1075.2.14  raeburn  17321:             } else {
                   17322:                 $captcha = 'original';
                   17323:             }
                   17324:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   17325:             $captcha = 'original';
                   17326:         }
1.1075.2.137  raeburn  17327:     } elsif ($context eq 'passwords') {
                   17328:         if ($dom_in_effect) {
                   17329:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   17330:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   17331:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   17332:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   17333:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   17334:                 }
                   17335:                 if ($privkey && $pubkey) {
                   17336:                     $captcha = 'recaptcha';
                   17337:                     $version = $passwdconf{'recaptchaversion'};
                   17338:                     if ($version ne '2') {
                   17339:                         $version = 1;
                   17340:                     }
                   17341:                 } else {
                   17342:                     $captcha = 'original';
                   17343:                 }
                   17344:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   17345:                 $captcha = 'original';
                   17346:             }
                   17347:         }
1.1075.2.14  raeburn  17348:     }
1.1075.2.107  raeburn  17349:     return ($captcha,$pubkey,$privkey,$version);
1.1075.2.14  raeburn  17350: }
                   17351: 
                   17352: sub create_captcha {
                   17353:     my %captcha_params = &captcha_settings();
                   17354:     my ($output,$maxtries,$tries) = ('',10,0);
                   17355:     while ($tries < $maxtries) {
                   17356:         $tries ++;
                   17357:         my $captcha = Authen::Captcha->new (
                   17358:                                            output_folder => $captcha_params{'output_dir'},
                   17359:                                            data_folder   => $captcha_params{'db_dir'},
                   17360:                                           );
                   17361:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   17362: 
                   17363:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   17364:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1075.2.158  raeburn  17365:                       '<span class="LC_nobreak">'.
1.1075.2.14  raeburn  17366:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1075.2.167! raeburn  17367:                       '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1075.2.158  raeburn  17368:                       '</span><br />'.
1.1075.2.66  raeburn  17369:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1075.2.14  raeburn  17370:             last;
                   17371:         }
                   17372:     }
1.1075.2.158  raeburn  17373:     if ($output eq '') {
                   17374:         &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
                   17375:     }
1.1075.2.14  raeburn  17376:     return $output;
                   17377: }
                   17378: 
                   17379: sub captcha_settings {
                   17380:     my %captcha_params = (
                   17381:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   17382:                            www_output_dir => "/captchaspool",
                   17383:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   17384:                            numchars       => '5',
                   17385:                          );
                   17386:     return %captcha_params;
                   17387: }
                   17388: 
                   17389: sub check_captcha {
                   17390:     my ($captcha_chk,$captcha_error);
                   17391:     my $code = $env{'form.code'};
                   17392:     my $md5sum = $env{'form.crypt'};
                   17393:     my %captcha_params = &captcha_settings();
                   17394:     my $captcha = Authen::Captcha->new(
                   17395:                       output_folder => $captcha_params{'output_dir'},
                   17396:                       data_folder   => $captcha_params{'db_dir'},
                   17397:                   );
1.1075.2.26  raeburn  17398:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1075.2.14  raeburn  17399:     my %captcha_hash = (
                   17400:                         0       => 'Code not checked (file error)',
                   17401:                        -1      => 'Failed: code expired',
                   17402:                        -2      => 'Failed: invalid code (not in database)',
                   17403:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   17404:     );
                   17405:     if ($captcha_chk != 1) {
                   17406:         $captcha_error = $captcha_hash{$captcha_chk}
                   17407:     }
                   17408:     return ($captcha_chk,$captcha_error);
                   17409: }
                   17410: 
                   17411: sub create_recaptcha {
1.1075.2.107  raeburn  17412:     my ($pubkey,$version) = @_;
                   17413:     if ($version >= 2) {
1.1075.2.158  raeburn  17414:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
                   17415:                '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1075.2.107  raeburn  17416:     } else {
                   17417:         my $use_ssl;
                   17418:         if ($ENV{'SERVER_PORT'} == 443) {
                   17419:             $use_ssl = 1;
                   17420:         }
                   17421:         my $captcha = Captcha::reCAPTCHA->new;
                   17422:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   17423:                $captcha->get_html($pubkey,undef,$use_ssl).
                   17424:                &mt('If the text is hard to read, [_1] will replace them.',
                   17425:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   17426:                '<br /><br />';
                   17427:      }
1.1075.2.14  raeburn  17428: }
                   17429: 
                   17430: sub check_recaptcha {
1.1075.2.107  raeburn  17431:     my ($privkey,$version) = @_;
1.1075.2.14  raeburn  17432:     my $captcha_chk;
1.1075.2.150  raeburn  17433:     my $ip = &Apache::lonnet::get_requestor_ip(); 
1.1075.2.107  raeburn  17434:     if ($version >= 2) {
                   17435:         my $ua = LWP::UserAgent->new;
                   17436:         $ua->timeout(10);
                   17437:         my %info = (
                   17438:                      secret   => $privkey,
                   17439:                      response => $env{'form.g-recaptcha-response'},
1.1075.2.150  raeburn  17440:                      remoteip => $ip,
1.1075.2.107  raeburn  17441:                    );
                   17442:         my $response = $ua->post('https://www.google.com/recaptcha/api/siteverify',\%info);
                   17443:         if ($response->is_success)  {
                   17444:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   17445:             if (ref($data) eq 'HASH') {
                   17446:                 if ($data->{'success'}) {
                   17447:                     $captcha_chk = 1;
                   17448:                 }
                   17449:             }
                   17450:         }
                   17451:     } else {
                   17452:         my $captcha = Captcha::reCAPTCHA->new;
                   17453:         my $captcha_result =
                   17454:             $captcha->check_answer(
                   17455:                                     $privkey,
1.1075.2.150  raeburn  17456:                                     $ip,
1.1075.2.107  raeburn  17457:                                     $env{'form.recaptcha_challenge_field'},
                   17458:                                     $env{'form.recaptcha_response_field'},
                   17459:                                   );
                   17460:         if ($captcha_result->{is_valid}) {
                   17461:             $captcha_chk = 1;
                   17462:         }
1.1075.2.14  raeburn  17463:     }
                   17464:     return $captcha_chk;
                   17465: }
                   17466: 
1.1075.2.64  raeburn  17467: sub emailusername_info {
1.1075.2.103  raeburn  17468:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1075.2.64  raeburn  17469:     my %titles = &Apache::lonlocal::texthash (
                   17470:                      lastname      => 'Last Name',
                   17471:                      firstname     => 'First Name',
                   17472:                      institution   => 'School/college/university',
                   17473:                      location      => "School's city, state/province, country",
                   17474:                      web           => "School's web address",
                   17475:                      officialemail => 'E-mail address at institution (if different)',
1.1075.2.103  raeburn  17476:                      id            => 'Student/Employee ID',
1.1075.2.64  raeburn  17477:                  );
                   17478:     return (\@fields,\%titles);
                   17479: }
                   17480: 
1.1075.2.56  raeburn  17481: sub cleanup_html {
                   17482:     my ($incoming) = @_;
                   17483:     my $outgoing;
                   17484:     if ($incoming ne '') {
                   17485:         $outgoing = $incoming;
                   17486:         $outgoing =~ s/;/&#059;/g;
                   17487:         $outgoing =~ s/\#/&#035;/g;
                   17488:         $outgoing =~ s/\&/&#038;/g;
                   17489:         $outgoing =~ s/</&#060;/g;
                   17490:         $outgoing =~ s/>/&#062;/g;
                   17491:         $outgoing =~ s/\(/&#040/g;
                   17492:         $outgoing =~ s/\)/&#041;/g;
                   17493:         $outgoing =~ s/"/&#034;/g;
                   17494:         $outgoing =~ s/'/&#039;/g;
                   17495:         $outgoing =~ s/\$/&#036;/g;
                   17496:         $outgoing =~ s{/}{&#047;}g;
                   17497:         $outgoing =~ s/=/&#061;/g;
                   17498:         $outgoing =~ s/\\/&#092;/g
                   17499:     }
                   17500:     return $outgoing;
                   17501: }
                   17502: 
1.1075.2.74  raeburn  17503: # Checks for critical messages and returns a redirect url if one exists.
                   17504: # $interval indicates how often to check for messages.
                   17505: sub critical_redirect {
                   17506:     my ($interval) = @_;
1.1075.2.158  raeburn  17507:     unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   17508:         return ();
                   17509:     }
1.1075.2.74  raeburn  17510:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
                   17511:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'},
                   17512:                                         $env{'user.name'});
                   17513:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
                   17514:         my $redirecturl;
                   17515:         if ($what[0]) {
1.1075.2.158  raeburn  17516:             if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1075.2.74  raeburn  17517:                 $redirecturl='/adm/email?critical=display';
                   17518:                 my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   17519:                 return (1, $url);
                   17520:             }
                   17521:         }
                   17522:     }
                   17523:     return ();
                   17524: }
                   17525: 
1.1075.2.64  raeburn  17526: # Use:
                   17527: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   17528: #
                   17529: ##################################################
                   17530: #          password associated functions         #
                   17531: ##################################################
                   17532: sub des_keys {
                   17533:     # Make a new key for DES encryption.
                   17534:     # Each key has two parts which are returned separately.
                   17535:     # Please note:  Each key must be passed through the &hex function
                   17536:     # before it is output to the web browser.  The hex versions cannot
                   17537:     # be used to decrypt.
                   17538:     my @hexstr=('0','1','2','3','4','5','6','7',
                   17539:                 '8','9','a','b','c','d','e','f');
                   17540:     my $lkey='';
                   17541:     for (0..7) {
                   17542:         $lkey.=$hexstr[rand(15)];
                   17543:     }
                   17544:     my $ukey='';
                   17545:     for (0..7) {
                   17546:         $ukey.=$hexstr[rand(15)];
                   17547:     }
                   17548:     return ($lkey,$ukey);
                   17549: }
                   17550: 
                   17551: sub des_decrypt {
                   17552:     my ($key,$cyphertext) = @_;
                   17553:     my $keybin=pack("H16",$key);
                   17554:     my $cypher;
                   17555:     if ($Crypt::DES::VERSION>=2.03) {
                   17556:         $cypher=new Crypt::DES $keybin;
                   17557:     } else {
                   17558:         $cypher=new DES $keybin;
                   17559:     }
1.1075.2.106  raeburn  17560:     my $plaintext='';
                   17561:     my $cypherlength = length($cyphertext);
                   17562:     my $numchunks = int($cypherlength/32);
                   17563:     for (my $j=0; $j<$numchunks; $j++) {
                   17564:         my $start = $j*32;
                   17565:         my $cypherblock = substr($cyphertext,$start,32);
                   17566:         my $chunk =
                   17567:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   17568:         $chunk .=
                   17569:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   17570:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   17571:         $plaintext .= $chunk;
                   17572:     }
1.1075.2.64  raeburn  17573:     return $plaintext;
                   17574: }
                   17575: 
1.1075.2.135  raeburn  17576: sub is_nonframeable {
                   17577:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   17578:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
                   17579:     return if (($remprotocol eq '') || ($remhost eq ''));
                   17580: 
                   17581:     $remprotocol = lc($remprotocol);
                   17582:     $remhost = lc($remhost);
                   17583:     my $remport = 80;
                   17584:     if ($remprotocol eq 'https') {
                   17585:         $remport = 443;
                   17586:     }
                   17587:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
                   17588:     if ($cached) {
                   17589:         unless ($nocache) {
                   17590:             if ($result) {
                   17591:                 return 1;
                   17592:             } else {
                   17593:                 return 0;
                   17594:             }
                   17595:         }
                   17596:     }
                   17597:     my $uselink;
                   17598:     my $request = new HTTP::Request('HEAD',$url);
1.1075.2.142  raeburn  17599:     my $ua = LWP::UserAgent->new;
                   17600:     $ua->timeout(5);
                   17601:     my $response=$ua->request($request);
1.1075.2.135  raeburn  17602:     if ($response->is_success()) {
                   17603:         my $secpolicy = lc($response->header('content-security-policy'));
                   17604:         my $xframeop = lc($response->header('x-frame-options'));
                   17605:         $secpolicy =~ s/^\s+|\s+$//g;
                   17606:         $xframeop =~ s/^\s+|\s+$//g;
                   17607:         if (($secpolicy ne '') || ($xframeop ne '')) {
                   17608:             my $remotehost = $remprotocol.'://'.$remhost;
                   17609:             my ($origin,$protocol,$port);
                   17610:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   17611:                 $port = $ENV{'SERVER_PORT'};
                   17612:             } else {
                   17613:                 $port = 80;
                   17614:             }
                   17615:             if ($absolute eq '') {
                   17616:                 $protocol = 'http:';
                   17617:                 if ($port == 443) {
                   17618:                     $protocol = 'https:';
                   17619:                 }
                   17620:                 $origin = $protocol.'//'.lc($hostname);
                   17621:             } else {
                   17622:                 $origin = lc($absolute);
                   17623:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   17624:             }
                   17625:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   17626:                 my $framepolicy = $1;
                   17627:                 $framepolicy =~ s/^\s+|\s+$//g;
                   17628:                 my @policies = split(/\s+/,$framepolicy);
                   17629:                 if (@policies) {
                   17630:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   17631:                         $uselink = 1;
                   17632:                     } else {
                   17633:                         $uselink = 1;
                   17634:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   17635:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   17636:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   17637:                             undef($uselink);
                   17638:                         }
                   17639:                         if ($uselink) {
                   17640:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   17641:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   17642:                                     undef($uselink);
                   17643:                                 }
                   17644:                             }
                   17645:                         }
                   17646:                         if ($uselink) {
                   17647:                             my @possok;
                   17648:                             if ($ip ne '') {
                   17649:                                 push(@possok,$ip);
                   17650:                             }
                   17651:                             my $hoststr = '';
                   17652:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   17653:                                 if ($hoststr eq '') {
                   17654:                                     $hoststr = $part;
                   17655:                                 } else {
                   17656:                                     $hoststr = "$part.$hoststr";
                   17657:                                 }
                   17658:                                 if ($hoststr eq $hostname) {
                   17659:                                     push(@possok,$hostname);
                   17660:                                 } else {
                   17661:                                     push(@possok,"*.$hoststr");
                   17662:                                 }
                   17663:                             }
                   17664:                             if (@possok) {
                   17665:                                 foreach my $poss (@possok) {
                   17666:                                     last if (!$uselink);
                   17667:                                     foreach my $policy (@policies) {
                   17668:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   17669:                                             undef($uselink);
                   17670:                                             last;
                   17671:                                         }
                   17672:                                     }
                   17673:                                 }
                   17674:                             }
                   17675:                         }
                   17676:                     }
                   17677:                 }
                   17678:             } elsif ($xframeop ne '') {
                   17679:                 $uselink = 1;
                   17680:                 my @policies = split(/\s*,\s*/,$xframeop);
                   17681:                 if (@policies) {
                   17682:                     unless (grep(/^deny$/,@policies)) {
                   17683:                         if ($origin ne '') {
                   17684:                             if (grep(/^sameorigin$/,@policies)) {
                   17685:                                 if ($remotehost eq $origin) {
                   17686:                                     undef($uselink);
                   17687:                                 }
                   17688:                             }
                   17689:                             if ($uselink) {
                   17690:                                 foreach my $policy (@policies) {
                   17691:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   17692:                                         my $allowfrom = $1;
                   17693:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   17694:                                             undef($uselink);
                   17695:                                             last;
                   17696:                                         }
                   17697:                                     }
                   17698:                                 }
                   17699:                             }
                   17700:                         }
                   17701:                     }
                   17702:                 }
                   17703:             }
                   17704:         }
                   17705:     }
                   17706:     if ($nocache) {
                   17707:         if ($cached) {
                   17708:             my $devalidate;
                   17709:             if ($uselink && !$result) {
                   17710:                 $devalidate = 1;
                   17711:             } elsif (!$uselink && $result) {
                   17712:                 $devalidate = 1;
                   17713:             }
                   17714:             if ($devalidate) {
                   17715:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   17716:             }
                   17717:         }
                   17718:     } else {
                   17719:         if ($uselink) {
                   17720:             $result = 1;
                   17721:         } else {
                   17722:             $result = 0;
                   17723:         }
                   17724:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   17725:     }
                   17726:     return $uselink;
                   17727: }
                   17728: 
1.112     bowersj2 17729: 1;
                   17730: __END__;
1.41      ng       17731: 

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