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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.1426  ! raeburn     4: # $Id: loncommon.pm,v 1.1425 2023/12/31 23:03:40 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.1383    raeburn    64: use Apache::lonnavmaps();
1.139     matthew    65: use HTML::Entities;
1.334     albertel   66: use Apache::lonhtmlcommon();
                     67: use Apache::loncoursedata();
1.344     albertel   68: use Apache::lontexconvert();
1.444     albertel   69: use Apache::lonclonecourse();
1.1108    raeburn    70: use Apache::lonuserutils();
1.1110    raeburn    71: use Apache::lonuserstate();
1.1182    raeburn    72: use Apache::courseclassifier();
1.479     albertel   73: use LONCAPA qw(:DEFAULT :match);
1.1409    raeburn    74: use LONCAPA::ltiutils;
1.1280    raeburn    75: use LONCAPA::LWPReq;
1.1395    raeburn    76: use LONCAPA::map();
1.1328    raeburn    77: use HTTP::Request;
1.657     raeburn    78: use DateTime::TimeZone;
1.1241    raeburn    79: use DateTime::Locale;
1.1220    raeburn    80: use Encode();
1.1091    foxr       81: use Text::Aspell;
1.1094    raeburn    82: use Authen::Captcha;
                     83: use Captcha::reCAPTCHA;
1.1234    raeburn    84: use JSON::DWIW;
1.1174    raeburn    85: use Crypt::DES;
                     86: use DynaLoader; # for Crypt::DES version
1.1223    musolffc   87: use MIME::Lite;
                     88: use MIME::Types;
1.1292    raeburn    89: use File::Copy();
1.1300    raeburn    90: use File::Path();
1.1309    raeburn    91: use String::CRC32();
                     92: use Short::URL();
1.117     www        93: 
1.517     raeburn    94: # ---------------------------------------------- Designs
                     95: use vars qw(%defaultdesign);
                     96: 
1.22      www        97: my $readit;
                     98: 
1.517     raeburn    99: 
1.157     matthew   100: ##
                    101: ## Global Variables
                    102: ##
1.46      matthew   103: 
1.643     foxr      104: 
                    105: # ----------------------------------------------- SSI with retries:
                    106: #
                    107: 
                    108: =pod
                    109: 
1.648     raeburn   110: =head1 Server Side include with retries:
1.643     foxr      111: 
                    112: =over 4
                    113: 
1.648     raeburn   114: =item * &ssi_with_retries(resource,retries form)
1.643     foxr      115: 
                    116: Performs an ssi with some number of retries.  Retries continue either
                    117: until the result is ok or until the retry count supplied by the
                    118: caller is exhausted.  
                    119: 
                    120: Inputs:
1.648     raeburn   121: 
                    122: =over 4
                    123: 
1.643     foxr      124: resource   - Identifies the resource to insert.
1.648     raeburn   125: 
1.643     foxr      126: retries    - Count of the number of retries allowed.
1.648     raeburn   127: 
1.643     foxr      128: form       - Hash that identifies the rendering options.
                    129: 
1.648     raeburn   130: =back
                    131: 
                    132: Returns:
                    133: 
                    134: =over 4
                    135: 
1.643     foxr      136: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   137: 
1.643     foxr      138: response   - The response from the last attempt (which may or may not have been successful.
                    139: 
1.648     raeburn   140: =back
                    141: 
                    142: =back
                    143: 
1.643     foxr      144: =cut
                    145: 
                    146: sub ssi_with_retries {
                    147:     my ($resource, $retries, %form) = @_;
                    148: 
                    149: 
                    150:     my $ok = 0;			# True if we got a good response.
                    151:     my $content;
                    152:     my $response;
                    153: 
                    154:     # Try to get the ssi done. within the retries count:
                    155: 
                    156:     do {
                    157: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    158: 	$ok      = $response->is_success;
1.650     www       159:         if (!$ok) {
                    160:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    161:         }
1.643     foxr      162: 	$retries--;
                    163:     } while (!$ok && ($retries > 0));
                    164: 
                    165:     if (!$ok) {
                    166: 	$content = '';		# On error return an empty content.
                    167:     }
                    168:     return ($content, $response);
                    169: 
                    170: }
                    171: 
                    172: 
                    173: 
1.20      www       174: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  175: my %language;
1.124     www       176: my %supported_language;
1.1088    foxr      177: my %supported_codes;
1.1048    foxr      178: my %latex_language;		# For choosing hyphenation in <transl..>
                    179: my %latex_language_bykey;	# for choosing hyphenation from metadata
1.12      harris41  180: my %cprtag;
1.192     taceyjo1  181: my %scprtag;
1.351     www       182: my %fe; my %fd; my %fm;
1.41      ng        183: my %category_extensions;
1.12      harris41  184: 
1.46      matthew   185: # ---------------------------------------------- Thesaurus variables
1.144     matthew   186: #
                    187: # %Keywords:
                    188: #      A hash used by &keyword to determine if a word is considered a keyword.
                    189: # $thesaurus_db_file 
                    190: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   191: 
                    192: my %Keywords;
                    193: my $thesaurus_db_file;
                    194: 
1.144     matthew   195: #
                    196: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    197: # thesaurus.tab, and filecategories.tab.
                    198: #
1.18      www       199: BEGIN {
1.46      matthew   200:     # Variable initialization
                    201:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    202:     #
1.22      www       203:     unless ($readit) {
1.12      harris41  204: # ------------------------------------------------------------------- languages
                    205:     {
1.158     raeburn   206:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    207:                                    '/language.tab';
1.1317    raeburn   208:         if ( open(my $fh,'<',$langtabfile) ) {
1.356     albertel  209:             while (my $line = <$fh>) {
                    210:                 next if ($line=~/^\#/);
                    211:                 chomp($line);
1.1088    foxr      212:                 my ($key,$code,$country,$three,$enc,$val,$sup,$latex)=(split(/\t/,$line));
1.158     raeburn   213:                 $language{$key}=$val.' - '.$enc;
                    214:                 if ($sup) {
                    215:                     $supported_language{$key}=$sup;
1.1088    foxr      216: 		    $supported_codes{$key}   = $code;
1.158     raeburn   217:                 }
1.1048    foxr      218: 		if ($latex) {
                    219: 		    $latex_language_bykey{$key} = $latex;
1.1088    foxr      220: 		    $latex_language{$code} = $latex;
1.1048    foxr      221: 		}
1.158     raeburn   222:             }
                    223:             close($fh);
                    224:         }
1.12      harris41  225:     }
                    226: # ------------------------------------------------------------------ copyrights
                    227:     {
1.158     raeburn   228:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    229:                                   '/copyright.tab';
1.1317    raeburn   230:         if ( open (my $fh,'<',$copyrightfile) ) {
1.356     albertel  231:             while (my $line = <$fh>) {
                    232:                 next if ($line=~/^\#/);
                    233:                 chomp($line);
                    234:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   235:                 $cprtag{$key}=$val;
                    236:             }
                    237:             close($fh);
                    238:         }
1.12      harris41  239:     }
1.351     www       240: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  241:     {
                    242:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    243:                                   '/source_copyright.tab';
1.1317    raeburn   244:         if ( open (my $fh,'<',$sourcecopyrightfile) ) {
1.356     albertel  245:             while (my $line = <$fh>) {
                    246:                 next if ($line =~ /^\#/);
                    247:                 chomp($line);
                    248:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  249:                 $scprtag{$key}=$val;
                    250:             }
                    251:             close($fh);
                    252:         }
                    253:     }
1.63      www       254: 
1.517     raeburn   255: # -------------------------------------------------------------- default domain designs
1.63      www       256:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   257:     my $designfile = $designdir.'/default.tab';
1.1317    raeburn   258:     if ( open (my $fh,'<',$designfile) ) {
1.517     raeburn   259:         while (my $line = <$fh>) {
                    260:             next if ($line =~ /^\#/);
                    261:             chomp($line);
                    262:             my ($key,$val)=(split(/\=/,$line));
                    263:             if ($val) { $defaultdesign{$key}=$val; }
                    264:         }
                    265:         close($fh);
1.63      www       266:     }
                    267: 
1.15      harris41  268: # ------------------------------------------------------------- file categories
                    269:     {
1.158     raeburn   270:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    271:                                   '/filecategories.tab';
1.1317    raeburn   272:         if ( open (my $fh,'<',$categoryfile) ) {
1.356     albertel  273: 	    while (my $line = <$fh>) {
                    274: 		next if ($line =~ /^\#/);
                    275: 		chomp($line);
                    276:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.1263    raeburn   277:                 push(@{$category_extensions{lc($category)}},$extension);
1.158     raeburn   278:             }
                    279:             close($fh);
                    280:         }
                    281: 
1.15      harris41  282:     }
1.12      harris41  283: # ------------------------------------------------------------------ file types
                    284:     {
1.158     raeburn   285:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    286:                '/filetypes.tab';
1.1317    raeburn   287:         if ( open (my $fh,'<',$typesfile) ) {
1.356     albertel  288:             while (my $line = <$fh>) {
                    289: 		next if ($line =~ /^\#/);
                    290: 		chomp($line);
                    291:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   292:                 if ($descr ne '') {
                    293:                     $fe{$ending}=lc($emb);
                    294:                     $fd{$ending}=$descr;
1.351     www       295:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   296:                 }
                    297:             }
                    298:             close($fh);
                    299:         }
1.12      harris41  300:     }
1.22      www       301:     &Apache::lonnet::logthis(
1.705     tempelho  302:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       303:     $readit=1;
1.46      matthew   304:     }  # end of unless($readit) 
1.32      matthew   305:     
                    306: }
1.112     bowersj2  307: 
1.42      matthew   308: ###############################################################
                    309: ##           HTML and Javascript Helper Functions            ##
                    310: ###############################################################
                    311: 
                    312: =pod 
                    313: 
1.112     bowersj2  314: =head1 HTML and Javascript Functions
1.42      matthew   315: 
1.112     bowersj2  316: =over 4
                    317: 
1.648     raeburn   318: =item * &browser_and_searcher_javascript()
1.112     bowersj2  319: 
                    320: X<browsing, javascript>X<searching, javascript>Returns a string
                    321: containing javascript with two functions, C<openbrowser> and
                    322: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    323: tags.
1.42      matthew   324: 
1.648     raeburn   325: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   326: 
                    327: inputs: formname, elementname, only, omit
                    328: 
                    329: formname and elementname indicate the name of the html form and name of
                    330: the element that the results of the browsing selection are to be placed in. 
                    331: 
                    332: Specifying 'only' will restrict the browser to displaying only files
1.185     www       333: with the given extension.  Can be a comma separated list.
1.42      matthew   334: 
                    335: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       336: with the given extension.  Can be a comma separated list.
1.42      matthew   337: 
1.648     raeburn   338: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   339: 
                    340: Inputs: formname, elementname
                    341: 
                    342: formname and elementname specify the name of the html form and the name
                    343: of the element the selection from the search results will be placed in.
1.542     raeburn   344: 
1.42      matthew   345: =cut
                    346: 
                    347: sub browser_and_searcher_javascript {
1.199     albertel  348:     my ($mode)=@_;
                    349:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  350:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   351:     return <<END;
1.219     albertel  352: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   353:     var editbrowser = null;
1.135     albertel  354:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       355:         var url = '$resurl/?';
1.42      matthew   356:         if (editbrowser == null) {
                    357:             url += 'launch=1&';
                    358:         }
                    359:         url += 'catalogmode=interactive&';
1.199     albertel  360:         url += 'mode=$mode&';
1.611     albertel  361:         url += 'inhibitmenu=yes&';
1.42      matthew   362:         url += 'form=' + formname + '&';
                    363:         if (only != null) {
                    364:             url += 'only=' + only + '&';
1.217     albertel  365:         } else {
                    366:             url += 'only=&';
                    367: 	}
1.42      matthew   368:         if (omit != null) {
                    369:             url += 'omit=' + omit + '&';
1.217     albertel  370:         } else {
                    371:             url += 'omit=&';
                    372: 	}
1.135     albertel  373:         if (titleelement != null) {
                    374:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  375:         } else {
                    376: 	    url += 'titleelement=&';
                    377: 	}
1.42      matthew   378:         url += 'element=' + elementname + '';
                    379:         var title = 'Browser';
1.435     albertel  380:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   381:         options += ',width=700,height=600';
                    382:         editbrowser = open(url,title,options,'1');
                    383:         editbrowser.focus();
                    384:     }
                    385:     var editsearcher;
1.135     albertel  386:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   387:         var url = '/adm/searchcat?';
                    388:         if (editsearcher == null) {
                    389:             url += 'launch=1&';
                    390:         }
                    391:         url += 'catalogmode=interactive&';
1.199     albertel  392:         url += 'mode=$mode&';
1.42      matthew   393:         url += 'form=' + formname + '&';
1.135     albertel  394:         if (titleelement != null) {
                    395:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  396:         } else {
                    397: 	    url += 'titleelement=&';
                    398: 	}
1.42      matthew   399:         url += 'element=' + elementname + '';
                    400:         var title = 'Search';
1.435     albertel  401:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   402:         options += ',width=700,height=600';
                    403:         editsearcher = open(url,title,options,'1');
                    404:         editsearcher.focus();
                    405:     }
1.219     albertel  406: // END LON-CAPA Internal -->
1.42      matthew   407: END
1.170     www       408: }
                    409: 
                    410: sub lastresurl {
1.258     albertel  411:     if ($env{'environment.lastresurl'}) {
                    412: 	return $env{'environment.lastresurl'}
1.170     www       413:     } else {
                    414: 	return '/res';
                    415:     }
                    416: }
                    417: 
                    418: sub storeresurl {
                    419:     my $resurl=&Apache::lonnet::clutter(shift);
                    420:     unless ($resurl=~/^\/res/) { return 0; }
                    421:     $resurl=~s/\/$//;
                    422:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   423:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       424:     return 1;
1.42      matthew   425: }
                    426: 
1.74      www       427: sub studentbrowser_javascript {
1.111     www       428:    unless (
1.258     albertel  429:             (($env{'request.course.id'}) && 
1.302     albertel  430:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    431: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    432: 					  '/'.$env{'request.course.sec'})
                    433: 	      ))
1.258     albertel  434:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       435:           ) { return ''; }  
1.74      www       436:    return (<<'ENDSTDBRW');
1.776     bisitz    437: <script type="text/javascript" language="Javascript">
1.824     bisitz    438: // <![CDATA[
1.74      www       439:     var stdeditbrowser;
1.1413    raeburn   440:     function openstdbrowser(formname,uname,udom,clicker,roleflag,ignorefilter,courseadv,uident) {
1.74      www       441:         var url = '/adm/pickstudent?';
                    442:         var filter;
1.558     albertel  443: 	if (!ignorefilter) {
                    444: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    445: 	}
1.74      www       446:         if (filter != null) {
                    447:            if (filter != '') {
                    448:                url += 'filter='+filter+'&';
                    449: 	   }
                    450:         }
                    451:         url += 'form=' + formname + '&unameelement='+uname+
1.999     www       452:                                     '&udomelement='+udom+
                    453:                                     '&clicker='+clicker;
1.111     www       454: 	if (roleflag) { url+="&roles=1"; }
1.1337    raeburn   455:         if (courseadv == 'condition') {
                    456:             if (document.getElementById('courseadv')) {
                    457:                 courseadv = document.getElementById('courseadv').value;
                    458:             }
                    459:         }
                    460:         if ((courseadv == 'only') || (courseadv == 'none')) { url+="&courseadv="+courseadv; }
1.1413    raeburn   461:         if (uident !== '') { url+="&identelement="+uident; } 
1.102     www       462:         var title = 'Student_Browser';
1.74      www       463:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    464:         options += ',width=700,height=600';
                    465:         stdeditbrowser = open(url,title,options,'1');
                    466:         stdeditbrowser.focus();
                    467:     }
1.824     bisitz    468: // ]]>
1.74      www       469: </script>
                    470: ENDSTDBRW
                    471: }
1.42      matthew   472: 
1.1003    www       473: sub resourcebrowser_javascript {
                    474:    unless ($env{'request.course.id'}) { return ''; }
1.1004    www       475:    return (<<'ENDRESBRW');
1.1003    www       476: <script type="text/javascript" language="Javascript">
                    477: // <![CDATA[
                    478:     var reseditbrowser;
1.1004    www       479:     function openresbrowser(formname,reslink) {
1.1005    www       480:         var url = '/adm/pickresource?form='+formname+'&reslink='+reslink;
1.1003    www       481:         var title = 'Resource_Browser';
                    482:         var options = 'scrollbars=1,resizable=1,menubar=0';
1.1005    www       483:         options += ',width=700,height=500';
1.1004    www       484:         reseditbrowser = open(url,title,options,'1');
                    485:         reseditbrowser.focus();
1.1003    www       486:     }
                    487: // ]]>
                    488: </script>
1.1004    www       489: ENDRESBRW
1.1003    www       490: }
                    491: 
1.74      www       492: sub selectstudent_link {
1.1413    raeburn   493:    my ($form,$unameele,$udomele,$courseadv,$clickerid,$identelem)=@_;
1.999     www       494:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    495:                       &Apache::lonhtmlcommon::entity_encode($unameele)."','".
                    496:                       &Apache::lonhtmlcommon::entity_encode($udomele)."'";
1.258     albertel  497:    if ($env{'request.course.id'}) {  
1.302     albertel  498:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    499: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    500: 					'/'.$env{'request.course.sec'})) {
1.111     www       501: 	   return '';
                    502:        }
1.999     www       503:        $callargs.=",'".&Apache::lonhtmlcommon::entity_encode($clickerid)."'";
1.1337    raeburn   504:        if ($courseadv eq 'only') {
                    505:            $callargs .= ",'',1,'$courseadv'";
                    506:        } elsif ($courseadv eq 'none') {
                    507:            $callargs .= ",'','','$courseadv'";
                    508:        } elsif ($courseadv eq 'condition') {
                    509:            $callargs .= ",'','','$courseadv'";
1.1413    raeburn   510:        } elsif ($identelem ne '') {
                    511:            $callargs .= ",'','',''";
                    512:        }
                    513:        if ($identelem ne '') {
                    514:            $callargs .= ",'".&Apache::lonhtmlcommon::entity_encode($identelem)."'";
1.793     raeburn   515:        }
                    516:        return '<span class="LC_nobreak">'.
                    517:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    518:               &mt('Select User').'</a></span>';
1.74      www       519:    }
1.258     albertel  520:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.1012    www       521:        $callargs .= ",'',1"; 
1.793     raeburn   522:        return '<span class="LC_nobreak">'.
                    523:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    524:               &mt('Select User').'</a></span>';
1.111     www       525:    }
                    526:    return '';
1.91      www       527: }
                    528: 
1.1004    www       529: sub selectresource_link {
                    530:    my ($form,$reslink,$arg)=@_;
                    531:    
                    532:    my $callargs = "'".&Apache::lonhtmlcommon::entity_encode($form)."','".
                    533:                       &Apache::lonhtmlcommon::entity_encode($reslink)."'";
                    534:    unless ($env{'request.course.id'}) { return $arg; }
                    535:    return '<span class="LC_nobreak">'.
                    536:               '<a href="javascript:openresbrowser('.$callargs.');">'.
                    537:               $arg.'</a></span>';
                    538: }
                    539: 
                    540: 
                    541: 
1.653     raeburn   542: sub authorbrowser_javascript {
                    543:     return <<"ENDAUTHORBRW";
1.776     bisitz    544: <script type="text/javascript" language="JavaScript">
1.824     bisitz    545: // <![CDATA[
1.653     raeburn   546: var stdeditbrowser;
                    547: 
                    548: function openauthorbrowser(formname,udom) {
                    549:     var url = '/adm/pickauthor?';
                    550:     url += 'form='+formname+'&roledom='+udom;
                    551:     var title = 'Author_Browser';
                    552:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    553:     options += ',width=700,height=600';
                    554:     stdeditbrowser = open(url,title,options,'1');
                    555:     stdeditbrowser.focus();
                    556: }
                    557: 
1.824     bisitz    558: // ]]>
1.653     raeburn   559: </script>
                    560: ENDAUTHORBRW
                    561: }
                    562: 
1.91      www       563: sub coursebrowser_javascript {
1.1116    raeburn   564:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype,
1.1221    raeburn   565:         $credits_element,$instcode) = @_;
1.932     raeburn   566:     my $wintitle = 'Course_Browser';
1.931     raeburn   567:     if ($crstype eq 'Community') {
1.932     raeburn   568:         $wintitle = 'Community_Browser';
1.909     raeburn   569:     }
1.876     raeburn   570:     my $id_functions = &javascript_index_functions();
                    571:     my $output = '
1.776     bisitz    572: <script type="text/javascript" language="JavaScript">
1.824     bisitz    573: // <![CDATA[
1.468     raeburn   574:     var stdeditbrowser;'."\n";
1.876     raeburn   575: 
                    576:     $output .= <<"ENDSTDBRW";
1.909     raeburn   577:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       578:         var url = '/adm/pickcourse?';
1.895     raeburn   579:         var formid = getFormIdByName(formname);
1.876     raeburn   580:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  581:         if (domainfilter != null) {
                    582:            if (domainfilter != '') {
                    583:                url += 'domainfilter='+domainfilter+'&';
                    584: 	   }
                    585:         }
1.91      www       586:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  587: 	                            '&cdomelement='+udom+
                    588:                                     '&cnameelement='+desc;
1.468     raeburn   589:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   590:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   591:                 url += '&roleelement='+extra_element;
                    592:                 if (domainfilter == null || domainfilter == '') {
                    593:                     url += '&domainfilter='+extra_element;
                    594:                 }
1.234     raeburn   595:             }
1.468     raeburn   596:             else {
                    597:                 if (formname == 'portform') {
                    598:                     url += '&setroles='+extra_element;
1.800     raeburn   599:                 } else {
                    600:                     if (formname == 'rules') {
                    601:                         url += '&fixeddom='+extra_element; 
                    602:                     }
1.468     raeburn   603:                 }
                    604:             }     
1.230     raeburn   605:         }
1.909     raeburn   606:         if (type != null && type != '') {
                    607:             url += '&type='+type;
                    608:         }
                    609:         if (type_elem != null && type_elem != '') {
                    610:             url += '&typeelement='+type_elem;
                    611:         }
1.872     raeburn   612:         if (formname == 'ccrs') {
                    613:             var ownername = document.forms[formid].ccuname.value;
                    614:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
1.1238    raeburn   615:             url += '&cloner='+ownername+':'+ownerdom;
                    616:             if (type == 'Course') {
                    617:                 url += '&crscode='+document.forms[formid].crscode.value;
                    618:             }
1.1221    raeburn   619:         }
                    620:         if (formname == 'requestcrs') {
                    621:             url += '&crsdom=$domainfilter&crscode=$instcode';
1.872     raeburn   622:         }
1.293     raeburn   623:         if (multflag !=null && multflag != '') {
                    624:             url += '&multiple='+multflag;
                    625:         }
1.909     raeburn   626:         var title = '$wintitle';
1.91      www       627:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    628:         options += ',width=700,height=600';
                    629:         stdeditbrowser = open(url,title,options,'1');
                    630:         stdeditbrowser.focus();
                    631:     }
1.876     raeburn   632: $id_functions
                    633: ENDSTDBRW
1.1116    raeburn   634:     if (($sec_element ne '') || ($role_element ne '') || ($credits_element ne '')) {
                    635:         $output .= &setsec_javascript($sec_element,$formname,$role_element,
                    636:                                       $credits_element);
1.876     raeburn   637:     }
                    638:     $output .= '
                    639: // ]]>
                    640: </script>';
                    641:     return $output;
                    642: }
                    643: 
                    644: sub javascript_index_functions {
                    645:     return <<"ENDJS";
                    646: 
                    647: function getFormIdByName(formname) {
                    648:     for (var i=0;i<document.forms.length;i++) {
                    649:         if (document.forms[i].name == formname) {
                    650:             return i;
                    651:         }
                    652:     }
                    653:     return -1;
                    654: }
                    655: 
                    656: function getIndexByName(formid,item) {
                    657:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    658:         if (document.forms[formid].elements[i].name == item) {
                    659:             return i;
                    660:         }
                    661:     }
                    662:     return -1;
                    663: }
1.468     raeburn   664: 
1.876     raeburn   665: function getDomainFromSelectbox(formname,udom) {
                    666:     var userdom;
                    667:     var formid = getFormIdByName(formname);
                    668:     if (formid > -1) {
                    669:         var domid = getIndexByName(formid,udom);
                    670:         if (domid > -1) {
                    671:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    672:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    673:             }
                    674:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    675:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   676:             }
                    677:         }
                    678:     }
1.876     raeburn   679:     return userdom;
                    680: }
                    681: 
                    682: ENDJS
1.468     raeburn   683: 
1.876     raeburn   684: }
                    685: 
1.1017    raeburn   686: sub javascript_array_indexof {
1.1018    raeburn   687:     return <<ENDJS;
1.1017    raeburn   688: <script type="text/javascript" language="JavaScript">
                    689: // <![CDATA[
                    690: 
                    691: if (!Array.prototype.indexOf) {
                    692:     Array.prototype.indexOf = function (searchElement /*, fromIndex */ ) {
                    693:         "use strict";
                    694:         if (this === void 0 || this === null) {
                    695:             throw new TypeError();
                    696:         }
                    697:         var t = Object(this);
                    698:         var len = t.length >>> 0;
                    699:         if (len === 0) {
                    700:             return -1;
                    701:         }
                    702:         var n = 0;
                    703:         if (arguments.length > 0) {
                    704:             n = Number(arguments[1]);
1.1088    foxr      705:             if (n !== n) { // shortcut for verifying if it is NaN
1.1017    raeburn   706:                 n = 0;
                    707:             } else if (n !== 0 && n !== (1 / 0) && n !== -(1 / 0)) {
                    708:                 n = (n > 0 || -1) * Math.floor(Math.abs(n));
                    709:             }
                    710:         }
                    711:         if (n >= len) {
                    712:             return -1;
                    713:         }
                    714:         var k = n >= 0 ? n : Math.max(len - Math.abs(n), 0);
                    715:         for (; k < len; k++) {
                    716:             if (k in t && t[k] === searchElement) {
                    717:                 return k;
                    718:             }
                    719:         }
                    720:         return -1;
                    721:     }
                    722: }
                    723: 
                    724: // ]]>
                    725: </script>
                    726: 
                    727: ENDJS
                    728: 
                    729: }
                    730: 
1.876     raeburn   731: sub userbrowser_javascript {
                    732:     my $id_functions = &javascript_index_functions();
                    733:     return <<"ENDUSERBRW";
                    734: 
1.888     raeburn   735: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   736:     var url = '/adm/pickuser?';
                    737:     var userdom = getDomainFromSelectbox(formname,udom);
                    738:     if (userdom != null) {
                    739:        if (userdom != '') {
                    740:            url += 'srchdom='+userdom+'&';
                    741:        }
                    742:     }
                    743:     url += 'form=' + formname + '&unameelement='+uname+
                    744:                                 '&udomelement='+udom+
                    745:                                 '&ulastelement='+ulast+
                    746:                                 '&ufirstelement='+ufirst+
                    747:                                 '&uemailelement='+uemail+
1.881     raeburn   748:                                 '&hideudomelement='+hideudom+
                    749:                                 '&coursedom='+crsdom;
1.888     raeburn   750:     if ((caller != null) && (caller != undefined)) {
                    751:         url += '&caller='+caller;
                    752:     }
1.876     raeburn   753:     var title = 'User_Browser';
                    754:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    755:     options += ',width=700,height=600';
                    756:     var stdeditbrowser = open(url,title,options,'1');
                    757:     stdeditbrowser.focus();
                    758: }
                    759: 
1.888     raeburn   760: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   761:     var formid = getFormIdByName(formname);
                    762:     if (formid > -1) {
1.888     raeburn   763:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   764:         var domid = getIndexByName(formid,udom);
                    765:         var hidedomid = getIndexByName(formid,origdom);
                    766:         if (hidedomid > -1) {
                    767:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   768:             var unameval = document.forms[formid].elements[unameid].value;
                    769:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    770:                 if (domid > -1) {
                    771:                     var slct = document.forms[formid].elements[domid];
                    772:                     if (slct.type == 'select-one') {
                    773:                         var i;
                    774:                         for (i=0;i<slct.length;i++) {
                    775:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    776:                         }
                    777:                     }
                    778:                     if (slct.type == 'hidden') {
                    779:                         slct.value = fixeddom;
1.876     raeburn   780:                     }
                    781:                 }
1.468     raeburn   782:             }
                    783:         }
                    784:     }
1.876     raeburn   785:     return;
                    786: }
                    787: 
                    788: $id_functions
                    789: ENDUSERBRW
1.468     raeburn   790: }
                    791: 
                    792: sub setsec_javascript {
1.1116    raeburn   793:     my ($sec_element,$formname,$role_element,$credits_element) = @_;
1.905     raeburn   794:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    795:         $communityrolestr);
                    796:     if ($role_element ne '') {
                    797:         my @allroles = ('st','ta','ep','in','ad');
                    798:         foreach my $crstype ('Course','Community') {
                    799:             if ($crstype eq 'Community') {
                    800:                 foreach my $role (@allroles) {
                    801:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    802:                 }
                    803:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    804:             } else {
                    805:                 foreach my $role (@allroles) {
                    806:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    807:                 }
                    808:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    809:             }
                    810:         }
                    811:         $rolestr = '"'.join('","',@allroles).'"';
                    812:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    813:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    814:     }
1.468     raeburn   815:     my $setsections = qq|
                    816: function setSect(sectionlist) {
1.629     raeburn   817:     var sectionsArray = new Array();
                    818:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    819:         sectionsArray = sectionlist.split(",");
                    820:     }
1.468     raeburn   821:     var numSections = sectionsArray.length;
                    822:     document.$formname.$sec_element.length = 0;
                    823:     if (numSections == 0) {
                    824:         document.$formname.$sec_element.multiple=false;
                    825:         document.$formname.$sec_element.size=1;
                    826:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    827:     } else {
                    828:         if (numSections == 1) {
                    829:             document.$formname.$sec_element.multiple=false;
                    830:             document.$formname.$sec_element.size=1;
                    831:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    832:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    833:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    834:         } else {
                    835:             for (var i=0; i<numSections; i++) {
                    836:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    837:             }
                    838:             document.$formname.$sec_element.multiple=true
                    839:             if (numSections < 3) {
                    840:                 document.$formname.$sec_element.size=numSections;
                    841:             } else {
                    842:                 document.$formname.$sec_element.size=3;
                    843:             }
                    844:             document.$formname.$sec_element.options[0].selected = false
                    845:         }
                    846:     }
1.91      www       847: }
1.905     raeburn   848: 
                    849: function setRole(crstype) {
1.468     raeburn   850: |;
1.905     raeburn   851:     if ($role_element eq '') {
                    852:         $setsections .= '    return;
                    853: }
                    854: ';
                    855:     } else {
                    856:         $setsections .= qq|
                    857:     var elementLength = document.$formname.$role_element.length;
                    858:     var allroles = Array($rolestr);
                    859:     var courserolenames = Array($courserolestr);
                    860:     var communityrolenames = Array($communityrolestr);
                    861:     if (elementLength != undefined) {
                    862:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    863:             if (crstype == 'Course') {
                    864:                 return;
                    865:             } else {
                    866:                 allroles[5] = 'co';
                    867:                 for (var i=0; i<6; i++) {
                    868:                     document.$formname.$role_element.options[i].value = allroles[i];
                    869:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    870:                 }
                    871:             }
                    872:         } else {
                    873:             if (crstype == 'Community') {
                    874:                 return;
                    875:             } else {
                    876:                 allroles[5] = 'cc';
                    877:                 for (var i=0; i<6; i++) {
                    878:                     document.$formname.$role_element.options[i].value = allroles[i];
                    879:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    880:                 }
                    881:             }
                    882:         }
                    883:     }
                    884:     return;
                    885: }
                    886: |;
                    887:     }
1.1116    raeburn   888:     if ($credits_element) {
                    889:         $setsections .= qq|
                    890: function setCredits(defaultcredits) {
                    891:     document.$formname.$credits_element.value = defaultcredits;
                    892:     return;
                    893: }
                    894: |;
                    895:     }
1.468     raeburn   896:     return $setsections;
                    897: }
                    898: 
1.91      www       899: sub selectcourse_link {
1.909     raeburn   900:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    901:        $typeelement) = @_;
                    902:    my $type = $selecttype;
1.871     raeburn   903:    my $linktext = &mt('Select Course');
                    904:    if ($selecttype eq 'Community') {
1.909     raeburn   905:        $linktext = &mt('Select Community');
1.1239    raeburn   906:    } elsif ($selecttype eq 'Placement') {
                    907:        $linktext = &mt('Select Placement Test'); 
1.906     raeburn   908:    } elsif ($selecttype eq 'Course/Community') {
                    909:        $linktext = &mt('Select Course/Community');
1.909     raeburn   910:        $type = '';
1.1019    raeburn   911:    } elsif ($selecttype eq 'Select') {
                    912:        $linktext = &mt('Select');
                    913:        $type = '';
1.871     raeburn   914:    }
1.787     bisitz    915:    return '<span class="LC_nobreak">'
                    916:          ."<a href='"
                    917:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    918:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   919:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   920:          ."'>".$linktext.'</a>'
1.787     bisitz    921:          .'</span>';
1.74      www       922: }
1.42      matthew   923: 
1.653     raeburn   924: sub selectauthor_link {
                    925:    my ($form,$udom)=@_;
                    926:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    927:           &mt('Select Author').'</a>';
                    928: }
                    929: 
1.876     raeburn   930: sub selectuser_link {
1.881     raeburn   931:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   932:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   933:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   934:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   935:            ');">'.$linktext.'</a>';
1.876     raeburn   936: }
                    937: 
1.273     raeburn   938: sub check_uncheck_jscript {
                    939:     my $jscript = <<"ENDSCRT";
                    940: function checkAll(field) {
                    941:     if (field.length > 0) {
                    942:         for (i = 0; i < field.length; i++) {
1.1093    raeburn   943:             if (!field[i].disabled) { 
                    944:                 field[i].checked = true;
                    945:             }
1.273     raeburn   946:         }
                    947:     } else {
1.1093    raeburn   948:         if (!field.disabled) { 
                    949:             field.checked = true;
                    950:         }
1.273     raeburn   951:     }
                    952: }
                    953:  
                    954: function uncheckAll(field) {
                    955:     if (field.length > 0) {
                    956:         for (i = 0; i < field.length; i++) {
                    957:             field[i].checked = false ;
1.543     albertel  958:         }
                    959:     } else {
1.273     raeburn   960:         field.checked = false ;
                    961:     }
                    962: }
                    963: ENDSCRT
                    964:     return $jscript;
                    965: }
                    966: 
1.656     www       967: sub select_timezone {
1.1387    raeburn   968:    my ($name,$selected,$onchange,$includeempty,$id,$disabled)=@_;
                    969:    my $output='<select name="'.$name.'" '.$id.$onchange.$disabled.'>'."\n";
1.659     raeburn   970:    if ($includeempty) {
                    971:        $output .= '<option value=""';
                    972:        if (($selected eq '') || ($selected eq 'local')) {
                    973:            $output .= ' selected="selected" ';
                    974:        }
                    975:        $output .= '> </option>';
                    976:    }
1.657     raeburn   977:    my @timezones = DateTime::TimeZone->all_names;
                    978:    foreach my $tzone (@timezones) {
                    979:        $output.= '<option value="'.$tzone.'"';
                    980:        if ($tzone eq $selected) {
                    981:            $output.=' selected="selected"';
                    982:        }
                    983:        $output.=">$tzone</option>\n";
1.656     www       984:    }
                    985:    $output.="</select>";
                    986:    return $output;
                    987: }
1.273     raeburn   988: 
1.687     raeburn   989: sub select_datelocale {
1.1256    raeburn   990:     my ($name,$selected,$onchange,$includeempty,$disabled)=@_;
                    991:     my $output='<select name="'.$name.'" '.$onchange.$disabled.'>'."\n";
1.687     raeburn   992:     if ($includeempty) {
                    993:         $output .= '<option value=""';
                    994:         if ($selected eq '') {
                    995:             $output .= ' selected="selected" ';
                    996:         }
                    997:         $output .= '> </option>';
                    998:     }
1.1241    raeburn   999:     my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn  1000:     my (@possibles,%locale_names);
1.1241    raeburn  1001:     my @locales = DateTime::Locale->ids();
                   1002:     foreach my $id (@locales) {
                   1003:         if ($id ne '') {
                   1004:             my ($en_terr,$native_terr);
                   1005:             my $loc = DateTime::Locale->load($id);
                   1006:             if (ref($loc)) {
                   1007:                 $en_terr = $loc->name();
                   1008:                 $native_terr = $loc->native_name();
1.687     raeburn  1009:                 if (grep(/^en$/,@languages) || !@languages) {
                   1010:                     if ($en_terr ne '') {
                   1011:                         $locale_names{$id} = '('.$en_terr.')';
                   1012:                     } elsif ($native_terr ne '') {
                   1013:                         $locale_names{$id} = $native_terr;
                   1014:                     }
                   1015:                 } else {
                   1016:                     if ($native_terr ne '') {
                   1017:                         $locale_names{$id} = $native_terr.' ';
                   1018:                     } elsif ($en_terr ne '') {
                   1019:                         $locale_names{$id} = '('.$en_terr.')';
                   1020:                     }
                   1021:                 }
1.1220    raeburn  1022:                 $locale_names{$id} = Encode::encode('UTF-8',$locale_names{$id});
1.1241    raeburn  1023:                 push(@possibles,$id);
                   1024:             } 
1.687     raeburn  1025:         }
                   1026:     }
                   1027:     foreach my $item (sort(@possibles)) {
                   1028:         $output.= '<option value="'.$item.'"';
                   1029:         if ($item eq $selected) {
                   1030:             $output.=' selected="selected"';
                   1031:         }
                   1032:         $output.=">$item";
                   1033:         if ($locale_names{$item} ne '') {
1.1220    raeburn  1034:             $output.='  '.$locale_names{$item};
1.687     raeburn  1035:         }
                   1036:         $output.="</option>\n";
                   1037:     }
                   1038:     $output.="</select>";
                   1039:     return $output;
                   1040: }
                   1041: 
1.792     raeburn  1042: sub select_language {
1.1256    raeburn  1043:     my ($name,$selected,$includeempty,$noedit) = @_;
1.792     raeburn  1044:     my %langchoices;
                   1045:     if ($includeempty) {
1.1117    raeburn  1046:         %langchoices = ('' => 'No language preference');
1.792     raeburn  1047:     }
                   1048:     foreach my $id (&languageids()) {
                   1049:         my $code = &supportedlanguagecode($id);
                   1050:         if ($code) {
                   1051:             $langchoices{$code} = &plainlanguagedescription($id);
                   1052:         }
                   1053:     }
1.1117    raeburn  1054:     %langchoices = &Apache::lonlocal::texthash(%langchoices);
1.1256    raeburn  1055:     return &select_form($selected,$name,\%langchoices,undef,$noedit);
1.792     raeburn  1056: }
                   1057: 
1.42      matthew  1058: =pod
1.36      matthew  1059: 
1.1088    foxr     1060: 
                   1061: =item * &list_languages()
                   1062: 
                   1063: Returns an array reference that is suitable for use in language prompters.
                   1064: Each array element is itself a two element array.  The first element
                   1065: is the language code.  The second element a descsriptiuon of the 
                   1066: language itself.  This is suitable for use in e.g.
                   1067: &Apache::edit::select_arg (once dereferenced that is).
                   1068: 
                   1069: =cut 
                   1070: 
                   1071: sub list_languages {
                   1072:     my @lang_choices;
                   1073: 
                   1074:     foreach my $id (&languageids()) {
                   1075: 	my $code = &supportedlanguagecode($id);
                   1076: 	if ($code) {
                   1077: 	    my $selector    = $supported_codes{$id};
                   1078: 	    my $description = &plainlanguagedescription($id);
1.1263    raeburn  1079: 	    push(@lang_choices, [$selector, $description]);
1.1088    foxr     1080: 	}
                   1081:     }
                   1082:     return \@lang_choices;
                   1083: }
                   1084: 
                   1085: =pod
                   1086: 
1.648     raeburn  1087: =item * &linked_select_forms(...)
1.36      matthew  1088: 
                   1089: linked_select_forms returns a string containing a <script></script> block
                   1090: and html for two <select> menus.  The select menus will be linked in that
                   1091: changing the value of the first menu will result in new values being placed
                   1092: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn  1093: order unless a defined order is provided.
1.36      matthew  1094: 
                   1095: linked_select_forms takes the following ordered inputs:
                   1096: 
                   1097: =over 4
                   1098: 
1.112     bowersj2 1099: =item * $formname, the name of the <form> tag
1.36      matthew  1100: 
1.112     bowersj2 1101: =item * $middletext, the text which appears between the <select> tags
1.36      matthew  1102: 
1.112     bowersj2 1103: =item * $firstdefault, the default value for the first menu
1.36      matthew  1104: 
1.112     bowersj2 1105: =item * $firstselectname, the name of the first <select> tag
1.36      matthew  1106: 
1.112     bowersj2 1107: =item * $secondselectname, the name of the second <select> tag
1.36      matthew  1108: 
1.112     bowersj2 1109: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew  1110: 
1.609     raeburn  1111: =item * $menuorder, the order of values in the first menu
                   1112: 
1.1115    raeburn  1113: =item * $onchangefirst, additional javascript call to execute for an onchange
                   1114:         event for the first <select> tag
                   1115: 
                   1116: =item * $onchangesecond, additional javascript call to execute for an onchange
                   1117:         event for the second <select> tag
                   1118: 
1.1245    raeburn  1119: =item * $suffix, to differentiate separate uses of select2data javascript
                   1120:         objects in a page.
                   1121: 
1.41      ng       1122: =back 
                   1123: 
1.36      matthew  1124: Below is an example of such a hash.  Only the 'text', 'default', and 
                   1125: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                   1126: values for the first select menu.  The text that coincides with the 
1.41      ng       1127: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew  1128: and text for the second menu are given in the hash pointed to by 
                   1129: $menu{$choice1}->{'select2'}.  
                   1130: 
1.112     bowersj2 1131:  my %menu = ( A1 => { text =>"Choice A1" ,
                   1132:                        default => "B3",
                   1133:                        select2 => { 
                   1134:                            B1 => "Choice B1",
                   1135:                            B2 => "Choice B2",
                   1136:                            B3 => "Choice B3",
                   1137:                            B4 => "Choice B4"
1.609     raeburn  1138:                            },
                   1139:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2 1140:                    },
                   1141:                A2 => { text =>"Choice A2" ,
                   1142:                        default => "C2",
                   1143:                        select2 => { 
                   1144:                            C1 => "Choice C1",
                   1145:                            C2 => "Choice C2",
                   1146:                            C3 => "Choice C3"
1.609     raeburn  1147:                            },
                   1148:                        order => ['C2','C1','C3'],
1.112     bowersj2 1149:                    },
                   1150:                A3 => { text =>"Choice A3" ,
                   1151:                        default => "D6",
                   1152:                        select2 => { 
                   1153:                            D1 => "Choice D1",
                   1154:                            D2 => "Choice D2",
                   1155:                            D3 => "Choice D3",
                   1156:                            D4 => "Choice D4",
                   1157:                            D5 => "Choice D5",
                   1158:                            D6 => "Choice D6",
                   1159:                            D7 => "Choice D7"
1.609     raeburn  1160:                            },
                   1161:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2 1162:                    }
                   1163:                );
1.36      matthew  1164: 
                   1165: =cut
                   1166: 
                   1167: sub linked_select_forms {
                   1168:     my ($formname,
                   1169:         $middletext,
                   1170:         $firstdefault,
                   1171:         $firstselectname,
                   1172:         $secondselectname, 
1.609     raeburn  1173:         $hashref,
                   1174:         $menuorder,
1.1115    raeburn  1175:         $onchangefirst,
1.1245    raeburn  1176:         $onchangesecond,
                   1177:         $suffix
1.36      matthew  1178:         ) = @_;
                   1179:     my $second = "document.$formname.$secondselectname";
                   1180:     my $first = "document.$formname.$firstselectname";
                   1181:     # output the javascript to do the changing
                   1182:     my $result = '';
1.776     bisitz   1183:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz   1184:     $result.="// <![CDATA[\n";
1.1245    raeburn  1185:     $result.="var select2data${suffix} = new Object();\n";
1.36      matthew  1186:     $" = '","';
                   1187:     my $debug = '';
                   1188:     foreach my $s1 (sort(keys(%$hashref))) {
1.1245    raeburn  1189:         $result.="select2data${suffix}['d_$s1'] = new Object();\n";        
                   1190:         $result.="select2data${suffix}['d_$s1'].def = new String('".
1.36      matthew  1191:             $hashref->{$s1}->{'default'}."');\n";
1.1245    raeburn  1192:         $result.="select2data${suffix}['d_$s1'].values = new Array(";
1.36      matthew  1193:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1194:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1195:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1196:         }
1.36      matthew  1197:         $result.="\"@s2values\");\n";
1.1245    raeburn  1198:         $result.="select2data${suffix}['d_$s1'].texts = new Array(";        
1.36      matthew  1199:         my @s2texts;
                   1200:         foreach my $value (@s2values) {
1.1263    raeburn  1201:             push(@s2texts, $hashref->{$s1}->{'select2'}->{$value});
1.36      matthew  1202:         }
                   1203:         $result.="\"@s2texts\");\n";
                   1204:     }
                   1205:     $"=' ';
                   1206:     $result.= <<"END";
                   1207: 
1.1245    raeburn  1208: function select1${suffix}_changed() {
1.36      matthew  1209:     // Determine new choice
1.1245    raeburn  1210:     var newvalue = "d_" + $first.options[$first.selectedIndex].value;
1.36      matthew  1211:     // update select2
1.1245    raeburn  1212:     var values     = select2data${suffix}[newvalue].values;
                   1213:     var texts      = select2data${suffix}[newvalue].texts;
                   1214:     var select2def = select2data${suffix}[newvalue].def;
1.36      matthew  1215:     var i;
                   1216:     // out with the old
1.1245    raeburn  1217:     $second.options.length = 0;
                   1218:     // in with the new
1.36      matthew  1219:     for (i=0;i<values.length; i++) {
                   1220:         $second.options[i] = new Option(values[i]);
1.143     matthew  1221:         $second.options[i].value = values[i];
1.36      matthew  1222:         $second.options[i].text = texts[i];
                   1223:         if (values[i] == select2def) {
                   1224:             $second.options[i].selected = true;
                   1225:         }
                   1226:     }
                   1227: }
1.824     bisitz   1228: // ]]>
1.36      matthew  1229: </script>
                   1230: END
                   1231:     # output the initial values for the selection lists
1.1245    raeburn  1232:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1${suffix}_changed();$onchangefirst\">\n";
1.609     raeburn  1233:     my @order = sort(keys(%{$hashref}));
                   1234:     if (ref($menuorder) eq 'ARRAY') {
                   1235:         @order = @{$menuorder};
                   1236:     }
                   1237:     foreach my $value (@order) {
1.36      matthew  1238:         $result.="    <option value=\"$value\" ";
1.253     albertel 1239:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1240:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1241:     }
                   1242:     $result .= "</select>\n";
1.1400    raeburn  1243:     my %select2;
                   1244:     if (ref($hashref->{$firstdefault}) eq 'HASH') {
                   1245:         if (ref($hashref->{$firstdefault}->{'select2'}) eq 'HASH') {
                   1246:             %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1247:         }
                   1248:     }
1.36      matthew  1249:     $result .= $middletext;
1.1115    raeburn  1250:     $result .= "<select size=\"1\" name=\"$secondselectname\"";
                   1251:     if ($onchangesecond) {
                   1252:         $result .= ' onchange="'.$onchangesecond.'"';
                   1253:     }
                   1254:     $result .= ">\n";
1.36      matthew  1255:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1256:     
                   1257:     my @secondorder = sort(keys(%select2));
                   1258:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1259:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1260:     }
                   1261:     foreach my $value (@secondorder) {
1.36      matthew  1262:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1263:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1264:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1265:     }
                   1266:     $result .= "</select>\n";
                   1267:     #    return $debug;
                   1268:     return $result;
                   1269: }   #  end of sub linked_select_forms {
                   1270: 
1.45      matthew  1271: =pod
1.44      bowersj2 1272: 
1.1381    raeburn  1273: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid,$links_target)
1.44      bowersj2 1274: 
1.112     bowersj2 1275: Returns a string corresponding to an HTML link to the given help
                   1276: $topic, where $topic corresponds to the name of a .tex file in
                   1277: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1278: spaces. 
                   1279: 
                   1280: $text will optionally be linked to the same topic, allowing you to
                   1281: link text in addition to the graphic. If you do not want to link
                   1282: text, but wish to specify one of the later parameters, pass an
                   1283: empty string. 
                   1284: 
                   1285: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1286: the link will not open a new window. If false, the link will open
                   1287: a new window using Javascript. (Default is false.) 
                   1288: 
                   1289: $width and $height are optional numerical parameters that will
                   1290: override the width and height of the popped up window, which may
1.973     raeburn  1291: be useful for certain help topics with big pictures included.
                   1292: 
                   1293: $imgid is the id of the img tag used for the help icon. This may be
                   1294: used in a javascript call to switch the image src.  See 
                   1295: lonhtmlcommon::htmlareaselectactive() for an example.
1.44      bowersj2 1296: 
1.1381    raeburn  1297: $links_target will optionally be set to a target (_top, _parent or _self).
                   1298: 
1.44      bowersj2 1299: =cut
                   1300: 
                   1301: sub help_open_topic {
1.1381    raeburn  1302:     my ($topic, $text, $stayOnPage, $width, $height, $imgid, $links_target) = @_;
1.48      bowersj2 1303:     $text = "" if (not defined $text);
1.44      bowersj2 1304:     $stayOnPage = 0 if (not defined $stayOnPage);
1.1033    www      1305:     $width = 500 if (not defined $width);
1.44      bowersj2 1306:     $height = 400 if (not defined $height);
                   1307:     my $filename = $topic;
                   1308:     $filename =~ s/ /_/g;
                   1309: 
1.48      bowersj2 1310:     my $template = "";
                   1311:     my $link;
1.572     banghart 1312:     
1.159     www      1313:     $topic=~s/\W/\_/g;
1.44      bowersj2 1314: 
1.572     banghart 1315:     if (!$stayOnPage) {
1.1033    www      1316: 	$link = "javascript:openMyModal('/adm/help/${filename}.hlp',$width,$height,'yes');";
1.1037    www      1317:     } elsif ($stayOnPage eq 'popup') {
                   1318:         $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 1319:     } else {
1.48      bowersj2 1320: 	$link = "/adm/help/${filename}.hlp";
                   1321:     }
                   1322: 
                   1323:     # Add the text
1.1314    raeburn  1324:     my $target = ' target="_top"';
1.1381    raeburn  1325:     if ($links_target) {
                   1326:         $target = ' target="'.$links_target.'"';
                   1327:     } elsif ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
                   1328:              (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
                   1329:         $target = '';
1.1378    raeburn  1330:     }
1.1380    raeburn  1331:     if ($text ne "") {
1.763     bisitz   1332: 	$template.='<span class="LC_help_open_topic">'
1.1314    raeburn  1333:                   .'<a'.$target.' href="'.$link.'">'
1.763     bisitz   1334:                   .$text.'</a>';
1.48      bowersj2 1335:     }
                   1336: 
1.763     bisitz   1337:     # (Always) Add the graphic
1.179     matthew  1338:     my $title = &mt('Online Help');
1.667     raeburn  1339:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.973     raeburn  1340:     if ($imgid ne '') {
                   1341:         $imgid = ' id="'.$imgid.'"';
                   1342:     }
1.1314    raeburn  1343:     $template.=' <a'.$target.' href="'.$link.'" title="'.$title.'">'
1.763     bisitz   1344:               .'<img src="'.$helpicon.'" border="0"'
                   1345:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.973     raeburn  1346:               .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 
1.763     bisitz   1347:               .' /></a>';
                   1348:     if ($text ne "") {	
                   1349:         $template.='</span>';
                   1350:     }
1.44      bowersj2 1351:     return $template;
                   1352: 
1.106     bowersj2 1353: }
                   1354: 
                   1355: # This is a quicky function for Latex cheatsheet editing, since it 
                   1356: # appears in at least four places
                   1357: sub helpLatexCheatsheet {
1.1037    www      1358:     my ($topic,$text,$not_author,$stayOnPage) = @_;
1.732     raeburn  1359:     my $out;
1.106     bowersj2 1360:     my $addOther = '';
1.732     raeburn  1361:     if ($topic) {
1.1037    www      1362: 	$addOther = '<span>'.&help_open_topic($topic,&mt($text),$stayOnPage, undef, 600).'</span> ';
1.763     bisitz   1363:     }
                   1364:     $out = '<span>' # Start cheatsheet
                   1365: 	  .$addOther
                   1366:           .'<span>'
1.1037    www      1367: 	  .&help_open_topic('Greek_Symbols',&mt('Greek Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1368: 	  .'</span> <span>'
1.1037    www      1369: 	  .&help_open_topic('Other_Symbols',&mt('Other Symbols'),$stayOnPage,undef,600)
1.763     bisitz   1370: 	  .'</span>';
1.732     raeburn  1371:     unless ($not_author) {
1.1186    kruse    1372:         $out .= '<span>'
                   1373:                .&help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),$stayOnPage,undef,600)
                   1374:                .'</span> <span>'
1.1424    raeburn  1375:                .&help_open_topic('Authoring_Multilingual_Problems',&mt('Languages'),$stayOnPage,undef,600)
1.763     bisitz   1376: 	       .'</span>';
1.732     raeburn  1377:     }
1.763     bisitz   1378:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1379:     return $out;
1.172     www      1380: }
                   1381: 
1.430     albertel 1382: sub general_help {
                   1383:     my $helptopic='Student_Intro';
                   1384:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1385: 	$helptopic='Authoring_Intro';
1.907     raeburn  1386:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1387: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1388:     } elsif ($env{'request.role'}=~/^dc/) {
                   1389:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1390:     }
                   1391:     return $helptopic;
                   1392: }
                   1393: 
                   1394: sub update_help_link {
                   1395:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1396:     my $origurl = $ENV{'REQUEST_URI'};
                   1397:     $origurl=~s|^/~|/priv/|;
                   1398:     my $timestamp = time;
                   1399:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1400:         $$datum = &escape($$datum);
                   1401:     }
                   1402: 
                   1403:     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";
                   1404:     my $output .= <<"ENDOUTPUT";
                   1405: <script type="text/javascript">
1.824     bisitz   1406: // <![CDATA[
1.430     albertel 1407: banner_link = '$banner_link';
1.824     bisitz   1408: // ]]>
1.430     albertel 1409: </script>
                   1410: ENDOUTPUT
                   1411:     return $output;
                   1412: }
                   1413: 
                   1414: # now just updates the help link and generates a blue icon
1.193     raeburn  1415: sub help_open_menu {
1.1381    raeburn  1416:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text,$links_target) 
1.552     banghart 1417: 	= @_;    
1.949     droeschl 1418:     $stayOnPage = 1;
1.430     albertel 1419:     my $output;
                   1420:     if ($component_help) {
                   1421: 	if (!$text) {
                   1422: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
1.1381    raeburn  1423: 				       $width,$height,'',$links_target);
1.430     albertel 1424: 	} else {
                   1425: 	    my $help_text;
                   1426: 	    $help_text=&unescape($topic);
                   1427: 	    $output='<table><tr><td>'.
                   1428: 		&help_open_topic($component_help,$help_text,$stayOnPage,
1.1381    raeburn  1429: 				 $width,$height,'',$links_target).'</td></tr></table>';
1.430     albertel 1430: 	}
                   1431:     }
                   1432:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1433:     return $output.$banner_link;
                   1434: }
                   1435: 
                   1436: sub top_nav_help {
1.1369    raeburn  1437:     my ($text,$linkattr) = @_;
1.436     albertel 1438:     $text = &mt($text);
1.949     droeschl 1439:     my $stay_on_page = 1;
                   1440: 
1.1168    raeburn  1441:     my ($link,$banner_link);
                   1442:     unless ($env{'request.noversionuri'} =~ m{^/adm/helpmenu}) {
                   1443:         $link = ($stay_on_page) ? "javascript:helpMenu('display')"
                   1444: 	                         : "javascript:helpMenu('open')";
                   1445:         $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
                   1446:     }
1.201     raeburn  1447:     my $title = &mt('Get help');
1.1168    raeburn  1448:     if ($link) {
                   1449:         return <<"END";
1.436     albertel 1450: $banner_link
1.1369    raeburn  1451: <a href="$link" title="$title" $linkattr>$text</a>
1.436     albertel 1452: END
1.1168    raeburn  1453:     } else {
                   1454:         return '&nbsp;'.$text.'&nbsp;';
                   1455:     }
1.436     albertel 1456: }
                   1457: 
                   1458: sub help_menu_js {
1.1154    raeburn  1459:     my ($httphost) = @_;
1.949     droeschl 1460:     my $stayOnPage = 1;
1.436     albertel 1461:     my $width = 620;
                   1462:     my $height = 600;
1.430     albertel 1463:     my $helptopic=&general_help();
1.1154    raeburn  1464:     my $details_link = $httphost.'/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1465:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1466:     my $start_page =
                   1467:         &Apache::loncommon::start_page('Help Menu', undef,
                   1468: 				       {'frameset'    => 1,
                   1469: 					'js_ready'    => 1,
1.1154    raeburn  1470:                                         'use_absolute' => $httphost,
1.331     albertel 1471: 					'add_entries' => {
1.1168    raeburn  1472: 					    'border' => '0', 
1.579     raeburn  1473: 					    'rows'   => "110,*",},});
1.331     albertel 1474:     my $end_page =
                   1475:         &Apache::loncommon::end_page({'frameset' => 1,
                   1476: 				      'js_ready' => 1,});
                   1477: 
1.436     albertel 1478:     my $template .= <<"ENDTEMPLATE";
                   1479: <script type="text/javascript">
1.877     bisitz   1480: // <![CDATA[
1.253     albertel 1481: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1482: var banner_link = '';
1.243     raeburn  1483: function helpMenu(target) {
                   1484:     var caller = this;
                   1485:     if (target == 'open') {
                   1486:         var newWindow = null;
                   1487:         try {
1.262     albertel 1488:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1489:         }
                   1490:         catch(error) {
                   1491:             writeHelp(caller);
                   1492:             return;
                   1493:         }
                   1494:         if (newWindow) {
                   1495:             caller = newWindow;
                   1496:         }
1.193     raeburn  1497:     }
1.243     raeburn  1498:     writeHelp(caller);
                   1499:     return;
                   1500: }
                   1501: function writeHelp(caller) {
1.1168    raeburn  1502:     caller.document.writeln('$start_page\\n<frame name="bannerframe" src="'+banner_link+'" marginwidth="0" marginheight="0" frameborder="0">\\n');
                   1503:     caller.document.writeln('<frame name="bodyframe" src="$details_link" marginwidth="0" marginheight="0" frameborder="0">\\n$end_page');
                   1504:     caller.document.close();
                   1505:     caller.focus();
1.193     raeburn  1506: }
1.877     bisitz   1507: // END LON-CAPA Internal -->
1.253     albertel 1508: // ]]>
1.436     albertel 1509: </script>
1.193     raeburn  1510: ENDTEMPLATE
                   1511:     return $template;
                   1512: }
                   1513: 
1.172     www      1514: sub help_open_bug {
                   1515:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1516:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1517:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1518:     $text = "" if (not defined $text);
                   1519: 	$stayOnPage=1;
1.184     albertel 1520:     $width = 600 if (not defined $width);
                   1521:     $height = 600 if (not defined $height);
1.172     www      1522: 
                   1523:     $topic=~s/\W+/\+/g;
                   1524:     my $link='';
                   1525:     my $template='';
1.379     albertel 1526:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1527: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1528:     if (!$stayOnPage)
                   1529:     {
                   1530: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1531:     }
                   1532:     else
                   1533:     {
                   1534: 	$link = $url;
                   1535:     }
1.1314    raeburn  1536: 
1.1382    raeburn  1537:     my $target = '_top';
                   1538:     if ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
                   1539:         (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
                   1540:         $target = '_blank';
1.1378    raeburn  1541:     }
1.1382    raeburn  1542: 
1.172     www      1543:     # Add the text
                   1544:     if ($text ne "")
                   1545:     {
                   1546: 	$template .= 
                   1547:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.1382    raeburn  1548:   "<td bgcolor='#FF5555'><a target=\"$target\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1549:     }
                   1550: 
                   1551:     # Add the graphic
1.179     matthew  1552:     my $title = &mt('Report a Bug');
1.215     albertel 1553:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1554:     $template .= <<"ENDTEMPLATE";
1.1382    raeburn  1555:  <a target="$target" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1556: ENDTEMPLATE
                   1557:     if ($text ne '') { $template.='</td></tr></table>' };
                   1558:     return $template;
                   1559: 
                   1560: }
                   1561: 
                   1562: sub help_open_faq {
                   1563:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1564:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1565:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1566:     $text = "" if (not defined $text);
                   1567: 	$stayOnPage=1;
                   1568:     $width = 350 if (not defined $width);
                   1569:     $height = 400 if (not defined $height);
                   1570: 
                   1571:     $topic=~s/\W+/\+/g;
                   1572:     my $link='';
                   1573:     my $template='';
                   1574:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1575:     if (!$stayOnPage)
                   1576:     {
                   1577: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1578:     }
                   1579:     else
                   1580:     {
                   1581: 	$link = $url;
                   1582:     }
                   1583: 
                   1584:     # Add the text
                   1585:     if ($text ne "")
                   1586:     {
                   1587: 	$template .= 
1.173     www      1588:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1589:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1590:     }
                   1591: 
                   1592:     # Add the graphic
1.179     matthew  1593:     my $title = &mt('View the FAQ');
1.215     albertel 1594:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1595:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1596:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1597: ENDTEMPLATE
                   1598:     if ($text ne '') { $template.='</td></tr></table>' };
                   1599:     return $template;
                   1600: 
1.44      bowersj2 1601: }
1.37      matthew  1602: 
1.180     matthew  1603: ###############################################################
                   1604: ###############################################################
                   1605: 
1.45      matthew  1606: =pod
                   1607: 
1.648     raeburn  1608: =item * &change_content_javascript():
1.256     matthew  1609: 
                   1610: This and the next function allow you to create small sections of an
                   1611: otherwise static HTML page that you can update on the fly with
                   1612: Javascript, even in Netscape 4.
                   1613: 
                   1614: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1615: must be written to the HTML page once. It will prove the Javascript
                   1616: function "change(name, content)". Calling the change function with the
                   1617: name of the section 
                   1618: you want to update, matching the name passed to C<changable_area>, and
                   1619: the new content you want to put in there, will put the content into
                   1620: that area.
                   1621: 
                   1622: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1623: to contain room for the original contents. You need to "make space"
                   1624: for whatever changes you wish to make, and be B<sure> to check your
                   1625: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1626: it's adequate for updating a one-line status display, but little more.
                   1627: This script will set the space to 100% width, so you only need to
                   1628: worry about height in Netscape 4.
                   1629: 
                   1630: Modern browsers are much less limiting, and if you can commit to the
                   1631: user not using Netscape 4, this feature may be used freely with
                   1632: pretty much any HTML.
                   1633: 
                   1634: =cut
                   1635: 
                   1636: sub change_content_javascript {
                   1637:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1638:     if ($env{'browser.type'} eq 'netscape' &&
                   1639: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1640: 	return (<<NETSCAPE4);
                   1641: 	function change(name, content) {
                   1642: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1643: 	    doc.open();
                   1644: 	    doc.write(content);
                   1645: 	    doc.close();
                   1646: 	}
                   1647: NETSCAPE4
                   1648:     } else {
                   1649: 	# Otherwise, we need to use semi-standards-compliant code
                   1650: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1651: 	# is really scary, and every useful browser supports it
                   1652: 	return (<<DOMBASED);
                   1653: 	function change(name, content) {
                   1654: 	    element = document.getElementById(name);
                   1655: 	    element.innerHTML = content;
                   1656: 	}
                   1657: DOMBASED
                   1658:     }
                   1659: }
                   1660: 
                   1661: =pod
                   1662: 
1.648     raeburn  1663: =item * &changable_area($name,$origContent):
1.256     matthew  1664: 
                   1665: This provides a "changable area" that can be modified on the fly via
                   1666: the Javascript code provided in C<change_content_javascript>. $name is
                   1667: the name you will use to reference the area later; do not repeat the
                   1668: same name on a given HTML page more then once. $origContent is what
                   1669: the area will originally contain, which can be left blank.
                   1670: 
                   1671: =cut
                   1672: 
                   1673: sub changable_area {
                   1674:     my ($name, $origContent) = @_;
                   1675: 
1.258     albertel 1676:     if ($env{'browser.type'} eq 'netscape' &&
                   1677: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1678: 	# If this is netscape 4, we need to use the Layer tag
                   1679: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1680:     } else {
                   1681: 	return "<span id='$name'>$origContent</span>";
                   1682:     }
                   1683: }
                   1684: 
                   1685: =pod
                   1686: 
1.648     raeburn  1687: =item * &viewport_geometry_js 
1.590     raeburn  1688: 
                   1689: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1690: 
                   1691: =cut
                   1692: 
                   1693: 
                   1694: sub viewport_geometry_js { 
                   1695:     return <<"GEOMETRY";
                   1696: var Geometry = {};
                   1697: function init_geometry() {
                   1698:     if (Geometry.init) { return };
                   1699:     Geometry.init=1;
                   1700:     if (window.innerHeight) {
                   1701:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1702:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1703:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1704:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1705:     }
                   1706:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1707:         Geometry.getViewportHeight =
                   1708:             function() { return document.documentElement.clientHeight; };
                   1709:         Geometry.getViewportWidth =
                   1710:             function() { return document.documentElement.clientWidth; };
                   1711: 
                   1712:         Geometry.getHorizontalScroll =
                   1713:             function() { return document.documentElement.scrollLeft; };
                   1714:         Geometry.getVerticalScroll =
                   1715:             function() { return document.documentElement.scrollTop; };
                   1716:     }
                   1717:     else if (document.body.clientHeight) {
                   1718:         Geometry.getViewportHeight =
                   1719:             function() { return document.body.clientHeight; };
                   1720:         Geometry.getViewportWidth =
                   1721:             function() { return document.body.clientWidth; };
                   1722:         Geometry.getHorizontalScroll =
                   1723:             function() { return document.body.scrollLeft; };
                   1724:         Geometry.getVerticalScroll =
                   1725:             function() { return document.body.scrollTop; };
                   1726:     }
                   1727: }
                   1728: 
                   1729: GEOMETRY
                   1730: }
                   1731: 
                   1732: =pod
                   1733: 
1.648     raeburn  1734: =item * &viewport_size_js()
1.590     raeburn  1735: 
                   1736: 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. 
                   1737: 
                   1738: =cut
                   1739: 
                   1740: sub viewport_size_js {
                   1741:     my $geometry = &viewport_geometry_js();
                   1742:     return <<"DIMS";
                   1743: 
                   1744: $geometry
                   1745: 
                   1746: function getViewportDims(width,height) {
                   1747:     init_geometry();
                   1748:     width.value = Geometry.getViewportWidth();
                   1749:     height.value = Geometry.getViewportHeight();
                   1750:     return;
                   1751: }
                   1752: 
                   1753: DIMS
                   1754: }
                   1755: 
                   1756: =pod
                   1757: 
1.648     raeburn  1758: =item * &resize_textarea_js()
1.565     albertel 1759: 
                   1760: emits the needed javascript to resize a textarea to be as big as possible
                   1761: 
                   1762: creates a function resize_textrea that takes two IDs first should be
                   1763: the id of the element to resize, second should be the id of a div that
                   1764: surrounds everything that comes after the textarea, this routine needs
                   1765: to be attached to the <body> for the onload and onresize events.
                   1766: 
                   1767: =cut
                   1768: 
                   1769: sub resize_textarea_js {
1.590     raeburn  1770:     my $geometry = &viewport_geometry_js();
1.565     albertel 1771:     return <<"RESIZE";
                   1772:     <script type="text/javascript">
1.824     bisitz   1773: // <![CDATA[
1.590     raeburn  1774: $geometry
1.565     albertel 1775: 
1.588     albertel 1776: function getX(element) {
                   1777:     var x = 0;
                   1778:     while (element) {
                   1779: 	x += element.offsetLeft;
                   1780: 	element = element.offsetParent;
                   1781:     }
                   1782:     return x;
                   1783: }
                   1784: function getY(element) {
                   1785:     var y = 0;
                   1786:     while (element) {
                   1787: 	y += element.offsetTop;
                   1788: 	element = element.offsetParent;
                   1789:     }
                   1790:     return y;
                   1791: }
                   1792: 
                   1793: 
1.565     albertel 1794: function resize_textarea(textarea_id,bottom_id) {
                   1795:     init_geometry();
                   1796:     var textarea        = document.getElementById(textarea_id);
                   1797:     //alert(textarea);
                   1798: 
1.588     albertel 1799:     var textarea_top    = getY(textarea);
1.565     albertel 1800:     var textarea_height = textarea.offsetHeight;
                   1801:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1802:     var bottom_top      = getY(bottom);
1.565     albertel 1803:     var bottom_height   = bottom.offsetHeight;
                   1804:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1805:     var fudge           = 23;
1.565     albertel 1806:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1807:     if (new_height < 300) {
                   1808: 	new_height = 300;
                   1809:     }
                   1810:     textarea.style.height=new_height+'px';
                   1811: }
1.824     bisitz   1812: // ]]>
1.565     albertel 1813: </script>
                   1814: RESIZE
                   1815: 
                   1816: }
                   1817: 
1.1205    golterma 1818: sub colorfuleditor_js {
1.1248    raeburn  1819:     my $browse_or_search;
                   1820:     my $respath;
                   1821:     my ($cnum,$cdom) = &crsauthor_url();
                   1822:     if ($cnum) {
                   1823:         $respath = "/res/$cdom/$cnum/";
                   1824:         my %js_lt = &Apache::lonlocal::texthash(
                   1825:             sunm => 'Sub-directory name',
                   1826:             save => 'Save page to make this permanent',
                   1827:         );
                   1828:         &js_escape(\%js_lt);
1.1400    raeburn  1829:         my $showfile_js = &show_crsfiles_js();
1.1248    raeburn  1830:         $browse_or_search = <<"END";
                   1831: 
1.1400    raeburn  1832:     $showfile_js
                   1833: 
1.1248    raeburn  1834:     function toggleChooser(form,element,titleid,only,search) {
                   1835:         var disp = 'none';
                   1836:         if (document.getElementById('chooser_'+element)) {
                   1837:             var curr = document.getElementById('chooser_'+element).style.display;
                   1838:             if (curr == 'none') {
                   1839:                 disp='inline';
                   1840:                 if (form.elements['chooser_'+element].length) {
                   1841:                     for (var i=0; i<form.elements['chooser_'+element].length; i++) {
                   1842:                         form.elements['chooser_'+element][i].checked = false;
                   1843:                     }
                   1844:                 }
                   1845:                 toggleResImport(form,element);
                   1846:             }
                   1847:             document.getElementById('chooser_'+element).style.display = disp;
1.1400    raeburn  1848:             var dirsel = '';
                   1849:             var filesel = '';
                   1850:             if (document.getElementById('chooser_'+element+'_crsres')) {
                   1851:                 var currcrsres = document.getElementById('chooser_'+element+'_crsres').style.display;
                   1852:                 if (currcrsres == 'none') {
                   1853:                     dirsel = 'coursepath_'+element;
                   1854:                     var filesel = 'coursefile_'+element;
                   1855:                     var include;
                   1856:                     if (document.getElementById('crsres_include_'+element)) {
                   1857:                         include = document.getElementById('crsres_include_'+element).value;
                   1858:                     }
1.1402    raeburn  1859:                     populateCrsSelects(form,dirsel,filesel,1,include,1,0,1,1,0);
1.1400    raeburn  1860:                 }
                   1861:             }
                   1862:             if (document.getElementById('chooser_'+element+'_upload')) {
                   1863:                 var currcrsupload = document.getElementById('chooser_'+element+'_upload').style.display;
                   1864:                 if (currcrsupload == 'none') {
                   1865:                     dirsel = 'crsauthorpath_'+element;
                   1866:                     filesel = '';
1.1402    raeburn  1867:                     populateCrsSelects(form,dirsel,filesel,0,'',1,0,1,0,1);
1.1400    raeburn  1868:                 }
                   1869:             }
1.1248    raeburn  1870:         }
                   1871:     }
                   1872: 
1.1400    raeburn  1873:     function toggleCrsFile(form,element) {
1.1248    raeburn  1874:         if (document.getElementById('chooser_'+element+'_crsres')) {
                   1875:             var curr = document.getElementById('chooser_'+element+'_crsres').style.display;
                   1876:             if (curr == 'none') {
1.1400    raeburn  1877:                 if (document.getElementById('coursepath_'+element)) {
                   1878:                     var numdirs;
                   1879:                     if (document.getElementById('coursepath_'+element).length) {
                   1880:                         numdirs = document.getElementById('coursepath_'+element).length;
                   1881:                     }
1.1402    raeburn  1882:                     if ((document.getElementById('hascrsres_'+element)) &&
                   1883:                         (document.getElementById('nocrsres_'+element))) {
                   1884:                         if (numdirs) {
                   1885:                             document.getElementById('hascrsres_'+element).style.display='inline-block';
                   1886:                             document.getElementById('nocrsres_'+element).style.display='none';
                   1887:                         } else {
                   1888:                             document.getElementById('hascrsres_'+element).style.display='none';
                   1889:                             document.getElementById('nocrsres_'+element).style.display='inline-block';
                   1890:                         }
                   1891:                     }
1.1248    raeburn  1892:                     form.elements['coursepath_'+element].selectedIndex = 0;
                   1893:                     if (numdirs > 1) {
1.1400    raeburn  1894:                         var selelem = form.elements['coursefile_'+element];
                   1895:                         var i, len = selelem.options.length -1;
                   1896:                         if (len >=0) {
                   1897:                             for (i = len; i >= 0; i--) {
                   1898:                                 selelem.remove(i);
                   1899:                             }
                   1900:                             selelem.options[0] = new Option('','');
                   1901:                         }
1.1248    raeburn  1902:                     }
                   1903:                 }
1.1400    raeburn  1904:             }
1.1248    raeburn  1905:             document.getElementById('chooser_'+element+'_crsres').style.display = 'block';
                   1906:         }
                   1907:         if (document.getElementById('chooser_'+element+'_upload')) {
                   1908:             document.getElementById('chooser_'+element+'_upload').style.display = 'none';
                   1909:             if (document.getElementById('uploadcrsres_'+element)) {
                   1910:                 document.getElementById('uploadcrsres_'+element).value = '';
                   1911:             }
                   1912:         }
                   1913:         return;
                   1914:     }
                   1915: 
1.1400    raeburn  1916:     function toggleCrsUpload(form,element) {
1.1248    raeburn  1917:         if (document.getElementById('chooser_'+element+'_crsres')) {
                   1918:             document.getElementById('chooser_'+element+'_crsres').style.display = 'none';
                   1919:         }
                   1920:         if (document.getElementById('chooser_'+element+'_upload')) {
                   1921:             var curr = document.getElementById('chooser_'+element+'_upload').style.display;
                   1922:             if (curr == 'none') {
1.1400    raeburn  1923:                 form.elements['newsubdir_'+element][0].checked = true;
                   1924:                 toggleNewsubdir(form,element);
                   1925:                 document.getElementById('chooser_'+element+'_upload').style.display = 'block';
                   1926:                 if (document.getElementById('uploadcrsres_'+element)) {
                   1927:                     document.getElementById('uploadcrsres_'+element).value = '';
1.1248    raeburn  1928:                 }
                   1929:             }
                   1930:         }
                   1931:         return;
                   1932:     }
                   1933: 
                   1934:     function toggleResImport(form,element) {
                   1935:         var choices = new Array('crsres','upload');
                   1936:         for (var i=0; i<choices.length; i++) {
                   1937:             if (document.getElementById('chooser_'+element+'_'+choices[i])) {
                   1938:                 document.getElementById('chooser_'+element+'_'+choices[i]).style.display = 'none';
                   1939:             }
                   1940:         }
                   1941:     }
                   1942: 
                   1943:     function toggleNewsubdir(form,element) {
                   1944:         var newsub = form.elements['newsubdir_'+element];
                   1945:         if (newsub) {
                   1946:             if (newsub.length) {
                   1947:                 for (var j=0; j<newsub.length; j++) {
                   1948:                     if (newsub[j].checked) {
                   1949:                         if (document.getElementById('newsubdirname_'+element)) {
                   1950:                             if (newsub[j].value == '1') {
                   1951:                                 document.getElementById('newsubdirname_'+element).type = "text";
                   1952:                                 if (document.getElementById('newsubdir_'+element)) {
                   1953:                                     document.getElementById('newsubdir_'+element).innerHTML = '<br />$js_lt{sunm}';
                   1954:                                 }
                   1955:                             } else {
                   1956:                                 document.getElementById('newsubdirname_'+element).type = "hidden";
                   1957:                                 document.getElementById('newsubdirname_'+element).value = "";
                   1958:                                 document.getElementById('newsubdir_'+element).innerHTML = "";
                   1959:                             }
                   1960:                         }
                   1961:                         break; 
                   1962:                     }
                   1963:                 }
                   1964:             }
                   1965:         }
                   1966:     }
                   1967: 
                   1968:     function updateCrsFile(form,element) {
                   1969:         var directory = form.elements['coursepath_'+element];
                   1970:         var filename = form.elements['coursefile_'+element];
                   1971:         var path = directory.options[directory.selectedIndex].value;
                   1972:         var file = filename.options[filename.selectedIndex].value;
1.1400    raeburn  1973:         if (file != '') {
                   1974:             form.elements[element].value = '$respath';
                   1975:             if (path == '/') {
                   1976:                 form.elements[element].value += file;
                   1977:             } else {
                   1978:                 form.elements[element].value += path+'/'+file;
                   1979:             }
                   1980:             unClean();
                   1981:             if (document.getElementById('previewimg_'+element)) {
                   1982:                 document.getElementById('previewimg_'+element).src = form.elements[element].value;
                   1983:                 var newsrc = document.getElementById('previewimg_'+element).src; 
                   1984:             }
                   1985:             if (document.getElementById('showimg_'+element)) {
                   1986:                 document.getElementById('showimg_'+element).innerHTML = '($js_lt{save})';
                   1987:             }
1.1248    raeburn  1988:         }
                   1989:         toggleChooser(form,element);
                   1990:         return;
                   1991:     }
                   1992: 
                   1993:     function uploadDone(suffix,name) {
                   1994:         if (name) {
                   1995: 	    document.forms["lonhomework"].elements[suffix].value = name;
                   1996:             unClean();
                   1997:             toggleChooser(document.forms["lonhomework"],suffix);
                   1998:         }
                   1999:     }
                   2000: 
                   2001: \$(document).ready(function(){
                   2002: 
                   2003:     \$(document).delegate('form :submit', 'click', function( event ) {
                   2004:         if ( \$( this ).hasClass( "LC_uploadcrsres" ) ) {
                   2005:             var buttonId = this.id;
                   2006:             var suffix = buttonId.toString();
                   2007:             suffix = suffix.replace(/^crsupload_/,'');
                   2008:             event.preventDefault();
                   2009:             document.lonhomework.target = 'crsupload_target_'+suffix;
                   2010:             document.lonhomework.action = '/adm/coursepub?LC_uploadcrsres='+suffix;
                   2011:             \$(this.form).submit();
                   2012:             document.lonhomework.target = '';
                   2013:             if (document.getElementById('crsuploadto_'+suffix)) {
                   2014:                 document.lonhomework.action = document.getElementById('crsuploadto_'+suffix).value;
                   2015:             }
                   2016:             return false;
                   2017:         }
                   2018:     });
                   2019: });
                   2020: END
                   2021:     }
1.1205    golterma 2022:     return <<"COLORFULEDIT"
                   2023: <script type="text/javascript">
                   2024: // <![CDATA[>
                   2025:     function fold_box(curDepth, lastresource){
                   2026: 
                   2027:     // we need a list because there can be several blocks you need to fold in one tag
                   2028:         var block = document.getElementsByName('foldblock_'+curDepth);
                   2029:     // but there is only one folding button per tag
                   2030:         var foldbutton = document.getElementById('folding_btn_'+curDepth);
                   2031: 
                   2032:         if(block.item(0).style.display == 'none'){
                   2033: 
                   2034:             foldbutton.value = '@{[&mt("Hide")]}';
                   2035:             for (i = 0; i < block.length; i++){
                   2036:                 block.item(i).style.display = '';
                   2037:             }
                   2038:         }else{
                   2039: 
                   2040:             foldbutton.value = '@{[&mt("Show")]}';
                   2041:             for (i = 0; i < block.length; i++){
                   2042:                 // block.item(i).style.visibility = 'collapse';
                   2043:                 block.item(i).style.display = 'none';
                   2044:             }
                   2045:         };
                   2046:         saveState(lastresource);
                   2047:     }
                   2048: 
                   2049:     function saveState (lastresource) {
                   2050: 
                   2051:         var tag_list = getTagList();
                   2052:         if(tag_list != null){
                   2053:             var timestamp = new Date().getTime();
                   2054:             var key = lastresource;
                   2055: 
                   2056:             // the value pattern is: 'time;key1,value1;key2,value2; ... '
                   2057:             // starting with timestamp
                   2058:             var value = timestamp+';';
                   2059: 
                   2060:             // building the list of key-value pairs
                   2061:             for(var i = 0; i < tag_list.length; i++){
                   2062:                 value += tag_list[i]+',';
                   2063:                 value += document.getElementsByName(tag_list[i])[0].style.display+';';
                   2064:             }
                   2065: 
                   2066:             // only iterate whole storage if nothing to override
                   2067:             if(localStorage.getItem(key) == null){        
                   2068: 
                   2069:                 // prevent storage from growing large
                   2070:                 if(localStorage.length > 50){
                   2071:                     var regex_getTimestamp = /^(?:\d)+;/;
                   2072:                     var oldest_timestamp = regex_getTimestamp.exec(localStorage.key(0));
                   2073:                     var oldest_key;
                   2074:                     
                   2075:                     for(var i = 1; i < localStorage.length; i++){
                   2076:                         if (regex_getTimestamp.exec(localStorage.key(i)) < oldest_timestamp) {
                   2077:                             oldest_key = localStorage.key(i);
                   2078:                             oldest_timestamp = regex_getTimestamp.exec(oldest_key);
                   2079:                         }
                   2080:                     }
                   2081:                     localStorage.removeItem(oldest_key);
                   2082:                 }
                   2083:             }
                   2084:             localStorage.setItem(key,value);
                   2085:         }
                   2086:     }
                   2087: 
                   2088:     // restore folding status of blocks (on page load)
                   2089:     function restoreState (lastresource) {
                   2090:         if(localStorage.getItem(lastresource) != null){
                   2091:             var key = lastresource;
                   2092:             var value = localStorage.getItem(key);
                   2093:             var regex_delTimestamp = /^\d+;/;
                   2094: 
                   2095:             value.replace(regex_delTimestamp, '');
                   2096: 
                   2097:             var valueArr = value.split(';');
                   2098:             var pairs;
                   2099:             var elements;
                   2100:             for (var i = 0; i < valueArr.length; i++){
                   2101:                 pairs = valueArr[i].split(',');
                   2102:                 elements = document.getElementsByName(pairs[0]);
                   2103: 
                   2104:                 for (var j = 0; j < elements.length; j++){  
                   2105:                     elements[j].style.display = pairs[1];
                   2106:                     if (pairs[1] == "none"){
                   2107:                         var regex_id = /([_\\d]+)\$/;
                   2108:                         regex_id.exec(pairs[0]);
                   2109:                         document.getElementById("folding_btn"+RegExp.\$1).value = "Show";
                   2110:                     }
                   2111:                 }
                   2112:             }
                   2113:         }
                   2114:     }
                   2115: 
                   2116:     function getTagList () {
                   2117:         
                   2118:         var stringToSearch = document.lonhomework.innerHTML;
                   2119: 
                   2120:         var ret = new Array();
                   2121:         var regex_findBlock = /(foldblock_.*?)"/g;
                   2122:         var tag_list = stringToSearch.match(regex_findBlock);
                   2123: 
                   2124:         if(tag_list != null){
                   2125:             for(var i = 0; i < tag_list.length; i++){            
                   2126:                 ret.push(tag_list[i].replace(/"/, ''));
                   2127:             }
                   2128:         }
                   2129:         return ret;
                   2130:     }
                   2131: 
                   2132:     function saveScrollPosition (resource) {
                   2133:         var tag_list = getTagList();
                   2134: 
                   2135:         // we dont always want to jump to the first block
                   2136:         // 170 is roughly above the "Problem Editing" header. we just want to save if the user scrolled down further than this
                   2137:         if(\$(window).scrollTop() > 170){
                   2138:             if(tag_list != null){
                   2139:                 var result;
                   2140:                 for(var i = 0; i < tag_list.length; i++){
                   2141:                     if(isElementInViewport(tag_list[i])){
                   2142:                         result += tag_list[i]+';';
                   2143:                     }
                   2144:                 }
                   2145:                 sessionStorage.setItem('anchor_'+resource, result);
                   2146:             }
                   2147:         } else {
                   2148:             // we dont need to save zero, just delete the item to leave everything tidy
                   2149:             sessionStorage.removeItem('anchor_'+resource);
                   2150:         }
                   2151:     }
                   2152: 
                   2153:     function restoreScrollPosition(resource){
                   2154: 
                   2155:         var elem = sessionStorage.getItem('anchor_'+resource);
                   2156:         if(elem != null){
                   2157:             var tag_list = elem.split(';');
                   2158:             var elem_list;
                   2159: 
                   2160:             for(var i = 0; i < tag_list.length; i++){
                   2161:                 elem_list = document.getElementsByName(tag_list[i]);
                   2162:                 
                   2163:                 if(elem_list.length > 0){
                   2164:                     elem = elem_list[0];
                   2165:                     break;
                   2166:                 }
                   2167:             }
                   2168:             elem.scrollIntoView();
                   2169:         }
                   2170:     }
                   2171: 
                   2172:     function isElementInViewport(el) {
                   2173: 
                   2174:         // change to last element instead of first
                   2175:         var elem = document.getElementsByName(el);
                   2176:         var rect = elem[0].getBoundingClientRect();
                   2177: 
                   2178:         return (
                   2179:             rect.top >= 0 &&
                   2180:             rect.left >= 0 &&
                   2181:             rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && /*or $(window).height() */
                   2182:             rect.right <= (window.innerWidth || document.documentElement.clientWidth) /*or $(window).width() */
                   2183:         );
                   2184:     }
                   2185:     
                   2186:     function autosize(depth){
                   2187:         var cmInst = window['cm'+depth];
                   2188:         var fitsizeButton = document.getElementById('fitsize'+depth);
                   2189: 
                   2190:         // is fixed size, switching to dynamic
                   2191:         if (sessionStorage.getItem("autosized_"+depth) == null) {
                   2192:             cmInst.setSize("","auto");
                   2193:             fitsizeButton.value = "@{[&mt('Fixed size')]}";
                   2194:             sessionStorage.setItem("autosized_"+depth, "yes");
                   2195: 
                   2196:         // is dynamic size, switching to fixed
                   2197:         } else {
                   2198:             cmInst.setSize("","300px");
                   2199:             fitsizeButton.value = "@{[&mt('Dynamic size')]}";
                   2200:             sessionStorage.removeItem("autosized_"+depth);
                   2201:         }
                   2202:     }
                   2203: 
1.1248    raeburn  2204: $browse_or_search
1.1205    golterma 2205: 
                   2206: // ]]>
                   2207: </script>
                   2208: COLORFULEDIT
                   2209: }
                   2210: 
                   2211: sub xmleditor_js {
                   2212:     return <<XMLEDIT
                   2213: <script type="text/javascript" src="/adm/jQuery/addons/jquery-scrolltofixed.js"></script>
                   2214: <script type="text/javascript">
                   2215: // <![CDATA[>
                   2216: 
                   2217:     function saveScrollPosition (resource) {
                   2218: 
                   2219:         var scrollPos = \$(window).scrollTop();
                   2220:         sessionStorage.setItem(resource,scrollPos);
                   2221:     }
                   2222: 
                   2223:     function restoreScrollPosition(resource){
                   2224: 
                   2225:         var scrollPos = sessionStorage.getItem(resource);
                   2226:         \$(window).scrollTop(scrollPos);
                   2227:     }
                   2228: 
                   2229:     // unless internet explorer
                   2230:     if (!(window.navigator.appName == "Microsoft Internet Explorer" && (document.documentMode || document.compatMode))){
                   2231: 
                   2232:         \$(document).ready(function() {
                   2233:              \$(".LC_edit_actionbar").scrollToFixed(\{zIndex: 100\});
                   2234:         });
                   2235:     }
                   2236: 
                   2237:     // inserts text at cursor position into codemirror (xml editor only)
                   2238:     function insertText(text){
                   2239:         cm.focus();
                   2240:         var curPos = cm.getCursor();
                   2241:         cm.replaceRange(text.replace(/ESCAPEDSCRIPT/g,'script'), {line: curPos.line,ch: curPos.ch});
                   2242:     }
                   2243: // ]]>
                   2244: </script>
                   2245: XMLEDIT
                   2246: }
                   2247: 
                   2248: sub insert_folding_button {
                   2249:     my $curDepth = $Apache::lonxml::curdepth;
                   2250:     my $lastresource = $env{'request.ambiguous'};
                   2251: 
                   2252:     return "<input type=\"button\" id=\"folding_btn_$curDepth\" 
                   2253:             value=\"".&mt('Hide')."\" onclick=\"fold_box('$curDepth','$lastresource')\">";
                   2254: }
                   2255: 
1.1248    raeburn  2256: sub crsauthor_url {
                   2257:     my ($url) = @_;
                   2258:     if ($url eq '') {
                   2259:         $url = $ENV{'REQUEST_URI'};
                   2260:     }
                   2261:     my ($cnum,$cdom);
                   2262:     if ($env{'request.course.id'}) {
                   2263:         my ($audom,$auname) = ($url =~ m{^/priv/($match_domain)/($match_name)/});
                   2264:         if ($audom ne '' && $auname ne '') {
                   2265:             if (($env{'course.'.$env{'request.course.id'}.'.num'} eq $auname) &&
                   2266:                 ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $audom)) {
                   2267:                 $cnum = $auname;
                   2268:                 $cdom = $audom;
                   2269:             }
                   2270:         }
                   2271:     }
                   2272:     return ($cnum,$cdom);
                   2273: }
                   2274: 
                   2275: sub import_crsauthor_form {
1.1400    raeburn  2276:     my ($firstselectname,$secondselectname,$onchangefirst,$only,$suffix,$disabled) = @_;
1.1248    raeburn  2277:     return (0) unless ($env{'request.course.id'});
                   2278:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   2279:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   2280:     my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
                   2281:     return (0) unless (($cnum ne '') && ($cdom ne ''));
                   2282:     my @ids=&Apache::lonnet::current_machine_ids();
1.1400    raeburn  2283:     my ($output,$is_home,$toppath,%subdirs,%files,%selimport_menus,$include,$exclude);
1.1402    raeburn  2284: 
1.1248    raeburn  2285:     if (grep(/^\Q$crshome\E$/,@ids)) {
                   2286:         $is_home = 1;
                   2287:     }
1.1400    raeburn  2288:     $toppath = "/priv/$cdom/$cnum";
                   2289:     my $nonemptydir = 1;
                   2290:     my $js_only;
                   2291:     if ($only) {
                   2292:         map { $include->{$_} = 1; } split(/\s*,\s*/,$only);
                   2293:         $js_only = join(',',map { &js_escape($_); } sort(keys(%{$include})));
                   2294:     }
                   2295:     $exclude = &Apache::lonnet::priv_exclude();
1.1402    raeburn  2296:     &Apache::lonnet::recursedirs($is_home,1,$include,$exclude,1,0,$toppath,'',\%subdirs,\%files);
1.1400    raeburn  2297:     my $numdirs = scalar(keys(%files));
1.1248    raeburn  2298:     my %lt = &Apache::lonlocal::texthash (
                   2299:         fnam => 'Filename',
                   2300:         dire => 'Directory',
1.1400    raeburn  2301:         se   => 'Select',
1.1248    raeburn  2302:     );
1.1402    raeburn  2303:     $output = $lt{'dire'}.':&nbsp;'.
1.1400    raeburn  2304:               '<select id="'.$firstselectname.'" name="'.$firstselectname.'" '.
1.1402    raeburn  2305:               'onchange="populateCrsSelects(this.form,'."'$firstselectname','$secondselectname',1,'$js_only',0,1,0,0,0".');">'.
1.1400    raeburn  2306:               '<option value="" selected="selected">'.$lt{'se'}.'</option>';
1.1402    raeburn  2307:     if ($files{'/'}) {
                   2308:         $output .= '<option value="/">/</option>'."\n";
                   2309:     }
1.1400    raeburn  2310:     foreach my $key (sort { lc($a) cmp lc($b) } (keys(%files))) {
1.1402    raeburn  2311:         next if ($key eq '/');
1.1400    raeburn  2312:         $output .= '<option value="'.$key.'">'.$key.'</option>'."\n";
                   2313:     }
                   2314:     $output .= '</select><br />'."\n".
1.1402    raeburn  2315:                $lt{'fnam'}.':&nbsp;<select id="'.$secondselectname.'" name="'.$secondselectname.'">'."\n".
1.1400    raeburn  2316:                '<option value="" selected="selected"></option>'."\n".
1.1402    raeburn  2317:                '</select>'."\n".
                   2318:                '<input type="hidden" id="crsres_include_'.$suffix.'" value="'.$only.'" />';
1.1400    raeburn  2319:     return ($numdirs,$output);
                   2320: }
                   2321: 
                   2322: sub show_crsfiles_js {
                   2323:     my $excluderef = &Apache::lonnet::priv_exclude();
                   2324:     my $se = &js_escape(&mt('Select'));
                   2325:     my $exclude;
                   2326:     if (ref($excluderef) eq 'HASH') {
                   2327:         $exclude = join(',', map { &js_escape($_); } sort(keys(%{$excluderef})));
                   2328:     }
                   2329:     my $js = <<"END";
                   2330: 
                   2331: 
1.1402    raeburn  2332:     function populateCrsSelects (form,dirsel,filesel,exc,include,setdir,setfile,recurse,nonemptydir,addtopdir) {
1.1400    raeburn  2333:         var relpath = '';
                   2334:         if ((setfile) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
                   2335:             var currdir = form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value;
                   2336:             if (currdir == '') {
                   2337:                 if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
                   2338:                     selelem = form.elements[filesel];
                   2339:                     var j, numfiles = selelem.options.length -1;
                   2340:                     if (numfiles >=0) {
                   2341:                         for (j = numfiles; j >= 0; j--) {
                   2342:                             selelem.remove(j);
                   2343:                         }
                   2344:                     }
                   2345:                     if (selelem.options.length == 0) {
                   2346:                         selelem.options[selelem.options.length] = new Option('','');
                   2347:                         selelem.selectedIndex = 0;
1.1248    raeburn  2348:                     }
                   2349:                 }
1.1400    raeburn  2350:                 return;
                   2351:             } else {
                   2352:                 relpath = encodeURIComponent(form.elements[dirsel].options[form.elements[dirsel].selectedIndex].value);
1.1248    raeburn  2353:             }
                   2354:         }
1.1400    raeburn  2355:         var http = new XMLHttpRequest();
                   2356:         var url = "/adm/courseauthor";
                   2357:         var crsrole = "$env{'request.role'}";
                   2358:         var exclude = '';
                   2359:         if (exc) {
                   2360:             exclude = '$exclude';
                   2361:         }
1.1402    raeburn  2362:         var params = "role=course&files=1&rec="+recurse+"&nonempty="+nonemptydir+"&exc="+exclude+"&inc="+include+"&addtop="+addtopdir+"&path="+relpath;
1.1400    raeburn  2363:         http.open("POST", url, true);
                   2364:         http.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
                   2365:         http.onreadystatechange = function() {
                   2366:             if (http.readyState == 4 && http.status == 200) {
                   2367:                 var data = JSON.parse(http.responseText);
                   2368:                 var selelem;
                   2369:                 if ((setdir) && (dirsel != null) && (dirsel != 'undefined') && (dirsel != '')) {
                   2370:                     if (Array.isArray(data.dirs)) {
                   2371:                         selelem = form.elements[dirsel];
                   2372:                         var i, numdirs = selelem.options.length -1;
                   2373:                         if (numdirs >=0) {
                   2374:                             for (i = numdirs; i >= 0; i--) {
                   2375:                                 selelem.remove(i);
                   2376:                             }
                   2377:                         }
                   2378:                         var len = data.dirs.length;
                   2379:                         if (len) {
1.1402    raeburn  2380:                             selelem.options[selelem.options.length] = new Option('$se','');
1.1400    raeburn  2381:                             var j;
                   2382:                             for (j = 0; j < len; j++) {
                   2383:                                 selelem.options[selelem.options.length] = new Option(data.dirs[j],data.dirs[j]);
                   2384:                             }
                   2385:                             selelem.selectedIndex = 0;
                   2386:                         }
                   2387:                         if (!setfile) {
                   2388:                             if ((filesel != null) && (filesel != 'undefined') && (filesel != '')) {
                   2389:                                 selelem = form.elements[filesel];
                   2390:                                 var j, numfiles = selelem.options.length -1;
                   2391:                                 if (numfiles >=0) {
                   2392:                                     for (j = numfiles; j >= 0; j--) {
                   2393:                                         selelem.remove(j);
                   2394:                                     }
                   2395:                                 }
                   2396:                                 if (selelem.options.length == 0) {
                   2397:                                     selelem.options[selelem.options.length] = new Option('','');
                   2398:                                     selelem.selectedIndex = 0;
                   2399:                                 }
                   2400:                             }
                   2401:                         }
                   2402:                     }
                   2403:                 }
                   2404:                 if ((setfile) && (filesel != null) && (filesel != 'undefined') && (filesel != '')) {
                   2405:                     selelem = form.elements[filesel];
                   2406:                     var i, numfiles = selelem.options.length -1;
                   2407:                     if (numfiles >=0) {
                   2408:                         for (i = numfiles; i >= 0; i--) {
                   2409:                             selelem.remove(i);
                   2410:                         }
                   2411:                     }
                   2412:                     var x;
                   2413:                     for (x in data.files) {
                   2414:                         if (Array.isArray(data.files[x])) {
                   2415:                             if (data.files[x].length > 1) {
                   2416:                                 selelem.options[selelem.options.length] = new Option('$se','');
                   2417:                             }
                   2418:                             var len = data.files[x].length;
                   2419:                             if (len) {
                   2420:                                 var k;
                   2421:                                 for (k = 0; k < len; k++) {
                   2422:                                     selelem.options[selelem.options.length] = new Option(data.files[x][k],data.files[x][k]);
                   2423:                                 }
                   2424:                                 selelem.selectedIndex = 0;
                   2425:                             }
                   2426:                         }
                   2427:                     }
                   2428:                     if (selelem.options.length == 0) {
                   2429:                         selelem.options[selelem.options.length] = new Option('','');
                   2430:                         selelem.selectedIndex = 0;
                   2431:                     }
1.1248    raeburn  2432:                 }
                   2433:             }
                   2434:         }
1.1400    raeburn  2435:         http.send(params);
1.1248    raeburn  2436:     }
1.1400    raeburn  2437: END
1.1248    raeburn  2438: }
                   2439: 
1.1426  ! raeburn  2440: sub crsauthor_rights {
        !          2441:     my ($rightsfile,$path,$docroot,$cnum,$cdom) = @_;
        !          2442:     my $sourcerights = "$path/$rightsfile";
        !          2443:     my $now = time;
        !          2444:     if (!-e $sourcerights) {
        !          2445:         my $cid = $cdom.'_'.$cnum;
        !          2446:         if (!-e "$docroot/priv/$cdom") {
        !          2447:             mkdir("$docroot/priv/$cdom",0755);
        !          2448:         }
        !          2449:         if (!-e "$docroot/priv/$cdom/$cnum") {
        !          2450:             mkdir("$docroot/priv/$cdom/$cnum",0755);
        !          2451:         }
        !          2452:         if (open(my $fh,">$sourcerights")) {
        !          2453:             print $fh <<END;
        !          2454: <accessrule effect="deny" realm="" type="course" role="" />
        !          2455: <accessrule effect="allow" realm="$cid" type="course" role="" />
        !          2456: END
        !          2457:             close($fh);
        !          2458:         }
        !          2459:     }
        !          2460:     if (!-e "$sourcerights.meta") {
        !          2461:         if (open(my $fh,">$sourcerights.meta")) {
        !          2462:             my $author=$env{'environment.firstname'}.' '.
        !          2463:                        $env{'environment.middlename'}.' '.
        !          2464:                        $env{'environment.lastname'}.' '.
        !          2465:                        $env{'environment.generation'};
        !          2466:             $author =~ s/\s+$//;
        !          2467:             print $fh <<"END";
        !          2468: 
        !          2469: <abstract></abstract>
        !          2470: <author>$author</author>
        !          2471: <authorspace>$cnum:$cdom</authorspace>
        !          2472: <copyright>private</copyright>
        !          2473: <creationdate>$now</creationdate>
        !          2474: <customdistributionfile></customdistributionfile>
        !          2475: <dependencies></dependencies>
        !          2476: <domain>$cdom</domain>
        !          2477: <highestgradelevel>0</highestgradelevel>
        !          2478: <keywords></keywords>
        !          2479: <language>notset </language>
        !          2480: <lastrevisiondate>$now</lastrevisiondate>
        !          2481: <lowestgradelevel>0</lowestgradelevel>
        !          2482: <mime>rights</mime>
        !          2483: <modifyinguser>$env{'user.name'}:$env{'user.domain'}</modifyinguser>
        !          2484: <notes></notes>
        !          2485: <obsolete></obsolete>
        !          2486: <obsoletereplacement></obsoletereplacement>
        !          2487: <owner>$cnum:$cdom</owner>
        !          2488: <rule>deny:::course,allow:$cid::course</rule>
        !          2489: <sourceavail></sourceavail>
        !          2490: <standards></standards>
        !          2491: <subject></subject>
        !          2492: <title>Course Authoring Rights</title>
        !          2493: END
        !          2494:             close($fh);
        !          2495:         }
        !          2496:     }
        !          2497:     return;
        !          2498: }
        !          2499: 
1.565     albertel 2500: =pod
                   2501: 
1.1420    raeburn  2502: =item * &iframe_wrapper_headjs()
                   2503: 
1.1425    raeburn  2504: emits javascript containing two global vars to facilitate handling of resizing
                   2505: by code in iframe_wrapper_resizejs() used when an iframe is present in a page
                   2506: with standard LON-CAPA menus.
                   2507: 
                   2508: =cut
                   2509: 
1.1420    raeburn  2510: #
                   2511: # Where iframe is in use, if window.onload() executes before the custom resize function
                   2512: # has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
                   2513: # are used to ensure document.ready() triggers a call to resize, so the iframe contents
                   2514: # do not obscure the Functions menu.
                   2515: #
                   2516: 
                   2517: sub iframe_wrapper_headjs {
                   2518:     return <<"ENDJS";
                   2519: <script type="text/javascript">
                   2520: // <![CDATA[
                   2521: var LCnotready = 0;
                   2522: var LCresizedef = 0;
                   2523: // ]]>
                   2524: </script>
                   2525: 
                   2526: ENDJS
                   2527: 
                   2528: }
                   2529: 
                   2530: =pod
                   2531: 
                   2532: =item * &iframe_wrapper_resizejs()
                   2533: 
1.1425    raeburn  2534: emits javascript used to handle resizing for a page containing
                   2535: an iframe, to ensure that the iframe does not obscure any
                   2536: standard LON-CAPA menu items.
                   2537: 
                   2538: =back
                   2539: 
                   2540: =cut
                   2541: 
1.1420    raeburn  2542: #
                   2543: # jQuery to use when iframe is in use and a page resize occurs.
                   2544: # This script will ensure that the iframe does not obscure any
                   2545: # standard LON-CAPA inline menus (primary, secondary, and/or
                   2546: # breadcrumbs and Functions menus. Expects javascript from
                   2547: # &iframe_wrapper_headjs() to be in head portion of the web page,
                   2548: # e.g., by inclusion in second arg passed to &start_page().
                   2549: #
                   2550: 
                   2551: sub iframe_wrapper_resizejs {
                   2552:     my $offset = 5;
                   2553:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);
                   2554:     if (($env{'form.inhibitmenu'} eq 'yes') || ($env{'form.only_body'})) {
                   2555:         $offset = 0;
                   2556:     }
                   2557:     return &Apache::lonhtmlcommon::scripttag(<<SCRIPT);
                   2558:     \$(document).ready( function() {
                   2559:         \$(window).unbind('resize').resize(function(){
                   2560:             var header = null;
                   2561:             var offset = $offset;
                   2562:             var height = 0;
                   2563:             var hdrtop = 0;
1.1421    raeburn  2564:             if (\$('div.LC_menus_content:first').length) {
                   2565:                 if (\$('div.LC_menus_content:first').hasClass ("shown")) {
                   2566:                     header = \$('div.LC_menus_content:first');
1.1423    raeburn  2567:                     offset = 12;
1.1421    raeburn  2568:                 }
                   2569:             } else if (\$('div.LC_head_subbox:first').length) {
1.1420    raeburn  2570:                 header = \$('div.LC_head_subbox:first');
                   2571:                 offset = 9;
                   2572:             } else {
                   2573:                 if (\$('#LC_breadcrumbs').length) {
                   2574:                     header = \$('#LC_breadcrumbs');
                   2575:                 }
                   2576:             }
                   2577:             if (header != null && header.length) {
                   2578:                 height = header.height();
                   2579:                 hdrtop = header.position().top;
                   2580:             }
                   2581:             var pos = height + hdrtop + offset;
                   2582:             \$('.LC_iframecontainer').css('top', pos);
                   2583:         });
                   2584:         LCresizedef = 1;
                   2585:         if (LCnotready == 1) {
                   2586:             LCnotready = 0;
                   2587:             \$(window).trigger('resize');
                   2588:         }
                   2589:     });
                   2590:     window.onload = function(){
                   2591:          if (LCresizedef) {
                   2592:              LCnotready = 0;
                   2593:              \$(window).trigger('resize');
                   2594:          } else {
                   2595:              LCnotready = 1;
                   2596:          }
                   2597:     };
                   2598: SCRIPT
                   2599: 
                   2600: }
                   2601: 
                   2602: =pod
                   2603: 
1.256     matthew  2604: =head1 Excel and CSV file utility routines
                   2605: 
                   2606: =cut
                   2607: 
                   2608: ###############################################################
                   2609: ###############################################################
                   2610: 
                   2611: =pod
                   2612: 
1.1162    raeburn  2613: =over 4
                   2614: 
1.648     raeburn  2615: =item * &csv_translate($text) 
1.37      matthew  2616: 
1.185     www      2617: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  2618: format.
                   2619: 
                   2620: =cut
                   2621: 
1.180     matthew  2622: ###############################################################
                   2623: ###############################################################
1.37      matthew  2624: sub csv_translate {
                   2625:     my $text = shift;
                   2626:     $text =~ s/\"/\"\"/g;
1.209     albertel 2627:     $text =~ s/\n/ /g;
1.37      matthew  2628:     return $text;
                   2629: }
1.180     matthew  2630: 
                   2631: ###############################################################
                   2632: ###############################################################
                   2633: 
                   2634: =pod
                   2635: 
1.648     raeburn  2636: =item * &define_excel_formats()
1.180     matthew  2637: 
                   2638: Define some commonly used Excel cell formats.
                   2639: 
                   2640: Currently supported formats:
                   2641: 
                   2642: =over 4
                   2643: 
                   2644: =item header
                   2645: 
                   2646: =item bold
                   2647: 
                   2648: =item h1
                   2649: 
                   2650: =item h2
                   2651: 
                   2652: =item h3
                   2653: 
1.256     matthew  2654: =item h4
                   2655: 
                   2656: =item i
                   2657: 
1.180     matthew  2658: =item date
                   2659: 
                   2660: =back
                   2661: 
                   2662: Inputs: $workbook
                   2663: 
                   2664: Returns: $format, a hash reference.
                   2665: 
1.1057    foxr     2666: 
1.180     matthew  2667: =cut
                   2668: 
                   2669: ###############################################################
                   2670: ###############################################################
                   2671: sub define_excel_formats {
                   2672:     my ($workbook) = @_;
                   2673:     my $format;
                   2674:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   2675:                                                 bottom    => 1,
                   2676:                                                 align     => 'center');
                   2677:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   2678:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   2679:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   2680:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  2681:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  2682:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  2683:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  2684:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  2685:     return $format;
                   2686: }
                   2687: 
                   2688: ###############################################################
                   2689: ###############################################################
1.113     bowersj2 2690: 
                   2691: =pod
                   2692: 
1.648     raeburn  2693: =item * &create_workbook()
1.255     matthew  2694: 
                   2695: Create an Excel worksheet.  If it fails, output message on the
                   2696: request object and return undefs.
                   2697: 
                   2698: Inputs: Apache request object
                   2699: 
                   2700: Returns (undef) on failure, 
                   2701:     Excel worksheet object, scalar with filename, and formats 
                   2702:     from &Apache::loncommon::define_excel_formats on success
                   2703: 
                   2704: =cut
                   2705: 
                   2706: ###############################################################
                   2707: ###############################################################
                   2708: sub create_workbook {
                   2709:     my ($r) = @_;
                   2710:         #
                   2711:     # Create the excel spreadsheet
                   2712:     my $filename = '/prtspool/'.
1.258     albertel 2713:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  2714:         time.'_'.rand(1000000000).'.xls';
                   2715:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   2716:     if (! defined($workbook)) {
                   2717:         $r->log_error("Error creating excel spreadsheet $filename: $!");
1.928     bisitz   2718:         $r->print(
                   2719:             '<p class="LC_error">'
                   2720:            .&mt('Problems occurred in creating the new Excel file.')
                   2721:            .' '.&mt('This error has been logged.')
                   2722:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2723:            .'</p>'
                   2724:         );
1.255     matthew  2725:         return (undef);
                   2726:     }
                   2727:     #
1.1014    foxr     2728:     $workbook->set_tempdir(LONCAPA::tempdir());
1.255     matthew  2729:     #
                   2730:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   2731:     return ($workbook,$filename,$format);
                   2732: }
                   2733: 
                   2734: ###############################################################
                   2735: ###############################################################
                   2736: 
                   2737: =pod
                   2738: 
1.648     raeburn  2739: =item * &create_text_file()
1.113     bowersj2 2740: 
1.542     raeburn  2741: Create a file to write to and eventually make available to the user.
1.256     matthew  2742: If file creation fails, outputs an error message on the request object and 
                   2743: return undefs.
1.113     bowersj2 2744: 
1.256     matthew  2745: Inputs: Apache request object, and file suffix
1.113     bowersj2 2746: 
1.256     matthew  2747: Returns (undef) on failure, 
                   2748:     Filehandle and filename on success.
1.113     bowersj2 2749: 
                   2750: =cut
                   2751: 
1.256     matthew  2752: ###############################################################
                   2753: ###############################################################
                   2754: sub create_text_file {
                   2755:     my ($r,$suffix) = @_;
                   2756:     if (! defined($suffix)) { $suffix = 'txt'; };
                   2757:     my $fh;
                   2758:     my $filename = '/prtspool/'.
1.258     albertel 2759:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  2760:         time.'_'.rand(1000000000).'.'.$suffix;
                   2761:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   2762:     if (! defined($fh)) {
                   2763:         $r->log_error("Couldn't open $filename for output $!");
1.928     bisitz   2764:         $r->print(
                   2765:             '<p class="LC_error">'
                   2766:            .&mt('Problems occurred in creating the output file.')
                   2767:            .' '.&mt('This error has been logged.')
                   2768:            .' '.&mt('Please alert your LON-CAPA administrator.')
                   2769:            .'</p>'
                   2770:         );
1.113     bowersj2 2771:     }
1.256     matthew  2772:     return ($fh,$filename)
1.113     bowersj2 2773: }
                   2774: 
                   2775: 
1.256     matthew  2776: =pod 
1.113     bowersj2 2777: 
                   2778: =back
                   2779: 
                   2780: =cut
1.37      matthew  2781: 
                   2782: ###############################################################
1.33      matthew  2783: ##        Home server <option> list generating code          ##
                   2784: ###############################################################
1.35      matthew  2785: 
1.169     www      2786: # ------------------------------------------
                   2787: 
                   2788: sub domain_select {
1.1289    raeburn  2789:     my ($name,$value,$multiple,$incdoms,$excdoms)=@_;
                   2790:     my @possdoms;
                   2791:     if (ref($incdoms) eq 'ARRAY') {
                   2792:         @possdoms = @{$incdoms};
                   2793:     } else {
                   2794:         @possdoms = &Apache::lonnet::all_domains();
                   2795:     }
                   2796: 
1.169     www      2797:     my %domains=map { 
1.514     albertel 2798: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.1289    raeburn  2799:     } @possdoms;
                   2800: 
                   2801:     if ((ref($excdoms) eq 'ARRAY') && (@{$excdoms} > 0)) {
                   2802:         foreach my $dom (@{$excdoms}) {
                   2803:             delete($domains{$dom});
                   2804:         }
                   2805:     }
                   2806: 
1.169     www      2807:     if ($multiple) {
                   2808: 	$domains{''}=&mt('Any domain');
1.550     albertel 2809: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 2810: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      2811:     } else {
1.550     albertel 2812: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.970     raeburn  2813: 	return &select_form($name,$value,\%domains);
1.169     www      2814:     }
                   2815: }
                   2816: 
1.282     albertel 2817: #-------------------------------------------
                   2818: 
                   2819: =pod
                   2820: 
1.519     raeburn  2821: =head1 Routines for form select boxes
                   2822: 
                   2823: =over 4
                   2824: 
1.648     raeburn  2825: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 2826: 
                   2827: Returns a string containing a <select> element int multiple mode
                   2828: 
                   2829: 
                   2830: Args:
                   2831:   $name - name of the <select> element
1.506     raeburn  2832:   $value - scalar or array ref of values that should already be selected
1.282     albertel 2833:   $size - number of rows long the select element is
1.283     albertel 2834:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 2835:           (shown text should already have been &mt())
1.506     raeburn  2836:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 2837: 
1.282     albertel 2838: =cut
                   2839: 
                   2840: #-------------------------------------------
1.169     www      2841: sub multiple_select_form {
1.284     albertel 2842:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      2843:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   2844:     my $output='';
1.191     matthew  2845:     if (! defined($size)) {
                   2846:         $size = 4;
1.283     albertel 2847:         if (scalar(keys(%$hash))<4) {
                   2848:             $size = scalar(keys(%$hash));
1.191     matthew  2849:         }
                   2850:     }
1.734     bisitz   2851:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 2852:     my @order;
1.506     raeburn  2853:     if (ref($order) eq 'ARRAY')  {
                   2854:         @order = @{$order};
                   2855:     } else {
                   2856:         @order = sort(keys(%$hash));
1.501     banghart 2857:     }
                   2858:     if (exists($$hash{'select_form_order'})) {
                   2859:         @order = @{$$hash{'select_form_order'}};
                   2860:     }
                   2861:         
1.284     albertel 2862:     foreach my $key (@order) {
1.356     albertel 2863:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 2864:         $output.='selected="selected" ' if ($selected{$key});
                   2865:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      2866:     }
                   2867:     $output.="</select>\n";
                   2868:     return $output;
                   2869: }
                   2870: 
1.88      www      2871: #-------------------------------------------
                   2872: 
                   2873: =pod
                   2874: 
1.1254    raeburn  2875: =item * &select_form($defdom,$name,$hashref,$onchange,$readonly)
1.88      www      2876: 
                   2877: Returns a string containing a <select name='$name' size='1'> form to 
1.970     raeburn  2878: allow a user to select options from a ref to a hash containing:
                   2879: option_name => displayed text. An optional $onchange can include
1.1254    raeburn  2880: a javascript onchange item, e.g., onchange="this.form.submit();".
                   2881: An optional arg -- $readonly -- if true will cause the select form
                   2882: to be disabled, e.g., for the case where an instructor has a section-
                   2883: specific role, and is viewing/modifying parameters. 
1.970     raeburn  2884: 
1.88      www      2885: See lonrights.pm for an example invocation and use.
                   2886: 
                   2887: =cut
                   2888: 
                   2889: #-------------------------------------------
                   2890: sub select_form {
1.1228    raeburn  2891:     my ($def,$name,$hashref,$onchange,$readonly) = @_;
1.970     raeburn  2892:     return unless (ref($hashref) eq 'HASH');
                   2893:     if ($onchange) {
                   2894:         $onchange = ' onchange="'.$onchange.'"';
                   2895:     }
1.1228    raeburn  2896:     my $disabled;
                   2897:     if ($readonly) {
                   2898:         $disabled = ' disabled="disabled"';
                   2899:     }
                   2900:     my $selectform = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.128     albertel 2901:     my @keys;
1.970     raeburn  2902:     if (exists($hashref->{'select_form_order'})) {
                   2903: 	@keys=@{$hashref->{'select_form_order'}};
1.128     albertel 2904:     } else {
1.970     raeburn  2905: 	@keys=sort(keys(%{$hashref}));
1.128     albertel 2906:     }
1.356     albertel 2907:     foreach my $key (@keys) {
                   2908:         $selectform.=
                   2909: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   2910:             ($key eq $def ? 'selected="selected" ' : '').
1.970     raeburn  2911:                 ">".$hashref->{$key}."</option>\n";
1.88      www      2912:     }
                   2913:     $selectform.="</select>";
                   2914:     return $selectform;
                   2915: }
                   2916: 
1.475     www      2917: # For display filters
                   2918: 
                   2919: sub display_filter {
1.1074    raeburn  2920:     my ($context) = @_;
1.475     www      2921:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      2922:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.1074    raeburn  2923:     my $phraseinput = 'hidden';
                   2924:     my $includeinput = 'hidden';
                   2925:     my ($checked,$includetypestext);
                   2926:     if ($env{'form.displayfilter'} eq 'containing') {
                   2927:         $phraseinput = 'text'; 
                   2928:         if ($context eq 'parmslog') {
                   2929:             $includeinput = 'checkbox';
                   2930:             if ($env{'form.includetypes'}) {
                   2931:                 $checked = ' checked="checked"';
                   2932:             }
                   2933:             $includetypestext = &mt('Include parameter types');
                   2934:         }
                   2935:     } else {
                   2936:         $includetypestext = '&nbsp;';
                   2937:     }
                   2938:     my ($additional,$secondid,$thirdid);
                   2939:     if ($context eq 'parmslog') {
                   2940:         $additional = 
                   2941:             '<label><input type="'.$includeinput.'" name="includetypes"'. 
                   2942:             $checked.' name="includetypes" value="1" id="includetypes" />'.
                   2943:             '&nbsp;<span id="includetypestext">'.$includetypestext.'</span>'.
                   2944:             '</label>';
                   2945:         $secondid = 'includetypes';
                   2946:         $thirdid = 'includetypestext';
                   2947:     }
                   2948:     my $onchange = "javascript:toggleHistoryOptions(this,'containingphrase','$context',
                   2949:                                                     '$secondid','$thirdid')";
                   2950:     return '<span class="LC_nobreak"><label>'.&mt('Records: [_1]',
1.1403    raeburn  2951: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},'',undef,
1.475     www      2952: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   2953: 	   '</label></span> <span class="LC_nobreak">'.
1.1074    raeburn  2954:            &mt('Filter: [_1]',
1.477     www      2955: 	   &select_form($env{'form.displayfilter'},
                   2956: 			'displayfilter',
1.970     raeburn  2957: 			{'currentfolder' => 'Current folder/page',
1.477     www      2958: 			 'containing' => 'Containing phrase',
1.1074    raeburn  2959: 			 'none' => 'None'},$onchange)).'&nbsp;'.
                   2960: 			 '<input type="'.$phraseinput.'" name="containingphrase" id="containingphrase" size="30" value="'.
                   2961:                          &HTML::Entities::encode($env{'form.containingphrase'}).
                   2962:                          '" />'.$additional;
                   2963: }
                   2964: 
                   2965: sub display_filter_js {
                   2966:     my $includetext = &mt('Include parameter types');
                   2967:     return <<"ENDJS";
                   2968:   
                   2969: function toggleHistoryOptions(setter,firstid,context,secondid,thirdid) {
                   2970:     var firstType = 'hidden';
                   2971:     if (setter.options[setter.selectedIndex].value == 'containing') {
                   2972:         firstType = 'text';
                   2973:     }
                   2974:     firstObject = document.getElementById(firstid);
                   2975:     if (typeof(firstObject) == 'object') {
                   2976:         if (firstObject.type != firstType) {
                   2977:             changeInputType(firstObject,firstType);
                   2978:         }
                   2979:     }
                   2980:     if (context == 'parmslog') {
                   2981:         var secondType = 'hidden';
                   2982:         if (firstType == 'text') {
                   2983:             secondType = 'checkbox';
                   2984:         }
                   2985:         secondObject = document.getElementById(secondid);  
                   2986:         if (typeof(secondObject) == 'object') {
                   2987:             if (secondObject.type != secondType) {
                   2988:                 changeInputType(secondObject,secondType);
                   2989:             }
                   2990:         }
                   2991:         var textItem = document.getElementById(thirdid);
                   2992:         var currtext = textItem.innerHTML;
                   2993:         var newtext;
                   2994:         if (firstType == 'text') {
                   2995:             newtext = '$includetext';
                   2996:         } else {
                   2997:             newtext = '&nbsp;';
                   2998:         }
                   2999:         if (currtext != newtext) {
                   3000:             textItem.innerHTML = newtext;
                   3001:         }
                   3002:     }
                   3003:     return;
                   3004: }
                   3005: 
                   3006: function changeInputType(oldObject,newType) {
                   3007:     var newObject = document.createElement('input');
                   3008:     newObject.type = newType;
                   3009:     if (oldObject.size) {
                   3010:         newObject.size = oldObject.size;
                   3011:     }
                   3012:     if (oldObject.value) {
                   3013:         newObject.value = oldObject.value;
                   3014:     }
                   3015:     if (oldObject.name) {
                   3016:         newObject.name = oldObject.name;
                   3017:     }
                   3018:     if (oldObject.id) {
                   3019:         newObject.id = oldObject.id;
                   3020:     }
                   3021:     oldObject.parentNode.replaceChild(newObject,oldObject);
                   3022:     return;
                   3023: }
                   3024: 
                   3025: ENDJS
1.475     www      3026: }
                   3027: 
1.167     www      3028: sub gradeleveldescription {
                   3029:     my $gradelevel=shift;
                   3030:     my %gradelevels=(0 => 'Not specified',
                   3031: 		     1 => 'Grade 1',
                   3032: 		     2 => 'Grade 2',
                   3033: 		     3 => 'Grade 3',
                   3034: 		     4 => 'Grade 4',
                   3035: 		     5 => 'Grade 5',
                   3036: 		     6 => 'Grade 6',
                   3037: 		     7 => 'Grade 7',
                   3038: 		     8 => 'Grade 8',
                   3039: 		     9 => 'Grade 9',
                   3040: 		     10 => 'Grade 10',
                   3041: 		     11 => 'Grade 11',
                   3042: 		     12 => 'Grade 12',
                   3043: 		     13 => 'Grade 13',
                   3044: 		     14 => '100 Level',
                   3045: 		     15 => '200 Level',
                   3046: 		     16 => '300 Level',
                   3047: 		     17 => '400 Level',
                   3048: 		     18 => 'Graduate Level');
                   3049:     return &mt($gradelevels{$gradelevel});
                   3050: }
                   3051: 
1.163     www      3052: sub select_level_form {
                   3053:     my ($deflevel,$name)=@_;
                   3054:     unless ($deflevel) { $deflevel=0; }
1.167     www      3055:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   3056:     for (my $i=0; $i<=18; $i++) {
                   3057:         $selectform.="<option value=\"$i\" ".
1.253     albertel 3058:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      3059:                 ">".&gradeleveldescription($i)."</option>\n";
                   3060:     }
                   3061:     $selectform.="</select>";
                   3062:     return $selectform;
1.163     www      3063: }
1.167     www      3064: 
1.35      matthew  3065: #-------------------------------------------
                   3066: 
1.45      matthew  3067: =pod
                   3068: 
1.1256    raeburn  3069: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled)
1.35      matthew  3070: 
                   3071: Returns a string containing a <select name='$name' size='1'> form to 
                   3072: allow a user to select the domain to preform an operation in.  
                   3073: See loncreateuser.pm for an example invocation and use.
                   3074: 
1.90      www      3075: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   3076: selected");
                   3077: 
1.743     raeburn  3078: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   3079: 
1.910     raeburn  3080: 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.
                   3081: 
1.1121    raeburn  3082: The optional $incdoms is a reference to an array of domains which will be the only available options.
                   3083: 
                   3084: The optional $excdoms is a reference to an array of domains which will be excluded from the available options.
1.563     raeburn  3085: 
1.1256    raeburn  3086: The optional $disabled argument, if true, adds the disabled attribute to the select tag.
                   3087: 
1.35      matthew  3088: =cut
                   3089: 
                   3090: #-------------------------------------------
1.34      matthew  3091: sub select_dom_form {
1.1256    raeburn  3092:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms,$excdoms,$disabled) = @_;
1.872     raeburn  3093:     if ($onchange) {
1.874     raeburn  3094:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  3095:     }
1.1256    raeburn  3096:     if ($disabled) {
                   3097:         $disabled = ' disabled="disabled"';
                   3098:     }
1.1121    raeburn  3099:     my (@domains,%exclude);
1.910     raeburn  3100:     if (ref($incdoms) eq 'ARRAY') {
                   3101:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   3102:     } else {
                   3103:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   3104:     }
1.90      www      3105:     if ($includeempty) { @domains=('',@domains); }
1.1121    raeburn  3106:     if (ref($excdoms) eq 'ARRAY') {
                   3107:         map { $exclude{$_} = 1; } @{$excdoms}; 
                   3108:     }
1.1256    raeburn  3109:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange$disabled>\n";
1.356     albertel 3110:     foreach my $dom (@domains) {
1.1121    raeburn  3111:         next if ($exclude{$dom});
1.356     albertel 3112:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  3113:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   3114:         if ($showdomdesc) {
                   3115:             if ($dom ne '') {
                   3116:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   3117:                 if ($domdesc ne '') {
                   3118:                     $selectdomain .= ' ('.$domdesc.')';
                   3119:                 }
                   3120:             } 
                   3121:         }
                   3122:         $selectdomain .= "</option>\n";
1.34      matthew  3123:     }
                   3124:     $selectdomain.="</select>";
                   3125:     return $selectdomain;
                   3126: }
                   3127: 
1.35      matthew  3128: #-------------------------------------------
                   3129: 
1.45      matthew  3130: =pod
                   3131: 
1.648     raeburn  3132: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  3133: 
1.586     raeburn  3134: input: 4 arguments (two required, two optional) - 
                   3135:     $domain - domain of new user
                   3136:     $name - name of form element
                   3137:     $default - Value of 'default' causes a default item to be first 
                   3138:                             option, and selected by default. 
                   3139:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   3140:                             if 1 server found, or default, if 0 found.
1.594     raeburn  3141: output: returns 2 items: 
1.586     raeburn  3142: (a) form element which contains either:
                   3143:    (i) <select name="$name">
                   3144:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   3145:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   3146:        </select>
                   3147:        form item if there are multiple library servers in $domain, or
                   3148:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   3149:        if there is only one library server in $domain.
                   3150: 
                   3151: (b) number of library servers found.
                   3152: 
                   3153: See loncreateuser.pm for example of use.
1.35      matthew  3154: 
                   3155: =cut
                   3156: 
                   3157: #-------------------------------------------
1.586     raeburn  3158: sub home_server_form_item {
                   3159:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 3160:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  3161:     my $result;
                   3162:     my $numlib = keys(%servers);
                   3163:     if ($numlib > 1) {
                   3164:         $result .= '<select name="'.$name.'" />'."\n";
                   3165:         if ($default) {
1.804     bisitz   3166:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  3167:                        '</option>'."\n";
                   3168:         }
                   3169:         foreach my $hostid (sort(keys(%servers))) {
                   3170:             $result.= '<option value="'.$hostid.'">'.
                   3171: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   3172:         }
                   3173:         $result .= '</select>'."\n";
                   3174:     } elsif ($numlib == 1) {
                   3175:         my $hostid;
                   3176:         foreach my $item (keys(%servers)) {
                   3177:             $hostid = $item;
                   3178:         }
                   3179:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   3180:                    $hostid.'" />';
                   3181:                    if (!$hide) {
                   3182:                        $result .= $hostid.' '.$servers{$hostid};
                   3183:                    }
                   3184:                    $result .= "\n";
                   3185:     } elsif ($default) {
                   3186:         $result .= '<input type="hidden" name="'.$name.
                   3187:                    '" value="default" />';
                   3188:                    if (!$hide) {
                   3189:                        $result .= &mt('default');
                   3190:                    }
                   3191:                    $result .= "\n";
1.33      matthew  3192:     }
1.586     raeburn  3193:     return ($result,$numlib);
1.33      matthew  3194: }
1.112     bowersj2 3195: 
                   3196: =pod
                   3197: 
1.534     albertel 3198: =back 
                   3199: 
1.112     bowersj2 3200: =cut
1.87      matthew  3201: 
                   3202: ###############################################################
1.112     bowersj2 3203: ##                  Decoding User Agent                      ##
1.87      matthew  3204: ###############################################################
                   3205: 
                   3206: =pod
                   3207: 
1.112     bowersj2 3208: =head1 Decoding the User Agent
                   3209: 
                   3210: =over 4
                   3211: 
                   3212: =item * &decode_user_agent()
1.87      matthew  3213: 
                   3214: Inputs: $r
                   3215: 
                   3216: Outputs:
                   3217: 
                   3218: =over 4
                   3219: 
1.112     bowersj2 3220: =item * $httpbrowser
1.87      matthew  3221: 
1.112     bowersj2 3222: =item * $clientbrowser
1.87      matthew  3223: 
1.112     bowersj2 3224: =item * $clientversion
1.87      matthew  3225: 
1.112     bowersj2 3226: =item * $clientmathml
1.87      matthew  3227: 
1.112     bowersj2 3228: =item * $clientunicode
1.87      matthew  3229: 
1.112     bowersj2 3230: =item * $clientos
1.87      matthew  3231: 
1.1137    raeburn  3232: =item * $clientmobile
                   3233: 
1.1141    raeburn  3234: =item * $clientinfo
                   3235: 
1.1194    raeburn  3236: =item * $clientosversion
                   3237: 
1.87      matthew  3238: =back
                   3239: 
1.157     matthew  3240: =back 
                   3241: 
1.87      matthew  3242: =cut
                   3243: 
                   3244: ###############################################################
                   3245: ###############################################################
                   3246: sub decode_user_agent {
1.247     albertel 3247:     my ($r)=@_;
1.87      matthew  3248:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   3249:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   3250:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 3251:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  3252:     my $clientbrowser='unknown';
                   3253:     my $clientversion='0';
                   3254:     my $clientmathml='';
                   3255:     my $clientunicode='0';
1.1137    raeburn  3256:     my $clientmobile=0;
1.1194    raeburn  3257:     my $clientosversion='';
1.87      matthew  3258:     for (my $i=0;$i<=$#browsertype;$i++) {
1.1193    raeburn  3259:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\%/,$browsertype[$i]);
1.87      matthew  3260: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   3261: 	    $clientbrowser=$bname;
                   3262:             $httpbrowser=~/$vreg/i;
                   3263: 	    $clientversion=$1;
                   3264:             $clientmathml=($clientversion>=$minv);
                   3265:             $clientunicode=($clientversion>=$univ);
                   3266: 	}
                   3267:     }
                   3268:     my $clientos='unknown';
1.1141    raeburn  3269:     my $clientinfo;
1.87      matthew  3270:     if (($httpbrowser=~/linux/i) ||
                   3271:         ($httpbrowser=~/unix/i) ||
                   3272:         ($httpbrowser=~/ux/i) ||
                   3273:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   3274:     if (($httpbrowser=~/vax/i) ||
                   3275:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   3276:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   3277:     if (($httpbrowser=~/mac/i) ||
                   3278:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1.1194    raeburn  3279:     if ($httpbrowser=~/win/i) {
                   3280:         $clientos='win';
                   3281:         if ($httpbrowser =~/Windows\s+NT\s+(\d+\.\d+)/i) {
                   3282:             $clientosversion = $1;
                   3283:         }
                   3284:     }
1.87      matthew  3285:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1.1137    raeburn  3286:     if ($httpbrowser=~/(Android|iPod|iPad|iPhone|webOS|Blackberry|Windows Phone|Opera m(?:ob|in)|Fennec)/i) {
                   3287:         $clientmobile=lc($1);
                   3288:     }
1.1141    raeburn  3289:     if ($httpbrowser=~ m{Firefox/(\d+\.\d+)}) {
                   3290:         $clientinfo = 'firefox-'.$1;
                   3291:     } elsif ($httpbrowser=~ m{chromeframe/(\d+\.\d+)\.}) {
                   3292:         $clientinfo = 'chromeframe-'.$1;
                   3293:     }
1.87      matthew  3294:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1.1194    raeburn  3295:             $clientunicode,$clientos,$clientmobile,$clientinfo,
                   3296:             $clientosversion);
1.87      matthew  3297: }
                   3298: 
1.32      matthew  3299: ###############################################################
                   3300: ##    Authentication changing form generation subroutines    ##
                   3301: ###############################################################
                   3302: ##
                   3303: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   3304: ## hash, and have reasonable default values.
                   3305: ##
                   3306: ##    formname = the name given in the <form> tag.
1.35      matthew  3307: #-------------------------------------------
                   3308: 
1.45      matthew  3309: =pod
                   3310: 
1.112     bowersj2 3311: =head1 Authentication Routines
                   3312: 
                   3313: =over 4
                   3314: 
1.648     raeburn  3315: =item * &authform_xxxxxx()
1.35      matthew  3316: 
                   3317: The authform_xxxxxx subroutines provide javascript and html forms which 
                   3318: handle some of the conveniences required for authentication forms.  
                   3319: This is not an optimal method, but it works.  
                   3320: 
                   3321: =over 4
                   3322: 
1.112     bowersj2 3323: =item * authform_header
1.35      matthew  3324: 
1.112     bowersj2 3325: =item * authform_authorwarning
1.35      matthew  3326: 
1.112     bowersj2 3327: =item * authform_nochange
1.35      matthew  3328: 
1.112     bowersj2 3329: =item * authform_kerberos
1.35      matthew  3330: 
1.112     bowersj2 3331: =item * authform_internal
1.35      matthew  3332: 
1.112     bowersj2 3333: =item * authform_filesystem
1.35      matthew  3334: 
1.1310    raeburn  3335: =item * authform_lti
                   3336: 
1.35      matthew  3337: =back
                   3338: 
1.648     raeburn  3339: See loncreateuser.pm for invocation and use examples.
1.157     matthew  3340: 
1.35      matthew  3341: =cut
                   3342: 
                   3343: #-------------------------------------------
1.32      matthew  3344: sub authform_header{  
                   3345:     my %in = (
                   3346:         formname => 'cu',
1.80      albertel 3347:         kerb_def_dom => '',
1.32      matthew  3348:         @_,
                   3349:     );
                   3350:     $in{'formname'} = 'document.' . $in{'formname'};
                   3351:     my $result='';
1.80      albertel 3352: 
                   3353: #---------------------------------------------- Code for upper case translation
                   3354:     my $Javascript_toUpperCase;
                   3355:     unless ($in{kerb_def_dom}) {
                   3356:         $Javascript_toUpperCase =<<"END";
                   3357:         switch (choice) {
                   3358:            case 'krb': currentform.elements[choicearg].value =
                   3359:                currentform.elements[choicearg].value.toUpperCase();
                   3360:                break;
                   3361:            default:
                   3362:         }
                   3363: END
                   3364:     } else {
                   3365:         $Javascript_toUpperCase = "";
                   3366:     }
                   3367: 
1.165     raeburn  3368:     my $radioval = "'nochange'";
1.591     raeburn  3369:     if (defined($in{'curr_authtype'})) {
                   3370:         if ($in{'curr_authtype'} ne '') {
                   3371:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   3372:         }
1.174     matthew  3373:     }
1.165     raeburn  3374:     my $argfield = 'null';
1.591     raeburn  3375:     if (defined($in{'mode'})) {
1.165     raeburn  3376:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  3377:             if (defined($in{'curr_autharg'})) {
                   3378:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  3379:                     $argfield = "'$in{'curr_autharg'}'";
                   3380:                 }
                   3381:             }
                   3382:         }
                   3383:     }
                   3384: 
1.32      matthew  3385:     $result.=<<"END";
                   3386: var current = new Object();
1.165     raeburn  3387: current.radiovalue = $radioval;
                   3388: current.argfield = $argfield;
1.32      matthew  3389: 
                   3390: function changed_radio(choice,currentform) {
                   3391:     var choicearg = choice + 'arg';
                   3392:     // If a radio button in changed, we need to change the argfield
                   3393:     if (current.radiovalue != choice) {
                   3394:         current.radiovalue = choice;
                   3395:         if (current.argfield != null) {
                   3396:             currentform.elements[current.argfield].value = '';
                   3397:         }
                   3398:         if (choice == 'nochange') {
                   3399:             current.argfield = null;
                   3400:         } else {
                   3401:             current.argfield = choicearg;
                   3402:             switch(choice) {
                   3403:                 case 'krb': 
                   3404:                     currentform.elements[current.argfield].value = 
                   3405:                         "$in{'kerb_def_dom'}";
                   3406:                 break;
                   3407:               default:
                   3408:                 break;
                   3409:             }
                   3410:         }
                   3411:     }
                   3412:     return;
                   3413: }
1.22      www      3414: 
1.32      matthew  3415: function changed_text(choice,currentform) {
                   3416:     var choicearg = choice + 'arg';
                   3417:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 3418:         $Javascript_toUpperCase
1.32      matthew  3419:         // clear old field
                   3420:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   3421:             currentform.elements[current.argfield].value = '';
                   3422:         }
                   3423:         current.argfield = choicearg;
                   3424:     }
                   3425:     set_auth_radio_buttons(choice,currentform);
                   3426:     return;
1.20      www      3427: }
1.32      matthew  3428: 
                   3429: function set_auth_radio_buttons(newvalue,currentform) {
1.986     raeburn  3430:     var numauthchoices = currentform.login.length;
                   3431:     if (typeof numauthchoices  == "undefined") {
                   3432:         return;
                   3433:     } 
1.32      matthew  3434:     var i=0;
1.986     raeburn  3435:     while (i < numauthchoices) {
1.32      matthew  3436:         if (currentform.login[i].value == newvalue) { break; }
                   3437:         i++;
                   3438:     }
1.986     raeburn  3439:     if (i == numauthchoices) {
1.32      matthew  3440:         return;
                   3441:     }
                   3442:     current.radiovalue = newvalue;
                   3443:     currentform.login[i].checked = true;
                   3444:     return;
                   3445: }
                   3446: END
                   3447:     return $result;
                   3448: }
                   3449: 
1.1106    raeburn  3450: sub authform_authorwarning {
1.32      matthew  3451:     my $result='';
1.144     matthew  3452:     $result='<i>'.
                   3453:         &mt('As a general rule, only authors or co-authors should be '.
                   3454:             'filesystem authenticated '.
                   3455:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  3456:     return $result;
                   3457: }
                   3458: 
1.1106    raeburn  3459: sub authform_nochange {
1.32      matthew  3460:     my %in = (
                   3461:               formname => 'document.cu',
                   3462:               kerb_def_dom => 'MSU.EDU',
                   3463:               @_,
                   3464:           );
1.1106    raeburn  3465:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.586     raeburn  3466:     my $result;
1.1104    raeburn  3467:     if (!$authnum) {
1.1105    raeburn  3468:         $result = &mt('Under your current role you are not permitted to change login settings for this user');
1.586     raeburn  3469:     } else {
                   3470:         $result = '<label>'.&mt('[_1] Do not change login data',
                   3471:                   '<input type="radio" name="login" value="nochange" '.
                   3472:                   'checked="checked" onclick="'.
1.281     albertel 3473:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   3474: 	    '</label>';
1.586     raeburn  3475:     }
1.32      matthew  3476:     return $result;
                   3477: }
                   3478: 
1.591     raeburn  3479: sub authform_kerberos {
1.32      matthew  3480:     my %in = (
                   3481:               formname => 'document.cu',
                   3482:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 3483:               kerb_def_auth => 'krb4',
1.32      matthew  3484:               @_,
                   3485:               );
1.586     raeburn  3486:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1.1259    raeburn  3487:         $autharg,$jscall,$disabled);
1.1106    raeburn  3488:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80      albertel 3489:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   3490:        $check5 = ' checked="checked"';
1.80      albertel 3491:     } else {
1.772     bisitz   3492:        $check4 = ' checked="checked"';
1.80      albertel 3493:     }
1.1259    raeburn  3494:     if ($in{'readonly'}) {
                   3495:         $disabled = ' disabled="disabled"';
                   3496:     }
1.165     raeburn  3497:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  3498:     if (defined($in{'curr_authtype'})) {
                   3499:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   3500:             $krbcheck = ' checked="checked"';
1.623     raeburn  3501:             if (defined($in{'mode'})) {
                   3502:                 if ($in{'mode'} eq 'modifyuser') {
                   3503:                     $krbcheck = '';
                   3504:                 }
                   3505:             }
1.591     raeburn  3506:             if (defined($in{'curr_kerb_ver'})) {
                   3507:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   3508:                     $check5 = ' checked="checked"';
1.591     raeburn  3509:                     $check4 = '';
                   3510:                 } else {
1.772     bisitz   3511:                     $check4 = ' checked="checked"';
1.591     raeburn  3512:                     $check5 = '';
                   3513:                 }
1.586     raeburn  3514:             }
1.591     raeburn  3515:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  3516:                 $krbarg = $in{'curr_autharg'};
                   3517:             }
1.586     raeburn  3518:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  3519:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3520:                     $result = 
                   3521:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   3522:         $in{'curr_autharg'},$krbver);
                   3523:                 } else {
                   3524:                     $result =
                   3525:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   3526:                 }
                   3527:                 return $result; 
                   3528:             }
                   3529:         }
                   3530:     } else {
                   3531:         if ($authnum == 1) {
1.784     bisitz   3532:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  3533:         }
                   3534:     }
1.586     raeburn  3535:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   3536:         return;
1.587     raeburn  3537:     } elsif ($authtype eq '') {
1.591     raeburn  3538:         if (defined($in{'mode'})) {
1.587     raeburn  3539:             if ($in{'mode'} eq 'modifycourse') {
                   3540:                 if ($authnum == 1) {
1.1259    raeburn  3541:                     $authtype = '<input type="radio" name="login" value="krb"'.$disabled.' />';
1.587     raeburn  3542:                 }
                   3543:             }
                   3544:         }
1.586     raeburn  3545:     }
                   3546:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   3547:     if ($authtype eq '') {
                   3548:         $authtype = '<input type="radio" name="login" value="krb" '.
                   3549:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1.1259    raeburn  3550:                     $krbcheck.$disabled.' />';
1.586     raeburn  3551:     }
                   3552:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
1.1106    raeburn  3553:         ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
1.586     raeburn  3554:          $in{'curr_authtype'} eq 'krb5') ||
1.1106    raeburn  3555:         (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
1.586     raeburn  3556:          $in{'curr_authtype'} eq 'krb4')) {
                   3557:         $result .= &mt
1.144     matthew  3558:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 3559:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  3560:          '<label>'.$authtype,
1.281     albertel 3561:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  3562:              'value="'.$krbarg.'" '.
1.1259    raeburn  3563:              'onchange="'.$jscall.'"'.$disabled.' />',
                   3564:          '<label><input type="radio" name="krbver" value="4" '.$check4.$disabled.' />',
                   3565:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.$disabled.' />',
1.281     albertel 3566: 	 '</label>');
1.586     raeburn  3567:     } elsif ($can_assign{'krb4'}) {
                   3568:         $result .= &mt
                   3569:         ('[_1] Kerberos authenticated with domain [_2] '.
                   3570:          '[_3] Version 4 [_4]',
                   3571:          '<label>'.$authtype,
                   3572:          '</label><input type="text" size="10" name="krbarg" '.
                   3573:              'value="'.$krbarg.'" '.
1.1259    raeburn  3574:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  3575:          '<label><input type="hidden" name="krbver" value="4" />',
                   3576:          '</label>');
                   3577:     } elsif ($can_assign{'krb5'}) {
                   3578:         $result .= &mt
                   3579:         ('[_1] Kerberos authenticated with domain [_2] '.
                   3580:          '[_3] Version 5 [_4]',
                   3581:          '<label>'.$authtype,
                   3582:          '</label><input type="text" size="10" name="krbarg" '.
                   3583:              'value="'.$krbarg.'" '.
1.1259    raeburn  3584:              'onchange="'.$jscall.'"'.$disabled.' />',
1.586     raeburn  3585:          '<label><input type="hidden" name="krbver" value="5" />',
                   3586:          '</label>');
                   3587:     }
1.32      matthew  3588:     return $result;
                   3589: }
                   3590: 
1.1106    raeburn  3591: sub authform_internal {
1.586     raeburn  3592:     my %in = (
1.32      matthew  3593:                 formname => 'document.cu',
                   3594:                 kerb_def_dom => 'MSU.EDU',
                   3595:                 @_,
                   3596:                 );
1.1259    raeburn  3597:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106    raeburn  3598:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259    raeburn  3599:     if ($in{'readonly'}) {
                   3600:         $disabled = ' disabled="disabled"';
                   3601:     }
1.591     raeburn  3602:     if (defined($in{'curr_authtype'})) {
                   3603:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  3604:             if ($can_assign{'int'}) {
1.772     bisitz   3605:                 $intcheck = 'checked="checked" ';
1.623     raeburn  3606:                 if (defined($in{'mode'})) {
                   3607:                     if ($in{'mode'} eq 'modifyuser') {
                   3608:                         $intcheck = '';
                   3609:                     }
                   3610:                 }
1.591     raeburn  3611:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3612:                     $intarg = $in{'curr_autharg'};
                   3613:                 }
                   3614:             } else {
                   3615:                 $result = &mt('Currently internally authenticated.');
                   3616:                 return $result;
1.165     raeburn  3617:             }
                   3618:         }
1.586     raeburn  3619:     } else {
                   3620:         if ($authnum == 1) {
1.784     bisitz   3621:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  3622:         }
                   3623:     }
                   3624:     if (!$can_assign{'int'}) {
                   3625:         return;
1.587     raeburn  3626:     } elsif ($authtype eq '') {
1.591     raeburn  3627:         if (defined($in{'mode'})) {
1.587     raeburn  3628:             if ($in{'mode'} eq 'modifycourse') {
                   3629:                 if ($authnum == 1) {
1.1259    raeburn  3630:                     $authtype = '<input type="radio" name="login" value="int"'.$disabled.' />';
1.587     raeburn  3631:                 }
                   3632:             }
                   3633:         }
1.165     raeburn  3634:     }
1.586     raeburn  3635:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   3636:     if ($authtype eq '') {
                   3637:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
1.1259    raeburn  3638:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3639:     }
1.605     bisitz   3640:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.1259    raeburn  3641:                $intarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3642:     $result = &mt
1.144     matthew  3643:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  3644:          '<label>'.$authtype,'</label>'.$autharg);
1.1259    raeburn  3645:     $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  3646:     return $result;
                   3647: }
                   3648: 
1.1104    raeburn  3649: sub authform_local {
1.32      matthew  3650:     my %in = (
                   3651:               formname => 'document.cu',
                   3652:               kerb_def_dom => 'MSU.EDU',
                   3653:               @_,
                   3654:               );
1.1259    raeburn  3655:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall,$disabled);
1.1106    raeburn  3656:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259    raeburn  3657:     if ($in{'readonly'}) {
                   3658:         $disabled = ' disabled="disabled"';
                   3659:     } 
1.591     raeburn  3660:     if (defined($in{'curr_authtype'})) {
                   3661:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  3662:             if ($can_assign{'loc'}) {
1.772     bisitz   3663:                 $loccheck = 'checked="checked" ';
1.623     raeburn  3664:                 if (defined($in{'mode'})) {
                   3665:                     if ($in{'mode'} eq 'modifyuser') {
                   3666:                         $loccheck = '';
                   3667:                     }
                   3668:                 }
1.591     raeburn  3669:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  3670:                     $locarg = $in{'curr_autharg'};
                   3671:                 }
                   3672:             } else {
                   3673:                 $result = &mt('Currently using local (institutional) authentication.');
                   3674:                 return $result;
1.165     raeburn  3675:             }
                   3676:         }
1.586     raeburn  3677:     } else {
                   3678:         if ($authnum == 1) {
1.784     bisitz   3679:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  3680:         }
                   3681:     }
                   3682:     if (!$can_assign{'loc'}) {
                   3683:         return;
1.587     raeburn  3684:     } elsif ($authtype eq '') {
1.591     raeburn  3685:         if (defined($in{'mode'})) {
1.587     raeburn  3686:             if ($in{'mode'} eq 'modifycourse') {
                   3687:                 if ($authnum == 1) {
1.1259    raeburn  3688:                     $authtype = '<input type="radio" name="login" value="loc"'.$disabled.' />';
1.587     raeburn  3689:                 }
                   3690:             }
                   3691:         }
1.165     raeburn  3692:     }
1.586     raeburn  3693:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   3694:     if ($authtype eq '') {
                   3695:         $authtype = '<input type="radio" name="login" value="loc" '.
                   3696:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
1.1259    raeburn  3697:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3698:     }
                   3699:     $autharg = '<input type="text" size="10" name="locarg" value="'.
1.1259    raeburn  3700:                $locarg.'" onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3701:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   3702:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  3703:     return $result;
                   3704: }
                   3705: 
1.1106    raeburn  3706: sub authform_filesystem {
1.32      matthew  3707:     my %in = (
                   3708:               formname => 'document.cu',
                   3709:               kerb_def_dom => 'MSU.EDU',
                   3710:               @_,
                   3711:               );
1.1259    raeburn  3712:     my ($fsyscheck,$result,$authtype,$autharg,$jscall,$disabled);
1.1106    raeburn  3713:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.1259    raeburn  3714:     if ($in{'readonly'}) {
                   3715:         $disabled = ' disabled="disabled"';
                   3716:     }
1.591     raeburn  3717:     if (defined($in{'curr_authtype'})) {
                   3718:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  3719:             if ($can_assign{'fsys'}) {
1.772     bisitz   3720:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  3721:                 if (defined($in{'mode'})) {
                   3722:                     if ($in{'mode'} eq 'modifyuser') {
                   3723:                         $fsyscheck = '';
                   3724:                     }
                   3725:                 }
1.586     raeburn  3726:             } else {
                   3727:                 $result = &mt('Currently Filesystem Authenticated.');
                   3728:                 return $result;
1.1259    raeburn  3729:             }
1.586     raeburn  3730:         }
                   3731:     } else {
                   3732:         if ($authnum == 1) {
1.784     bisitz   3733:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  3734:         }
                   3735:     }
                   3736:     if (!$can_assign{'fsys'}) {
                   3737:         return;
1.587     raeburn  3738:     } elsif ($authtype eq '') {
1.591     raeburn  3739:         if (defined($in{'mode'})) {
1.587     raeburn  3740:             if ($in{'mode'} eq 'modifycourse') {
                   3741:                 if ($authnum == 1) {
1.1259    raeburn  3742:                     $authtype = '<input type="radio" name="login" value="fsys"'.$disabled.' />';
1.587     raeburn  3743:                 }
                   3744:             }
                   3745:         }
1.586     raeburn  3746:     }
                   3747:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   3748:     if ($authtype eq '') {
                   3749:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   3750:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
1.1259    raeburn  3751:                     $jscall.'"'.$disabled.' />';
1.586     raeburn  3752:     }
1.1310    raeburn  3753:     $autharg = '<input type="password" size="10" name="fsysarg" value=""'.
1.1259    raeburn  3754:                ' onchange="'.$jscall.'"'.$disabled.' />';
1.586     raeburn  3755:     $result = &mt
1.144     matthew  3756:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.1310    raeburn  3757:          '<label>'.$authtype,'</label>'.$autharg);
                   3758:     return $result;
                   3759: }
                   3760: 
                   3761: sub authform_lti {
                   3762:     my %in = (
                   3763:               formname => 'document.cu',
                   3764:               kerb_def_dom => 'MSU.EDU',
                   3765:               @_,
                   3766:               );
                   3767:     my ($lticheck,$result,$authtype,$autharg,$jscall,$disabled);
                   3768:     my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
                   3769:     if ($in{'readonly'}) {
                   3770:         $disabled = ' disabled="disabled"';
                   3771:     }
                   3772:     if (defined($in{'curr_authtype'})) {
                   3773:         if ($in{'curr_authtype'} eq 'lti') {
                   3774:             if ($can_assign{'lti'}) {
                   3775:                 $lticheck = 'checked="checked" ';
                   3776:                 if (defined($in{'mode'})) {
                   3777:                     if ($in{'mode'} eq 'modifyuser') {
                   3778:                         $lticheck = '';
                   3779:                     }
                   3780:                 }
                   3781:             } else {
                   3782:                 $result = &mt('Currently LTI Authenticated.');
                   3783:                 return $result;
                   3784:             }
                   3785:         }
                   3786:     } else {
                   3787:         if ($authnum == 1) {
                   3788:             $authtype = '<input type="hidden" name="login" value="lti" />';
                   3789:         }
                   3790:     }
                   3791:     if (!$can_assign{'lti'}) {
                   3792:         return;
                   3793:     } elsif ($authtype eq '') {
                   3794:         if (defined($in{'mode'})) {
                   3795:             if ($in{'mode'} eq 'modifycourse') {
                   3796:                 if ($authnum == 1) {
                   3797:                     $authtype = '<input type="radio" name="login" value="lti"'.$disabled.' />';
                   3798:                 }
                   3799:             }
                   3800:         }
                   3801:     }
                   3802:     $jscall = "javascript:changed_radio('lti',$in{'formname'});";
                   3803:     if (($authtype eq '') && (($in{'mode'} eq 'modifycourse') || ($in{'curr_authtype'} ne 'lti'))) {
                   3804:         $authtype = '<input type="radio" name="login" value="lti" '.
                   3805:                     $lticheck.' onchange="'.$jscall.'" onclick="'.
                   3806:                     $jscall.'"'.$disabled.' />';
                   3807:     }
                   3808:     $autharg = '<input type="hidden" name="ltiarg" value="" />';
                   3809:     if ($authtype) {
                   3810:         $result = &mt('[_1] LTI Authenticated',
                   3811:                       '<label>'.$authtype.'</label>'.$autharg);
                   3812:     } else {
                   3813:         $result = '<b>'.&mt('LTI Authenticated').'</b>'.
                   3814:                   $autharg;
                   3815:     }
1.32      matthew  3816:     return $result;
                   3817: }
                   3818: 
1.586     raeburn  3819: sub get_assignable_auth {
                   3820:     my ($dom) = @_;
                   3821:     if ($dom eq '') {
                   3822:         $dom = $env{'request.role.domain'};
                   3823:     }
                   3824:     my %can_assign = (
                   3825:                           krb4 => 1,
                   3826:                           krb5 => 1,
                   3827:                           int  => 1,
                   3828:                           loc  => 1,
1.1310    raeburn  3829:                           lti  => 1,
1.586     raeburn  3830:                      );
                   3831:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   3832:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   3833:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   3834:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   3835:             my $context;
                   3836:             if ($env{'request.role'} =~ /^au/) {
                   3837:                 $context = 'author';
1.1259    raeburn  3838:             } elsif ($env{'request.role'} =~ /^(dc|dh)/) {
1.586     raeburn  3839:                 $context = 'domain';
                   3840:             } elsif ($env{'request.course.id'}) {
                   3841:                 $context = 'course';
                   3842:             }
                   3843:             if ($context) {
                   3844:                 if (ref($authhash->{$context}) eq 'HASH') {
                   3845:                    %can_assign = %{$authhash->{$context}}; 
                   3846:                 }
                   3847:             }
                   3848:         }
                   3849:     }
                   3850:     my $authnum = 0;
                   3851:     foreach my $key (keys(%can_assign)) {
                   3852:         if ($can_assign{$key}) {
                   3853:             $authnum ++;
                   3854:         }
                   3855:     }
                   3856:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   3857:         $authnum --;
                   3858:     }
                   3859:     return ($authnum,%can_assign);
                   3860: }
                   3861: 
1.1331    raeburn  3862: sub check_passwd_rules {
                   3863:     my ($domain,$plainpass) = @_;
                   3864:     my %passwdconf = &Apache::lonnet::get_passwdconf($domain);
                   3865:     my ($min,$max,@chars,@brokerule,$warning);
1.1333    raeburn  3866:     $min = $Apache::lonnet::passwdmin;
1.1331    raeburn  3867:     if (ref($passwdconf{'chars'}) eq 'ARRAY') {
                   3868:         if ($passwdconf{'min'} =~ /^\d+$/) {
1.1333    raeburn  3869:             if ($passwdconf{'min'} > $min) {
                   3870:                 $min = $passwdconf{'min'};
                   3871:             }
1.1331    raeburn  3872:         }
                   3873:         if ($passwdconf{'max'} =~ /^\d+$/) {
                   3874:             $max = $passwdconf{'max'};
                   3875:         }
                   3876:         @chars = @{$passwdconf{'chars'}};
                   3877:     }
                   3878:     if (($min) && (length($plainpass) < $min)) {
                   3879:         push(@brokerule,'min');
                   3880:     }
                   3881:     if (($max) && (length($plainpass) > $max)) {
                   3882:         push(@brokerule,'max');
                   3883:     }
                   3884:     if (@chars) {
                   3885:         my %rules;
                   3886:         map { $rules{$_} = 1; } @chars;
                   3887:         if ($rules{'uc'}) {
                   3888:             unless ($plainpass =~ /[A-Z]/) {
                   3889:                 push(@brokerule,'uc');
                   3890:             }
                   3891:         }
                   3892:         if ($rules{'lc'}) {
1.1332    raeburn  3893:             unless ($plainpass =~ /[a-z]/) {
1.1331    raeburn  3894:                 push(@brokerule,'lc');
                   3895:             }
                   3896:         }
                   3897:         if ($rules{'num'}) {
                   3898:             unless ($plainpass =~ /\d/) {
                   3899:                 push(@brokerule,'num');
                   3900:             }
                   3901:         }
                   3902:         if ($rules{'spec'}) {
                   3903:             unless ($plainpass =~ /[!"#$%&'()*+,\-.\/:;<=>?@[\\\]^_`{|}~]/) {
                   3904:                 push(@brokerule,'spec');
                   3905:             }
                   3906:         }
                   3907:     }
                   3908:     if (@brokerule) {
                   3909:         my %rulenames = &Apache::lonlocal::texthash(
                   3910:             uc   => 'At least one upper case letter',
                   3911:             lc   => 'At least one lower case letter',
                   3912:             num  => 'At least one number',
                   3913:             spec => 'At least one non-alphanumeric',
                   3914:         );
                   3915:         $rulenames{'uc'} .= ': ABCDEFGHIJKLMNOPQRSTUVWXYZ';
                   3916:         $rulenames{'lc'} .= ': abcdefghijklmnopqrstuvwxyz';
                   3917:         $rulenames{'num'} .= ': 0123456789';
                   3918:         $rulenames{'spec'} .= ': !&quot;\#$%&amp;\'()*+,-./:;&lt;=&gt;?@[\]^_\`{|}~';
                   3919:         $rulenames{'min'} = &mt('Minimum password length: [_1]',$min);
                   3920:         $rulenames{'max'} = &mt('Maximum password length: [_1]',$max);
                   3921:         $warning = &mt('Password did not satisfy the following:').'<ul>';
1.1336    raeburn  3922:         foreach my $rule ('min','max','uc','lc','num','spec') {
1.1331    raeburn  3923:             if (grep(/^$rule$/,@brokerule)) {
                   3924:                 $warning .= '<li>'.$rulenames{$rule}.'</li>';
                   3925:             }
                   3926:         }
                   3927:         $warning .= '</ul>';
                   3928:     }
1.1332    raeburn  3929:     if (wantarray) {
                   3930:         return @brokerule;
                   3931:     }
1.1331    raeburn  3932:     return $warning;
                   3933: }
                   3934: 
1.1376    raeburn  3935: sub passwd_validation_js {
1.1377    raeburn  3936:     my ($currpasswdval,$domain,$context,$id) = @_;
                   3937:     my (%passwdconf,$alertmsg);
                   3938:     if ($context eq 'linkprot') {
                   3939:         my %domconfig = &Apache::lonnet::get_dom('configuration',['ltisec'],$domain);
                   3940:         if (ref($domconfig{'ltisec'}) eq 'HASH') {
                   3941:             if (ref($domconfig{'ltisec'}{'rules'}) eq 'HASH') {
                   3942:                 %passwdconf = %{$domconfig{'ltisec'}{'rules'}};
                   3943:             }
                   3944:         }
                   3945:         if ($id eq 'add') {
                   3946:             $alertmsg = &mt('Secret for added launcher did not satisfy requirement(s):').'\n\n';
                   3947:         } elsif ($id =~ /^\d+$/) {
                   3948:             my $pos = $id+1;
                   3949:             $alertmsg = &mt('Secret for launcher [_1] did not satisfy requirement(s):','#'.$pos).'\n\n';
                   3950:         } else {
                   3951:             $alertmsg = &mt('A secret did not satisfy requirement(s):').'\n\n';
                   3952:         }
                   3953:     } else {
                   3954:         %passwdconf = &Apache::lonnet::get_passwdconf($domain);
                   3955:         $alertmsg = &mt('Initial password did not satisfy requirement(s):').'\n\n';
                   3956:     }
1.1376    raeburn  3957:     my ($min,$max,@chars,$numrules,$intargjs,%alert);
                   3958:     $numrules = 0;
                   3959:     $min = $Apache::lonnet::passwdmin;
                   3960:     if (ref($passwdconf{'chars'}) eq 'ARRAY') {
                   3961:         if ($passwdconf{'min'} =~ /^\d+$/) {
                   3962:             if ($passwdconf{'min'} > $min) {
                   3963:                 $min = $passwdconf{'min'};
                   3964:             }
                   3965:         }
                   3966:         if ($passwdconf{'max'} =~ /^\d+$/) {
                   3967:             $max = $passwdconf{'max'};
                   3968:             $numrules ++;
                   3969:         }
                   3970:         @chars = @{$passwdconf{'chars'}};
                   3971:         if (@chars) {
                   3972:             $numrules ++;
                   3973:         }
                   3974:     }
                   3975:     if ($min > 0) {
                   3976:         $numrules ++;
                   3977:     }
                   3978:     if (($min > 0) || ($max ne '') || (@chars > 0)) {
                   3979:         if ($min) {
                   3980:             $alert{'min'} = &mt('minimum [quant,_1,character]',$min).'\n';
                   3981:         }
                   3982:         if ($max) {
                   3983:             $alert{'max'} = &mt('maximum [quant,_1,character]',$max).'\n';
                   3984:         }
                   3985:         my (@charalerts,@charrules);
                   3986:         if (@chars) {
                   3987:             if (grep(/^uc$/,@chars)) {
                   3988:                 push(@charalerts,&mt('contain at least one upper case letter'));
                   3989:                 push(@charrules,'uc');
                   3990:             }
                   3991:             if (grep(/^lc$/,@chars)) {
                   3992:                 push(@charalerts,&mt('contain at least one lower case letter'));
                   3993:                 push(@charrules,'lc');
                   3994:             }
                   3995:             if (grep(/^num$/,@chars)) {
                   3996:                 push(@charalerts,&mt('contain at least one number'));
                   3997:                 push(@charrules,'num');
                   3998:             }
                   3999:             if (grep(/^spec$/,@chars)) {
                   4000:                 push(@charalerts,&mt('contain at least one non-alphanumeric'));
                   4001:                 push(@charrules,'spec');
                   4002:             }
                   4003:         }
                   4004:         $intargjs = qq|            var rulesmsg = '';\n|.
                   4005:                     qq|            var currpwval = $currpasswdval;\n|;
                   4006:             if ($min) {
                   4007:                 $intargjs .= qq|
                   4008:             if (currpwval.length < $min) {
                   4009:                 rulesmsg += ' - $alert{min}';
                   4010:             }
                   4011: |;
                   4012:             }
                   4013:             if ($max) {
                   4014:                 $intargjs .= qq|
                   4015:             if (currpwval.length > $max) {
                   4016:                 rulesmsg += ' - $alert{max}';
                   4017:             }
                   4018: |;
                   4019:             }
                   4020:             if (@chars > 0) {
                   4021:                 my $charrulestr = '"'.join('","',@charrules).'"';
                   4022:                 my $charalertstr = '"'.join('","',@charalerts).'"';
                   4023:                 $intargjs .= qq|            var brokerules = new Array();\n|.
                   4024:                              qq|            var charrules = new Array($charrulestr);\n|.
                   4025:                              qq|            var charalerts = new Array($charalertstr);\n|;
                   4026:                 my %rules;
                   4027:                 map { $rules{$_} = 1; } @chars;
                   4028:                 if ($rules{'uc'}) {
                   4029:                     $intargjs .= qq|
                   4030:             var ucRegExp = /[A-Z]/;
                   4031:             if (!ucRegExp.test(currpwval)) {
                   4032:                 brokerules.push('uc');
                   4033:             }
                   4034: |;
                   4035:                 }
                   4036:                 if ($rules{'lc'}) {
                   4037:                     $intargjs .= qq|
                   4038:             var lcRegExp = /[a-z]/;
                   4039:             if (!lcRegExp.test(currpwval)) {
                   4040:                 brokerules.push('lc');
                   4041:             }
                   4042: |;
                   4043:                 }
                   4044:                 if ($rules{'num'}) {
                   4045:                      $intargjs .= qq|
                   4046:             var numRegExp = /[0-9]/;
                   4047:             if (!numRegExp.test(currpwval)) {
                   4048:                 brokerules.push('num');
                   4049:             }
                   4050: |;
                   4051:                 }
                   4052:                 if ($rules{'spec'}) {
                   4053:                      $intargjs .= q|
                   4054:             var specRegExp = /[!"#$%&'()*+,\-.\/:;<=>?@[\\^\]_`{\|}~]/;
                   4055:             if (!specRegExp.test(currpwval)) {
                   4056:                 brokerules.push('spec');
                   4057:             }
                   4058: |;
                   4059:                 }
                   4060:                 $intargjs .= qq|
                   4061:             if (brokerules.length > 0) {
                   4062:                 for (var i=0; i<brokerules.length; i++) {
                   4063:                     for (var j=0; j<charrules.length; j++) {
                   4064:                         if (brokerules[i] == charrules[j]) {
                   4065:                             rulesmsg += ' - '+charalerts[j]+'\\n';
                   4066:                             break;
                   4067:                         }
                   4068:                     }
                   4069:                 }
                   4070:             }
                   4071: |;
                   4072:             }
                   4073:             $intargjs .= qq|
                   4074:             if (rulesmsg != '') {
                   4075:                 rulesmsg = '$alertmsg'+rulesmsg;
                   4076:                 alert(rulesmsg);
                   4077:                 return false;
                   4078:             }
                   4079: |;
                   4080:     }
                   4081:     return ($numrules,$intargjs);
                   4082: }
                   4083: 
1.80      albertel 4084: ###############################################################
                   4085: ##    Get Kerberos Defaults for Domain                 ##
                   4086: ###############################################################
                   4087: ##
                   4088: ## Returns default kerberos version and an associated argument
                   4089: ## as listed in file domain.tab. If not listed, provides
                   4090: ## appropriate default domain and kerberos version.
                   4091: ##
                   4092: #-------------------------------------------
                   4093: 
                   4094: =pod
                   4095: 
1.648     raeburn  4096: =item * &get_kerberos_defaults()
1.80      albertel 4097: 
                   4098: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  4099: version and domain. If not found, it defaults to version 4 and the 
                   4100: domain of the server.
1.80      albertel 4101: 
1.648     raeburn  4102: =over 4
                   4103: 
1.80      albertel 4104: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   4105: 
1.648     raeburn  4106: =back
                   4107: 
                   4108: =back
                   4109: 
1.80      albertel 4110: =cut
                   4111: 
                   4112: #-------------------------------------------
                   4113: sub get_kerberos_defaults {
                   4114:     my $domain=shift;
1.641     raeburn  4115:     my ($krbdef,$krbdefdom);
                   4116:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   4117:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   4118:         $krbdef = $domdefaults{'auth_def'};
                   4119:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   4120:     } else {
1.80      albertel 4121:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   4122:         my $krbdefdom=$1;
                   4123:         $krbdefdom=~tr/a-z/A-Z/;
                   4124:         $krbdef = "krb4";
                   4125:     }
                   4126:     return ($krbdef,$krbdefdom);
                   4127: }
1.112     bowersj2 4128: 
1.32      matthew  4129: 
1.46      matthew  4130: ###############################################################
                   4131: ##                Thesaurus Functions                        ##
                   4132: ###############################################################
1.20      www      4133: 
1.46      matthew  4134: =pod
1.20      www      4135: 
1.112     bowersj2 4136: =head1 Thesaurus Functions
                   4137: 
                   4138: =over 4
                   4139: 
1.648     raeburn  4140: =item * &initialize_keywords()
1.46      matthew  4141: 
                   4142: Initializes the package variable %Keywords if it is empty.  Uses the
                   4143: package variable $thesaurus_db_file.
                   4144: 
                   4145: =cut
                   4146: 
                   4147: ###################################################
                   4148: 
                   4149: sub initialize_keywords {
                   4150:     return 1 if (scalar keys(%Keywords));
                   4151:     # If we are here, %Keywords is empty, so fill it up
                   4152:     #   Make sure the file we need exists...
                   4153:     if (! -e $thesaurus_db_file) {
                   4154:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   4155:                                  " failed because it does not exist");
                   4156:         return 0;
                   4157:     }
                   4158:     #   Set up the hash as a database
                   4159:     my %thesaurus_db;
                   4160:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 4161:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  4162:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   4163:                                  $thesaurus_db_file);
                   4164:         return 0;
                   4165:     } 
                   4166:     #  Get the average number of appearances of a word.
                   4167:     my $avecount = $thesaurus_db{'average.count'};
                   4168:     #  Put keywords (those that appear > average) into %Keywords
                   4169:     while (my ($word,$data)=each (%thesaurus_db)) {
                   4170:         my ($count,undef) = split /:/,$data;
                   4171:         $Keywords{$word}++ if ($count > $avecount);
                   4172:     }
                   4173:     untie %thesaurus_db;
                   4174:     # Remove special values from %Keywords.
1.356     albertel 4175:     foreach my $value ('total.count','average.count') {
                   4176:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  4177:   }
1.46      matthew  4178:     return 1;
                   4179: }
                   4180: 
                   4181: ###################################################
                   4182: 
                   4183: =pod
                   4184: 
1.648     raeburn  4185: =item * &keyword($word)
1.46      matthew  4186: 
                   4187: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   4188: than the average number of times in the thesaurus database.  Calls 
                   4189: &initialize_keywords
                   4190: 
                   4191: =cut
                   4192: 
                   4193: ###################################################
1.20      www      4194: 
                   4195: sub keyword {
1.46      matthew  4196:     return if (!&initialize_keywords());
                   4197:     my $word=lc(shift());
                   4198:     $word=~s/\W//g;
                   4199:     return exists($Keywords{$word});
1.20      www      4200: }
1.46      matthew  4201: 
                   4202: ###############################################################
                   4203: 
                   4204: =pod 
1.20      www      4205: 
1.648     raeburn  4206: =item * &get_related_words()
1.46      matthew  4207: 
1.160     matthew  4208: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  4209: an array of words.  If the keyword is not in the thesaurus, an empty array
                   4210: will be returned.  The order of the words returned is determined by the
                   4211: database which holds them.
                   4212: 
                   4213: Uses global $thesaurus_db_file.
                   4214: 
1.1057    foxr     4215: 
1.46      matthew  4216: =cut
                   4217: 
                   4218: ###############################################################
                   4219: sub get_related_words {
                   4220:     my $keyword = shift;
                   4221:     my %thesaurus_db;
                   4222:     if (! -e $thesaurus_db_file) {
                   4223:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   4224:                                  "failed because the file does not exist");
                   4225:         return ();
                   4226:     }
                   4227:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 4228:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  4229:         return ();
                   4230:     } 
                   4231:     my @Words=();
1.429     www      4232:     my $count=0;
1.46      matthew  4233:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 4234: 	# The first element is the number of times
                   4235: 	# the word appears.  We do not need it now.
1.429     www      4236: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   4237: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   4238: 	my $threshold=$mostfrequentcount/10;
                   4239:         foreach my $possibleword (@RelatedWords) {
                   4240:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   4241:             if ($wordcount>$threshold) {
                   4242: 		push(@Words,$word);
                   4243:                 $count++;
                   4244:                 if ($count>10) { last; }
                   4245: 	    }
1.20      www      4246:         }
                   4247:     }
1.46      matthew  4248:     untie %thesaurus_db;
                   4249:     return @Words;
1.14      harris41 4250: }
1.1090    foxr     4251: ###############################################################
                   4252: #
                   4253: #  Spell checking
                   4254: #
                   4255: 
                   4256: =pod
                   4257: 
1.1142    raeburn  4258: =back
                   4259: 
1.1090    foxr     4260: =head1 Spell checking
                   4261: 
                   4262: =over 4
                   4263: 
                   4264: =item * &check_spelling($wordlist $language)
                   4265: 
                   4266: Takes a string containing words and feeds it to an external
                   4267: spellcheck program via a pipeline. Returns a string containing
                   4268: them mis-spelled words.
                   4269: 
                   4270: Parameters:
                   4271: 
                   4272: =over 4
                   4273: 
                   4274: =item - $wordlist
                   4275: 
                   4276: String that will be fed into the spellcheck program.
                   4277: 
                   4278: =item - $language
                   4279: 
                   4280: Language string that specifies the language for which the spell
                   4281: check will be performed.
                   4282: 
                   4283: =back
                   4284: 
                   4285: =back
                   4286: 
                   4287: Note: This sub assumes that aspell is installed.
                   4288: 
                   4289: 
                   4290: =cut
                   4291: 
1.46      matthew  4292: 
1.1090    foxr     4293: sub check_spelling {
                   4294:     my ($wordlist, $language) = @_;
1.1091    foxr     4295:     my @misspellings;
                   4296:     
                   4297:     # Generate the speller and set the langauge.
                   4298:     # if explicitly selected:
1.1090    foxr     4299: 
1.1091    foxr     4300:     my $speller = Text::Aspell->new;
1.1090    foxr     4301:     if ($language) {
1.1091    foxr     4302: 	$speller->set_option('lang', $language);
1.1090    foxr     4303:     }
                   4304: 
1.1091    foxr     4305:     # Turn the word list into an array of words by splittingon whitespace
1.1090    foxr     4306: 
1.1091    foxr     4307:     my @words = split(/\s+/, $wordlist);
1.1090    foxr     4308: 
1.1091    foxr     4309:     foreach my $word (@words) {
                   4310: 	if(! $speller->check($word)) {
                   4311: 	    push(@misspellings, $word);
1.1090    foxr     4312: 	}
                   4313:     }
1.1091    foxr     4314:     return join(' ', @misspellings);
                   4315:     
1.1090    foxr     4316: }
                   4317: 
1.61      www      4318: # -------------------------------------------------------------- Plaintext name
1.81      albertel 4319: =pod
                   4320: 
1.112     bowersj2 4321: =head1 User Name Functions
                   4322: 
                   4323: =over 4
                   4324: 
1.648     raeburn  4325: =item * &plainname($uname,$udom,$first)
1.81      albertel 4326: 
1.112     bowersj2 4327: Takes a users logon name and returns it as a string in
1.226     albertel 4328: "first middle last generation" form 
                   4329: if $first is set to 'lastname' then it returns it as
                   4330: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 4331: 
                   4332: =cut
1.61      www      4333: 
1.295     www      4334: 
1.81      albertel 4335: ###############################################################
1.61      www      4336: sub plainname {
1.226     albertel 4337:     my ($uname,$udom,$first)=@_;
1.537     albertel 4338:     return if (!defined($uname) || !defined($udom));
1.295     www      4339:     my %names=&getnames($uname,$udom);
1.226     albertel 4340:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   4341: 					  $names{'middlename'},
                   4342: 					  $names{'lastname'},
                   4343: 					  $names{'generation'},$first);
                   4344:     $name=~s/^\s+//;
1.62      www      4345:     $name=~s/\s+$//;
                   4346:     $name=~s/\s+/ /g;
1.353     albertel 4347:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      4348:     return $name;
1.61      www      4349: }
1.66      www      4350: 
                   4351: # -------------------------------------------------------------------- Nickname
1.81      albertel 4352: =pod
                   4353: 
1.648     raeburn  4354: =item * &nickname($uname,$udom)
1.81      albertel 4355: 
                   4356: Gets a users name and returns it as a string as
                   4357: 
                   4358: "&quot;nickname&quot;"
1.66      www      4359: 
1.81      albertel 4360: if the user has a nickname or
                   4361: 
                   4362: "first middle last generation"
                   4363: 
                   4364: if the user does not
                   4365: 
                   4366: =cut
1.66      www      4367: 
                   4368: sub nickname {
                   4369:     my ($uname,$udom)=@_;
1.537     albertel 4370:     return if (!defined($uname) || !defined($udom));
1.295     www      4371:     my %names=&getnames($uname,$udom);
1.68      albertel 4372:     my $name=$names{'nickname'};
1.66      www      4373:     if ($name) {
                   4374:        $name='&quot;'.$name.'&quot;'; 
                   4375:     } else {
                   4376:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   4377: 	     $names{'lastname'}.' '.$names{'generation'};
                   4378:        $name=~s/\s+$//;
                   4379:        $name=~s/\s+/ /g;
                   4380:     }
                   4381:     return $name;
                   4382: }
                   4383: 
1.295     www      4384: sub getnames {
                   4385:     my ($uname,$udom)=@_;
1.537     albertel 4386:     return if (!defined($uname) || !defined($udom));
1.433     albertel 4387:     if ($udom eq 'public' && $uname eq 'public') {
                   4388: 	return ('lastname' => &mt('Public'));
                   4389:     }
1.295     www      4390:     my $id=$uname.':'.$udom;
                   4391:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   4392:     if ($cached) {
                   4393: 	return %{$names};
                   4394:     } else {
                   4395: 	my %loadnames=&Apache::lonnet::get('environment',
                   4396:                     ['firstname','middlename','lastname','generation','nickname'],
                   4397: 					 $udom,$uname);
                   4398: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   4399: 	return %loadnames;
                   4400:     }
                   4401: }
1.61      www      4402: 
1.542     raeburn  4403: # -------------------------------------------------------------------- getemails
1.648     raeburn  4404: 
1.542     raeburn  4405: =pod
                   4406: 
1.648     raeburn  4407: =item * &getemails($uname,$udom)
1.542     raeburn  4408: 
                   4409: Gets a user's email information and returns it as a hash with keys:
                   4410: notification, critnotification, permanentemail
                   4411: 
                   4412: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  4413: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  4414:  
1.648     raeburn  4415: 
1.542     raeburn  4416: =cut
                   4417: 
1.648     raeburn  4418: 
1.466     albertel 4419: sub getemails {
                   4420:     my ($uname,$udom)=@_;
                   4421:     if ($udom eq 'public' && $uname eq 'public') {
                   4422: 	return;
                   4423:     }
1.467     www      4424:     if (!$udom) { $udom=$env{'user.domain'}; }
                   4425:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 4426:     my $id=$uname.':'.$udom;
                   4427:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   4428:     if ($cached) {
                   4429: 	return %{$names};
                   4430:     } else {
                   4431: 	my %loadnames=&Apache::lonnet::get('environment',
                   4432:                     			   ['notification','critnotification',
                   4433: 					    'permanentemail'],
                   4434: 					   $udom,$uname);
                   4435: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   4436: 	return %loadnames;
                   4437:     }
                   4438: }
                   4439: 
1.551     albertel 4440: sub flush_email_cache {
                   4441:     my ($uname,$udom)=@_;
                   4442:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   4443:     if (!$uname) { $uname=$env{'user.name'};   }
                   4444:     return if ($udom eq 'public' && $uname eq 'public');
                   4445:     my $id=$uname.':'.$udom;
                   4446:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   4447: }
                   4448: 
1.728     raeburn  4449: # -------------------------------------------------------------------- getlangs
                   4450: 
                   4451: =pod
                   4452: 
                   4453: =item * &getlangs($uname,$udom)
                   4454: 
                   4455: Gets a user's language preference and returns it as a hash with key:
                   4456: language.
                   4457: 
                   4458: =cut
                   4459: 
                   4460: 
                   4461: sub getlangs {
                   4462:     my ($uname,$udom) = @_;
                   4463:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   4464:     if (!$uname) { $uname=$env{'user.name'};   }
                   4465:     my $id=$uname.':'.$udom;
                   4466:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   4467:     if ($cached) {
                   4468:         return %{$langs};
                   4469:     } else {
                   4470:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   4471:                                            $udom,$uname);
                   4472:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   4473:         return %loadlangs;
                   4474:     }
                   4475: }
                   4476: 
                   4477: sub flush_langs_cache {
                   4478:     my ($uname,$udom)=@_;
                   4479:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   4480:     if (!$uname) { $uname=$env{'user.name'};   }
                   4481:     return if ($udom eq 'public' && $uname eq 'public');
                   4482:     my $id=$uname.':'.$udom;
                   4483:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   4484: }
                   4485: 
1.61      www      4486: # ------------------------------------------------------------------ Screenname
1.81      albertel 4487: 
                   4488: =pod
                   4489: 
1.648     raeburn  4490: =item * &screenname($uname,$udom)
1.81      albertel 4491: 
                   4492: Gets a users screenname and returns it as a string
                   4493: 
                   4494: =cut
1.61      www      4495: 
                   4496: sub screenname {
                   4497:     my ($uname,$udom)=@_;
1.258     albertel 4498:     if ($uname eq $env{'user.name'} &&
                   4499: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 4500:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 4501:     return $names{'screenname'};
1.62      www      4502: }
                   4503: 
1.212     albertel 4504: 
1.802     bisitz   4505: # ------------------------------------------------------------- Confirm Wrapper
                   4506: =pod
                   4507: 
1.1142    raeburn  4508: =item * &confirmwrapper($message)
1.802     bisitz   4509: 
                   4510: Wrap messages about completion of operation in box
                   4511: 
                   4512: =cut
                   4513: 
                   4514: sub confirmwrapper {
                   4515:     my ($message)=@_;
                   4516:     if ($message) {
                   4517:         return "\n".'<div class="LC_confirm_box">'."\n"
                   4518:                .$message."\n"
                   4519:                .'</div>'."\n";
                   4520:     } else {
                   4521:         return $message;
                   4522:     }
                   4523: }
                   4524: 
1.62      www      4525: # ------------------------------------------------------------- Message Wrapper
                   4526: 
                   4527: sub messagewrapper {
1.369     www      4528:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      4529:     return 
1.441     albertel 4530:         '<a href="/adm/email?compose=individual&amp;'.
                   4531:         'recname='.$username.'&amp;recdom='.$domain.
                   4532: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  4533:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      4534: }
1.802     bisitz   4535: 
1.74      www      4536: # --------------------------------------------------------------- Notes Wrapper
                   4537: 
                   4538: sub noteswrapper {
                   4539:     my ($link,$un,$do)=@_;
                   4540:     return 
1.896     amueller 4541: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      4542: }
1.802     bisitz   4543: 
1.62      www      4544: # ------------------------------------------------------------- Aboutme Wrapper
                   4545: 
                   4546: sub aboutmewrapper {
1.1070    raeburn  4547:     my ($link,$username,$domain,$target,$class)=@_;
1.447     raeburn  4548:     if (!defined($username)  && !defined($domain)) {
                   4549:         return;
                   4550:     }
1.1096    raeburn  4551:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.1070    raeburn  4552: 	($target?' target="'.$target.'"':'').($class?' class="'.$class.'"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      4553: }
                   4554: 
                   4555: # ------------------------------------------------------------ Syllabus Wrapper
                   4556: 
                   4557: sub syllabuswrapper {
1.707     bisitz   4558:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  4559:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      4560: }
1.14      harris41 4561: 
1.1397    raeburn  4562: # -----------------------------------------------------------------------------
                   4563: 
1.1396    raeburn  4564: sub aboutme_on {
                   4565:     my ($uname,$udom)=@_;
                   4566:     unless ($uname) { $uname=$env{'user.name'}; }
                   4567:     unless ($udom)  { $udom=$env{'user.domain'}; }
                   4568:     return if ($udom eq 'public' && $uname eq 'public');
                   4569:     my $hashkey=$uname.':'.$udom;
                   4570:     my ($aboutme,$cached)=&Apache::lonnet::is_cached_new('aboutme',$hashkey);
                   4571:     if ($cached) {
                   4572:         return $aboutme;
                   4573:     }
                   4574:     $aboutme = &Apache::lonnet::usertools_access($uname,$udom,'aboutme');
                   4575:     &Apache::lonnet::do_cache_new('aboutme',$hashkey,$aboutme,3600);
                   4576:     return $aboutme;
                   4577: }
                   4578: 
                   4579: sub devalidate_aboutme_cache {
                   4580:     my ($uname,$udom)=@_;
                   4581:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   4582:     if (!$uname) { $uname=$env{'user.name'};   }
                   4583:     return if ($udom eq 'public' && $uname eq 'public');
                   4584:     my $id=$uname.':'.$udom;
                   4585:     &Apache::lonnet::devalidate_cache_new('aboutme',$id);
                   4586: }
                   4587: 
1.208     matthew  4588: sub track_student_link {
1.887     raeburn  4589:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 4590:     my $link ="/adm/trackstudent?";
1.208     matthew  4591:     my $title = 'View recent activity';
                   4592:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   4593:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 4594:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  4595:         $title .= ' of this student';
1.268     albertel 4596:     } 
1.208     matthew  4597:     if (defined($target) && $target !~ /^\s*$/) {
                   4598:         $target = qq{target="$target"};
                   4599:     } else {
                   4600:         $target = '';
                   4601:     }
1.268     albertel 4602:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  4603:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 4604:     $title = &mt($title);
                   4605:     $linktext = &mt($linktext);
1.448     albertel 4606:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   4607: 	&help_open_topic('View_recent_activity');
1.208     matthew  4608: }
                   4609: 
1.781     raeburn  4610: sub slot_reservations_link {
                   4611:     my ($linktext,$sname,$sdom,$target) = @_;
                   4612:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   4613:     my $title = 'View slot reservation history';
                   4614:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   4615:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   4616:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   4617:         $title .= ' of this student';
                   4618:     }
                   4619:     if (defined($target) && $target !~ /^\s*$/) {
                   4620:         $target = qq{target="$target"};
                   4621:     } else {
                   4622:         $target = '';
                   4623:     }
                   4624:     $title = &mt($title);
                   4625:     $linktext = &mt($linktext);
                   4626:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   4627: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   4628: 
                   4629: }
                   4630: 
1.508     www      4631: # ===================================================== Display a student photo
                   4632: 
                   4633: 
1.509     albertel 4634: sub student_image_tag {
1.508     www      4635:     my ($domain,$user)=@_;
                   4636:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   4637:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   4638: 	return '<img src="'.$imgsrc.'" align="right" />';
                   4639:     } else {
                   4640: 	return '';
                   4641:     }
                   4642: }
                   4643: 
1.112     bowersj2 4644: =pod
                   4645: 
                   4646: =back
                   4647: 
                   4648: =head1 Access .tab File Data
                   4649: 
                   4650: =over 4
                   4651: 
1.648     raeburn  4652: =item * &languageids() 
1.112     bowersj2 4653: 
                   4654: returns list of all language ids
                   4655: 
                   4656: =cut
                   4657: 
1.14      harris41 4658: sub languageids {
1.16      harris41 4659:     return sort(keys(%language));
1.14      harris41 4660: }
                   4661: 
1.112     bowersj2 4662: =pod
                   4663: 
1.648     raeburn  4664: =item * &languagedescription() 
1.112     bowersj2 4665: 
                   4666: returns description of a specified language id
                   4667: 
                   4668: =cut
                   4669: 
1.14      harris41 4670: sub languagedescription {
1.125     www      4671:     my $code=shift;
                   4672:     return  ($supported_language{$code}?'* ':'').
                   4673:             $language{$code}.
1.126     www      4674: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      4675: }
                   4676: 
1.1048    foxr     4677: =pod
                   4678: 
                   4679: =item * &plainlanguagedescription
                   4680: 
                   4681: Returns both the plain language description (e.g. 'Creoles and Pidgins, English-based (Other)')
                   4682: and the language character encoding (e.g. ISO) separated by a ' - ' string.
                   4683: 
                   4684: =cut
                   4685: 
1.145     www      4686: sub plainlanguagedescription {
                   4687:     my $code=shift;
                   4688:     return $language{$code};
                   4689: }
                   4690: 
1.1048    foxr     4691: =pod
                   4692: 
                   4693: =item * &supportedlanguagecode
                   4694: 
                   4695: Returns the supported language code (e.g. sptutf maps to pt) given a language
                   4696: code.
                   4697: 
                   4698: =cut
                   4699: 
1.145     www      4700: sub supportedlanguagecode {
                   4701:     my $code=shift;
                   4702:     return $supported_language{$code};
1.97      www      4703: }
                   4704: 
1.112     bowersj2 4705: =pod
                   4706: 
1.1048    foxr     4707: =item * &latexlanguage()
                   4708: 
                   4709: Given a language key code returns the correspondnig language to use
                   4710: to select the correct hyphenation on LaTeX printouts.  This is undef if there
                   4711: is no supported hyphenation for the language code.
                   4712: 
                   4713: =cut
                   4714: 
                   4715: sub latexlanguage {
                   4716:     my $code = shift;
                   4717:     return $latex_language{$code};
                   4718: }
                   4719: 
                   4720: =pod
                   4721: 
                   4722: =item * &latexhyphenation()
                   4723: 
                   4724: Same as above but what's supplied is the language as it might be stored
                   4725: in the metadata.
                   4726: 
                   4727: =cut
                   4728: 
                   4729: sub latexhyphenation {
                   4730:     my $key = shift;
                   4731:     return $latex_language_bykey{$key};
                   4732: }
                   4733: 
                   4734: =pod
                   4735: 
1.648     raeburn  4736: =item * &copyrightids() 
1.112     bowersj2 4737: 
                   4738: returns list of all copyrights
                   4739: 
                   4740: =cut
                   4741: 
                   4742: sub copyrightids {
                   4743:     return sort(keys(%cprtag));
                   4744: }
                   4745: 
                   4746: =pod
                   4747: 
1.648     raeburn  4748: =item * &copyrightdescription() 
1.112     bowersj2 4749: 
                   4750: returns description of a specified copyright id
                   4751: 
                   4752: =cut
                   4753: 
                   4754: sub copyrightdescription {
1.166     www      4755:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 4756: }
1.197     matthew  4757: 
                   4758: =pod
                   4759: 
1.648     raeburn  4760: =item * &source_copyrightids() 
1.192     taceyjo1 4761: 
                   4762: returns list of all source copyrights
                   4763: 
                   4764: =cut
                   4765: 
                   4766: sub source_copyrightids {
                   4767:     return sort(keys(%scprtag));
                   4768: }
                   4769: 
                   4770: =pod
                   4771: 
1.648     raeburn  4772: =item * &source_copyrightdescription() 
1.192     taceyjo1 4773: 
                   4774: returns description of a specified source copyright id
                   4775: 
                   4776: =cut
                   4777: 
                   4778: sub source_copyrightdescription {
                   4779:     return &mt($scprtag{shift(@_)});
                   4780: }
1.112     bowersj2 4781: 
                   4782: =pod
                   4783: 
1.648     raeburn  4784: =item * &filecategories() 
1.112     bowersj2 4785: 
                   4786: returns list of all file categories
                   4787: 
                   4788: =cut
                   4789: 
                   4790: sub filecategories {
                   4791:     return sort(keys(%category_extensions));
                   4792: }
                   4793: 
                   4794: =pod
                   4795: 
1.648     raeburn  4796: =item * &filecategorytypes() 
1.112     bowersj2 4797: 
                   4798: returns list of file types belonging to a given file
                   4799: category
                   4800: 
                   4801: =cut
                   4802: 
                   4803: sub filecategorytypes {
1.356     albertel 4804:     my ($cat) = @_;
1.1248    raeburn  4805:     if (ref($category_extensions{lc($cat)}) eq 'ARRAY') { 
                   4806:         return @{$category_extensions{lc($cat)}};
                   4807:     } else {
                   4808:         return ();
                   4809:     }
1.112     bowersj2 4810: }
                   4811: 
                   4812: =pod
                   4813: 
1.648     raeburn  4814: =item * &fileembstyle() 
1.112     bowersj2 4815: 
                   4816: returns embedding style for a specified file type
                   4817: 
                   4818: =cut
                   4819: 
                   4820: sub fileembstyle {
                   4821:     return $fe{lc(shift(@_))};
1.169     www      4822: }
                   4823: 
1.351     www      4824: sub filemimetype {
                   4825:     return $fm{lc(shift(@_))};
                   4826: }
                   4827: 
1.169     www      4828: 
                   4829: sub filecategoryselect {
                   4830:     my ($name,$value)=@_;
1.189     matthew  4831:     return &select_form($value,$name,
1.970     raeburn  4832:                         {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))});
1.112     bowersj2 4833: }
                   4834: 
                   4835: =pod
                   4836: 
1.648     raeburn  4837: =item * &filedescription() 
1.112     bowersj2 4838: 
                   4839: returns description for a specified file type
                   4840: 
                   4841: =cut
                   4842: 
                   4843: sub filedescription {
1.188     matthew  4844:     my $file_description = $fd{lc(shift())};
                   4845:     $file_description =~ s:([\[\]]):~$1:g;
                   4846:     return &mt($file_description);
1.112     bowersj2 4847: }
                   4848: 
                   4849: =pod
                   4850: 
1.648     raeburn  4851: =item * &filedescriptionex() 
1.112     bowersj2 4852: 
                   4853: returns description for a specified file type with
                   4854: extra formatting
                   4855: 
                   4856: =cut
                   4857: 
                   4858: sub filedescriptionex {
                   4859:     my $ex=shift;
1.188     matthew  4860:     my $file_description = $fd{lc($ex)};
                   4861:     $file_description =~ s:([\[\]]):~$1:g;
                   4862:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 4863: }
                   4864: 
                   4865: # End of .tab access
                   4866: =pod
                   4867: 
                   4868: =back
                   4869: 
                   4870: =cut
                   4871: 
                   4872: # ------------------------------------------------------------------ File Types
                   4873: sub fileextensions {
                   4874:     return sort(keys(%fe));
                   4875: }
                   4876: 
1.97      www      4877: # ----------------------------------------------------------- Display Languages
                   4878: # returns a hash with all desired display languages
                   4879: #
                   4880: 
                   4881: sub display_languages {
                   4882:     my %languages=();
1.695     raeburn  4883:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 4884: 	$languages{$lang}=1;
1.97      www      4885:     }
                   4886:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 4887:     if ($env{'form.displaylanguage'}) {
1.356     albertel 4888: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   4889: 	    $languages{$lang}=1;
1.97      www      4890:         }
                   4891:     }
                   4892:     return %languages;
1.14      harris41 4893: }
                   4894: 
1.582     albertel 4895: sub languages {
                   4896:     my ($possible_langs) = @_;
1.695     raeburn  4897:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 4898:     if (!ref($possible_langs)) {
                   4899: 	if( wantarray ) {
                   4900: 	    return @preferred_langs;
                   4901: 	} else {
                   4902: 	    return $preferred_langs[0];
                   4903: 	}
                   4904:     }
                   4905:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   4906:     my @preferred_possibilities;
                   4907:     foreach my $preferred_lang (@preferred_langs) {
                   4908: 	if (exists($possibilities{$preferred_lang})) {
                   4909: 	    push(@preferred_possibilities, $preferred_lang);
                   4910: 	}
                   4911:     }
                   4912:     if( wantarray ) {
                   4913: 	return @preferred_possibilities;
                   4914:     }
                   4915:     return $preferred_possibilities[0];
                   4916: }
                   4917: 
1.742     raeburn  4918: sub user_lang {
                   4919:     my ($touname,$toudom,$fromcid) = @_;
                   4920:     my @userlangs;
                   4921:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   4922:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   4923:                     $env{'course.'.$fromcid.'.languages'}));
                   4924:     } else {
                   4925:         my %langhash = &getlangs($touname,$toudom);
                   4926:         if ($langhash{'languages'} ne '') {
                   4927:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   4928:         } else {
                   4929:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   4930:             if ($domdefs{'lang_def'} ne '') {
                   4931:                 @userlangs = ($domdefs{'lang_def'});
                   4932:             }
                   4933:         }
                   4934:     }
                   4935:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   4936:     my $user_lh = Apache::localize->get_handle(@languages);
                   4937:     return $user_lh;
                   4938: }
                   4939: 
                   4940: 
1.112     bowersj2 4941: ###############################################################
                   4942: ##               Student Answer Attempts                     ##
                   4943: ###############################################################
                   4944: 
                   4945: =pod
                   4946: 
                   4947: =head1 Alternate Problem Views
                   4948: 
                   4949: =over 4
                   4950: 
1.648     raeburn  4951: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.1199    raeburn  4952:     $getattempt, $regexp, $gradesub, $usec, $identifier)
1.112     bowersj2 4953: 
                   4954: Return string with previous attempt on problem. Arguments:
                   4955: 
                   4956: =over 4
                   4957: 
                   4958: =item * $symb: Problem, including path
                   4959: 
                   4960: =item * $username: username of the desired student
                   4961: 
                   4962: =item * $domain: domain of the desired student
1.14      harris41 4963: 
1.112     bowersj2 4964: =item * $course: Course ID
1.14      harris41 4965: 
1.112     bowersj2 4966: =item * $getattempt: Leave blank for all attempts, otherwise put
                   4967:     something
1.14      harris41 4968: 
1.112     bowersj2 4969: =item * $regexp: if string matches this regexp, the string will be
                   4970:     sent to $gradesub
1.14      harris41 4971: 
1.112     bowersj2 4972: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 4973: 
1.1199    raeburn  4974: =item * $usec: section of the desired student
                   4975: 
                   4976: =item * $identifier: counter for student (multiple students one problem) or 
                   4977:     problem (one student; whole sequence).
                   4978: 
1.112     bowersj2 4979: =back
1.14      harris41 4980: 
1.112     bowersj2 4981: The output string is a table containing all desired attempts, if any.
1.16      harris41 4982: 
1.112     bowersj2 4983: =cut
1.1       albertel 4984: 
                   4985: sub get_previous_attempt {
1.1199    raeburn  4986:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub,$usec,$identifier)=@_;
1.1       albertel 4987:   my $prevattempts='';
1.43      ng       4988:   no strict 'refs';
1.1       albertel 4989:   if ($symb) {
1.3       albertel 4990:     my (%returnhash)=
                   4991:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 4992:     if ($returnhash{'version'}) {
                   4993:       my %lasthash=();
                   4994:       my $version;
                   4995:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1212    raeburn  4996:         foreach my $key (reverse(sort(split(/\:/,$returnhash{$version.':keys'})))) {
                   4997:             if ($key =~ /\.rawrndseed$/) {
                   4998:                 my ($id) = ($key =~ /^(.+)\.rawrndseed$/);
                   4999:                 $lasthash{$id.'.rndseed'} = $returnhash{$version.':'.$key};
                   5000:             } else {
                   5001:                 $lasthash{$key}=$returnhash{$version.':'.$key};
                   5002:             }
1.19      harris41 5003:         }
1.1       albertel 5004:       }
1.596     albertel 5005:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   5006:       $prevattempts.='<th>'.&mt('History').'</th>';
1.1199    raeburn  5007:       my (%typeparts,%lasthidden,%regraded,%hidestatus);
1.945     raeburn  5008:       my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'});
1.356     albertel 5009:       foreach my $key (sort(keys(%lasthash))) {
                   5010: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       5011: 	if ($#parts > 0) {
1.31      albertel 5012: 	  my $data=$parts[-1];
1.989     raeburn  5013:           next if ($data eq 'foilorder');
1.31      albertel 5014: 	  pop(@parts);
1.1010    www      5015:           $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.945     raeburn  5016:           if ($data eq 'type') {
                   5017:               unless ($showsurv) {
                   5018:                   my $id = join(',',@parts);
                   5019:                   $typeparts{$ign.'.'.$id} = $lasthash{$key};
1.978     raeburn  5020:                   if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) {
                   5021:                       $lasthidden{$ign.'.'.$id} = 1;
                   5022:                   }
1.945     raeburn  5023:               }
1.1199    raeburn  5024:               if ($identifier ne '') {
                   5025:                   my $id = join(',',@parts);
                   5026:                   if (&Apache::lonnet::EXT("resource.$id.problemstatus",$symb,
                   5027:                                                $domain,$username,$usec,undef,$course) =~ /^no/) {
                   5028:                       $hidestatus{$ign.'.'.$id} = 1;
                   5029:                   }
                   5030:               }
                   5031:           } elsif ($data eq 'regrader') {
                   5032:               if (($identifier ne '') && (@parts)) {
1.1200    raeburn  5033:                   my $id = join(',',@parts);
                   5034:                   $regraded{$ign.'.'.$id} = 1;
1.1199    raeburn  5035:               }
1.1010    www      5036:           } 
1.31      albertel 5037: 	} else {
1.41      ng       5038: 	  if ($#parts == 0) {
                   5039: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   5040: 	  } else {
                   5041: 	    $prevattempts.='<th>'.$ign.'</th>';
                   5042: 	  }
1.31      albertel 5043: 	}
1.16      harris41 5044:       }
1.596     albertel 5045:       $prevattempts.=&end_data_table_header_row();
1.40      ng       5046:       if ($getattempt eq '') {
1.1199    raeburn  5047:         my (%solved,%resets,%probstatus);
1.1200    raeburn  5048:         if (($identifier ne '') && (keys(%regraded) > 0)) {
                   5049:             for ($version=1;$version<=$returnhash{'version'};$version++) {
                   5050:                 foreach my $id (keys(%regraded)) {
                   5051:                     if (($returnhash{$version.':'.$id.'.regrader'}) &&
                   5052:                         ($returnhash{$version.':'.$id.'.tries'} eq '') &&
                   5053:                         ($returnhash{$version.':'.$id.'.award'} eq '')) {
                   5054:                         push(@{$resets{$id}},$version);
1.1199    raeburn  5055:                     }
                   5056:                 }
                   5057:             }
1.1200    raeburn  5058:         }
                   5059: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.1199    raeburn  5060:             my (@hidden,@unsolved);
1.945     raeburn  5061:             if (%typeparts) {
                   5062:                 foreach my $id (keys(%typeparts)) {
1.1199    raeburn  5063:                     if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || 
                   5064:                         ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) {
1.945     raeburn  5065:                         push(@hidden,$id);
1.1199    raeburn  5066:                     } elsif ($identifier ne '') {
                   5067:                         unless (($returnhash{$version.':'.$id.'.type'} eq 'survey') ||
                   5068:                                 ($returnhash{$version.':'.$id.'.type'} eq 'surveycred') ||
                   5069:                                 ($hidestatus{$id})) {
1.1200    raeburn  5070:                             next if ((ref($resets{$id}) eq 'ARRAY') && grep(/^\Q$version\E$/,@{$resets{$id}}));
1.1199    raeburn  5071:                             if ($returnhash{$version.':'.$id.'.solved'} eq 'correct_by_student') {
                   5072:                                 push(@{$solved{$id}},$version);
                   5073:                             } elsif (($returnhash{$version.':'.$id.'.solved'} ne '') &&
                   5074:                                      (ref($solved{$id}) eq 'ARRAY')) {
                   5075:                                 my $skip;
                   5076:                                 if (ref($resets{$id}) eq 'ARRAY') {
                   5077:                                     foreach my $reset (@{$resets{$id}}) {
                   5078:                                         if ($reset > $solved{$id}[-1]) {
                   5079:                                             $skip=1;
                   5080:                                             last;
                   5081:                                         }
                   5082:                                     }
                   5083:                                 }
                   5084:                                 unless ($skip) {
                   5085:                                     my ($ign,$partslist) = split(/\./,$id,2);
                   5086:                                     push(@unsolved,$partslist);
                   5087:                                 }
                   5088:                             }
                   5089:                         }
1.945     raeburn  5090:                     }
                   5091:                 }
                   5092:             }
                   5093:             $prevattempts.=&start_data_table_row().
1.1199    raeburn  5094:                            '<td>'.&mt('Transaction [_1]',$version);
                   5095:             if (@unsolved) {
                   5096:                 $prevattempts .= '<span class="LC_nobreak"><label>'.
                   5097:                                  '<input type="checkbox" name="HIDE'.$identifier.'" value="'.$version.':'.join('_',@unsolved).'" />'.
                   5098:                                  &mt('Hide').'</label></span>';
                   5099:             }
                   5100:             $prevattempts .= '</td>';
1.945     raeburn  5101:             if (@hidden) {
                   5102:                 foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  5103:                     next if ($key =~ /\.foilorder$/);
1.945     raeburn  5104:                     my $hide;
                   5105:                     foreach my $id (@hidden) {
                   5106:                         if ($key =~ /^\Q$id\E/) {
                   5107:                             $hide = 1;
                   5108:                             last;
                   5109:                         }
                   5110:                     }
                   5111:                     if ($hide) {
                   5112:                         my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   5113:                         if (($data eq 'award') || ($data eq 'awarddetail')) {
                   5114:                             my $value = &format_previous_attempt_value($key,
                   5115:                                              $returnhash{$version.':'.$key});
1.1173    kruse    5116:                             $prevattempts.='<td>'.$value.'&nbsp;</td>';
1.945     raeburn  5117:                         } else {
                   5118:                             $prevattempts.='<td>&nbsp;</td>';
                   5119:                         }
                   5120:                     } else {
                   5121:                         if ($key =~ /\./) {
1.1212    raeburn  5122:                             my $value = $returnhash{$version.':'.$key};
                   5123:                             if ($key =~ /\.rndseed$/) {
                   5124:                                 my ($id) = ($key =~ /^(.+)\.[^.]+$/);
                   5125:                                 if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   5126:                                     $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   5127:                                 }
                   5128:                             }
                   5129:                             $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   5130:                                            '&nbsp;</td>';
1.945     raeburn  5131:                         } else {
                   5132:                             $prevattempts.='<td>&nbsp;</td>';
                   5133:                         }
                   5134:                     }
                   5135:                 }
                   5136:             } else {
                   5137: 	        foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  5138:                     next if ($key =~ /\.foilorder$/);
1.1212    raeburn  5139:                     my $value = $returnhash{$version.':'.$key};
                   5140:                     if ($key =~ /\.rndseed$/) {
                   5141:                         my ($id) = ($key =~ /^(.+)\.[^.]+$/);
                   5142:                         if (exists($returnhash{$version.':'.$id.'.rawrndseed'})) {
                   5143:                             $value = $returnhash{$version.':'.$id.'.rawrndseed'};
                   5144:                         }
                   5145:                     }
                   5146:                     $prevattempts.='<td>'.&format_previous_attempt_value($key,$value).
                   5147:                                    '&nbsp;</td>';
1.945     raeburn  5148: 	        }
                   5149:             }
                   5150: 	    $prevattempts.=&end_data_table_row();
1.40      ng       5151: 	 }
1.1       albertel 5152:       }
1.945     raeburn  5153:       my @currhidden = keys(%lasthidden);
1.596     albertel 5154:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 5155:       foreach my $key (sort(keys(%lasthash))) {
1.989     raeburn  5156:           next if ($key =~ /\.foilorder$/);
1.945     raeburn  5157:           if (%typeparts) {
                   5158:               my $hidden;
                   5159:               foreach my $id (@currhidden) {
                   5160:                   if ($key =~ /^\Q$id\E/) {
                   5161:                       $hidden = 1;
                   5162:                       last;
                   5163:                   }
                   5164:               }
                   5165:               if ($hidden) {
                   5166:                   my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/);
                   5167:                   if (($data eq 'award') || ($data eq 'awarddetail')) {
                   5168:                       my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   5169:                       if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   5170:                           $value = &$gradesub($value);
                   5171:                       }
1.1173    kruse    5172:                       $prevattempts.='<td>'. $value.'&nbsp;</td>';
1.945     raeburn  5173:                   } else {
                   5174:                       $prevattempts.='<td>&nbsp;</td>';
                   5175:                   }
                   5176:               } else {
                   5177:                   my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   5178:                   if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   5179:                       $value = &$gradesub($value);
                   5180:                   }
1.1173    kruse    5181:                   $prevattempts.='<td>'.$value.'&nbsp;</td>';
1.945     raeburn  5182:               }
                   5183:           } else {
                   5184: 	      my $value = &format_previous_attempt_value($key,$lasthash{$key});
                   5185: 	      if ($key =~/$regexp$/ && (defined &$gradesub)) {
                   5186:                   $value = &$gradesub($value);
                   5187:               }
1.1173    kruse    5188: 	     $prevattempts.='<td>'.$value.'&nbsp;</td>';
1.945     raeburn  5189:           }
1.16      harris41 5190:       }
1.596     albertel 5191:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 5192:     } else {
1.1305    raeburn  5193:       my $msg;
                   5194:       if ($symb =~ /ext\.tool$/) {
                   5195:           $msg = &mt('No grade passed back.');
                   5196:       } else {
                   5197:           $msg = &mt('Nothing submitted - no attempts.');
                   5198:       }
1.596     albertel 5199:       $prevattempts=
                   5200: 	  &start_data_table().&start_data_table_row().
1.1305    raeburn  5201: 	  '<td>'.$msg.'</td>'.
1.596     albertel 5202: 	  &end_data_table_row().&end_data_table();
1.1       albertel 5203:     }
                   5204:   } else {
1.596     albertel 5205:     $prevattempts=
                   5206: 	  &start_data_table().&start_data_table_row().
                   5207: 	  '<td>'.&mt('No data.').'</td>'.
                   5208: 	  &end_data_table_row().&end_data_table();
1.1       albertel 5209:   }
1.10      albertel 5210: }
                   5211: 
1.581     albertel 5212: sub format_previous_attempt_value {
                   5213:     my ($key,$value) = @_;
1.1011    www      5214:     if (($key =~ /timestamp/) || ($key=~/duedate/)) {
1.1173    kruse    5215:         $value = &Apache::lonlocal::locallocaltime($value);
1.581     albertel 5216:     } elsif (ref($value) eq 'ARRAY') {
1.1173    kruse    5217:         $value = &HTML::Entities::encode('('.join(', ', @{ $value }).')','"<>&');
1.988     raeburn  5218:     } elsif ($key =~ /answerstring$/) {
                   5219:         my %answers = &Apache::lonnet::str2hash($value);
1.1173    kruse    5220:         my @answer = %answers;
                   5221:         %answers = map {&HTML::Entities::encode($_, '"<>&')} @answer;
1.988     raeburn  5222:         my @anskeys = sort(keys(%answers));
                   5223:         if (@anskeys == 1) {
                   5224:             my $answer = $answers{$anskeys[0]};
1.1001    raeburn  5225:             if ($answer =~ m{\0}) {
                   5226:                 $answer =~ s{\0}{,}g;
1.988     raeburn  5227:             }
                   5228:             my $tag_internal_answer_name = 'INTERNAL';
                   5229:             if ($anskeys[0] eq $tag_internal_answer_name) {
                   5230:                 $value = $answer; 
                   5231:             } else {
                   5232:                 $value = $anskeys[0].'='.$answer;
                   5233:             }
                   5234:         } else {
                   5235:             foreach my $ans (@anskeys) {
                   5236:                 my $answer = $answers{$ans};
1.1001    raeburn  5237:                 if ($answer =~ m{\0}) {
                   5238:                     $answer =~ s{\0}{,}g;
1.988     raeburn  5239:                 }
                   5240:                 $value .=  $ans.'='.$answer.'<br />';;
                   5241:             } 
                   5242:         }
1.581     albertel 5243:     } else {
1.1173    kruse    5244:         $value = &HTML::Entities::encode(&unescape($value), '"<>&');
1.581     albertel 5245:     }
                   5246:     return $value;
                   5247: }
                   5248: 
                   5249: 
1.107     albertel 5250: sub relative_to_absolute {
                   5251:     my ($url,$output)=@_;
                   5252:     my $parser=HTML::TokeParser->new(\$output);
                   5253:     my $token;
                   5254:     my $thisdir=$url;
                   5255:     my @rlinks=();
                   5256:     while ($token=$parser->get_token) {
                   5257: 	if ($token->[0] eq 'S') {
                   5258: 	    if ($token->[1] eq 'a') {
                   5259: 		if ($token->[2]->{'href'}) {
                   5260: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   5261: 		}
                   5262: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   5263: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   5264: 	    } elsif ($token->[1] eq 'base') {
                   5265: 		$thisdir=$token->[2]->{'href'};
                   5266: 	    }
                   5267: 	}
                   5268:     }
                   5269:     $thisdir=~s-/[^/]*$--;
1.356     albertel 5270:     foreach my $link (@rlinks) {
1.726     raeburn  5271: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 5272: 		($link=~/^\//) ||
                   5273: 		($link=~/^javascript:/i) ||
                   5274: 		($link=~/^mailto:/i) ||
                   5275: 		($link=~/^\#/)) {
                   5276: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   5277: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 5278: 	}
                   5279:     }
                   5280: # -------------------------------------------------- Deal with Applet codebases
                   5281:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   5282:     return $output;
                   5283: }
                   5284: 
1.112     bowersj2 5285: =pod
                   5286: 
1.648     raeburn  5287: =item * &get_student_view()
1.112     bowersj2 5288: 
                   5289: show a snapshot of what student was looking at
                   5290: 
                   5291: =cut
                   5292: 
1.10      albertel 5293: sub get_student_view {
1.186     albertel 5294:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      5295:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 5296:   my (%form);
1.10      albertel 5297:   my @elements=('symb','courseid','domain','username');
                   5298:   foreach my $element (@elements) {
1.186     albertel 5299:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 5300:   }
1.186     albertel 5301:   if (defined($moreenv)) {
                   5302:       %form=(%form,%{$moreenv});
                   5303:   }
1.236     albertel 5304:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 5305:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.1306    raeburn  5306:   if (($feedurl =~ /ext\.tool$/) && ($target eq 'tex')) {
                   5307:       $feedurl =~ s{^/adm/wrapper}{};
                   5308:   }
1.650     www      5309:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 5310:   $userview=~s/\<body[^\>]*\>//gi;
                   5311:   $userview=~s/\<\/body\>//gi;
                   5312:   $userview=~s/\<html\>//gi;
                   5313:   $userview=~s/\<\/html\>//gi;
                   5314:   $userview=~s/\<head\>//gi;
                   5315:   $userview=~s/\<\/head\>//gi;
                   5316:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 5317:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      5318:   if (wantarray) {
                   5319:      return ($userview,$response);
                   5320:   } else {
                   5321:      return $userview;
                   5322:   }
                   5323: }
                   5324: 
                   5325: sub get_student_view_with_retries {
                   5326:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   5327: 
                   5328:     my $ok = 0;                 # True if we got a good response.
                   5329:     my $content;
                   5330:     my $response;
                   5331: 
                   5332:     # Try to get the student_view done. within the retries count:
                   5333:     
                   5334:     do {
                   5335:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   5336:          $ok      = $response->is_success;
                   5337:          if (!$ok) {
                   5338:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   5339:          }
                   5340:          $retries--;
                   5341:     } while (!$ok && ($retries > 0));
                   5342:     
                   5343:     if (!$ok) {
                   5344:        $content = '';          # On error return an empty content.
                   5345:     }
1.651     www      5346:     if (wantarray) {
                   5347:        return ($content, $response);
                   5348:     } else {
                   5349:        return $content;
                   5350:     }
1.11      albertel 5351: }
                   5352: 
1.1349    raeburn  5353: sub css_links {
                   5354:     my ($currsymb,$level) = @_;
                   5355:     my ($links,@symbs,%cssrefs,%httpref);
                   5356:     if ($level eq 'map') {
                   5357:         my $navmap = Apache::lonnavmaps::navmap->new();
                   5358:         if (ref($navmap)) {
                   5359:             my ($map,undef,$url)=&Apache::lonnet::decode_symb($currsymb);
                   5360:             my @resources = $navmap->retrieveResources($map,sub { $_[0]->is_problem() },0,0);
                   5361:             foreach my $res (@resources) {
                   5362:                 if (ref($res) && $res->symb()) {
                   5363:                     push(@symbs,$res->symb());
                   5364:                 }
                   5365:             }
                   5366:         }
                   5367:     } else {
                   5368:         @symbs = ($currsymb);
                   5369:     }
                   5370:     foreach my $symb (@symbs) {
                   5371:         my $css_href = &Apache::lonnet::EXT('resource.0.cssfile',$symb);
                   5372:         if ($css_href =~ /\S/) {
                   5373:             unless ($css_href =~ m{https?://}) {
                   5374:                 my $url = (&Apache::lonnet::decode_symb($symb))[-1];
                   5375:                 my $proburl =  &Apache::lonnet::clutter($url);
                   5376:                 my ($probdir) = ($proburl =~ m{(.+)/[^/]+$});
                   5377:                 unless ($css_href =~ m{^/}) {
                   5378:                     $css_href = &Apache::lonnet::hreflocation($probdir,$css_href);
                   5379:                 }
                   5380:                 if ($css_href =~ m{^/(res|uploaded)/}) {
                   5381:                     unless (($httpref{'httpref.'.$css_href}) ||
                   5382:                             (&Apache::lonnet::is_on_map($css_href))) {
                   5383:                         my $thisurl = $proburl;
                   5384:                         if ($env{'httpref.'.$proburl}) {
                   5385:                             $thisurl = $env{'httpref.'.$proburl};
                   5386:                         }
                   5387:                         $httpref{'httpref.'.$css_href} = $thisurl;
                   5388:                     }
                   5389:                 }
                   5390:             }
                   5391:             $cssrefs{$css_href} = 1;
                   5392:         }
                   5393:     }
                   5394:     if (keys(%httpref)) {
                   5395:         &Apache::lonnet::appenv(\%httpref);
                   5396:     }
                   5397:     if (keys(%cssrefs)) {
                   5398:         foreach my $css_href (keys(%cssrefs)) {
                   5399:             next unless ($css_href =~ m{^(/res/|/uploaded/|https?://)});
                   5400:             $links .= '<link rel="stylesheet" type="text/css" href="'.$css_href.'" />'."\n";
                   5401:         }
                   5402:     }
                   5403:     return $links;
                   5404: }
                   5405: 
1.112     bowersj2 5406: =pod
                   5407: 
1.648     raeburn  5408: =item * &get_student_answers() 
1.112     bowersj2 5409: 
                   5410: show a snapshot of how student was answering problem
                   5411: 
                   5412: =cut
                   5413: 
1.11      albertel 5414: sub get_student_answers {
1.100     sakharuk 5415:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      5416:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 5417:   my (%moreenv);
1.11      albertel 5418:   my @elements=('symb','courseid','domain','username');
                   5419:   foreach my $element (@elements) {
1.186     albertel 5420:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 5421:   }
1.186     albertel 5422:   $moreenv{'grade_target'}='answer';
                   5423:   %moreenv=(%form,%moreenv);
1.497     raeburn  5424:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   5425:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 5426:   return $userview;
1.1       albertel 5427: }
1.116     albertel 5428: 
                   5429: =pod
                   5430: 
                   5431: =item * &submlink()
                   5432: 
1.242     albertel 5433: Inputs: $text $uname $udom $symb $target
1.116     albertel 5434: 
                   5435: Returns: A link to grades.pm such as to see the SUBM view of a student
                   5436: 
                   5437: =cut
                   5438: 
                   5439: ###############################################
                   5440: sub submlink {
1.242     albertel 5441:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 5442:     if (!($uname && $udom)) {
                   5443: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 5444: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 5445: 	if (!$symb) { $symb=$cursymb; }
                   5446:     }
1.254     matthew  5447:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      5448:     $symb=&escape($symb);
1.960     bisitz   5449:     if ($target) { $target=" target=\"$target\""; }
                   5450:     return
                   5451:         '<a href="/adm/grades?command=submission'.
                   5452:         '&amp;symb='.$symb.
                   5453:         '&amp;student='.$uname.
                   5454:         '&amp;userdom='.$udom.'"'.
                   5455:         $target.'>'.$text.'</a>';
1.242     albertel 5456: }
                   5457: ##############################################
                   5458: 
                   5459: =pod
                   5460: 
                   5461: =item * &pgrdlink()
                   5462: 
                   5463: Inputs: $text $uname $udom $symb $target
                   5464: 
                   5465: Returns: A link to grades.pm such as to see the PGRD view of a student
                   5466: 
                   5467: =cut
                   5468: 
                   5469: ###############################################
                   5470: sub pgrdlink {
                   5471:     my $link=&submlink(@_);
                   5472:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   5473:     return $link;
                   5474: }
                   5475: ##############################################
                   5476: 
                   5477: =pod
                   5478: 
                   5479: =item * &pprmlink()
                   5480: 
                   5481: Inputs: $text $uname $udom $symb $target
                   5482: 
                   5483: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 5484: student and a specific resource
1.242     albertel 5485: 
                   5486: =cut
                   5487: 
                   5488: ###############################################
                   5489: sub pprmlink {
                   5490:     my ($text,$uname,$udom,$symb,$target)=@_;
                   5491:     if (!($uname && $udom)) {
                   5492: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 5493: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 5494: 	if (!$symb) { $symb=$cursymb; }
                   5495:     }
1.254     matthew  5496:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      5497:     $symb=&escape($symb);
1.242     albertel 5498:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 5499:     return '<a href="/adm/parmset?command=set&amp;'.
                   5500: 	'symb='.$symb.'&amp;uname='.$uname.
                   5501: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 5502: }
                   5503: ##############################################
1.37      matthew  5504: 
1.112     bowersj2 5505: =pod
                   5506: 
                   5507: =back
                   5508: 
                   5509: =cut
                   5510: 
1.37      matthew  5511: ###############################################
1.51      www      5512: 
                   5513: 
                   5514: sub timehash {
1.687     raeburn  5515:     my ($thistime) = @_;
                   5516:     my $timezone = &Apache::lonlocal::gettimezone();
                   5517:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   5518:                      ->set_time_zone($timezone);
                   5519:     my $wday = $dt->day_of_week();
                   5520:     if ($wday == 7) { $wday = 0; }
                   5521:     return ( 'second' => $dt->second(),
                   5522:              'minute' => $dt->minute(),
                   5523:              'hour'   => $dt->hour(),
                   5524:              'day'     => $dt->day_of_month(),
                   5525:              'month'   => $dt->month(),
                   5526:              'year'    => $dt->year(),
                   5527:              'weekday' => $wday,
                   5528:              'dayyear' => $dt->day_of_year(),
                   5529:              'dlsav'   => $dt->is_dst() );
1.51      www      5530: }
                   5531: 
1.370     www      5532: sub utc_string {
                   5533:     my ($date)=@_;
1.371     www      5534:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      5535: }
                   5536: 
1.51      www      5537: sub maketime {
                   5538:     my %th=@_;
1.687     raeburn  5539:     my ($epoch_time,$timezone,$dt);
                   5540:     $timezone = &Apache::lonlocal::gettimezone();
                   5541:     eval {
                   5542:         $dt = DateTime->new( year   => $th{'year'},
                   5543:                              month  => $th{'month'},
                   5544:                              day    => $th{'day'},
                   5545:                              hour   => $th{'hour'},
                   5546:                              minute => $th{'minute'},
                   5547:                              second => $th{'second'},
                   5548:                              time_zone => $timezone,
                   5549:                          );
                   5550:     };
                   5551:     if (!$@) {
                   5552:         $epoch_time = $dt->epoch;
                   5553:         if ($epoch_time) {
                   5554:             return $epoch_time;
                   5555:         }
                   5556:     }
1.51      www      5557:     return POSIX::mktime(
                   5558:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      5559:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      5560: }
                   5561: 
                   5562: #########################################
1.51      www      5563: 
                   5564: sub findallcourses {
1.482     raeburn  5565:     my ($roles,$uname,$udom) = @_;
1.355     albertel 5566:     my %roles;
                   5567:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 5568:     my %courses;
1.51      www      5569:     my $now=time;
1.482     raeburn  5570:     if (!defined($uname)) {
                   5571:         $uname = $env{'user.name'};
                   5572:     }
                   5573:     if (!defined($udom)) {
                   5574:         $udom = $env{'user.domain'};
                   5575:     }
                   5576:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
1.1073    raeburn  5577:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
1.482     raeburn  5578:         if (!%roles) {
                   5579:             %roles = (
                   5580:                        cc => 1,
1.907     raeburn  5581:                        co => 1,
1.482     raeburn  5582:                        in => 1,
                   5583:                        ep => 1,
                   5584:                        ta => 1,
                   5585:                        cr => 1,
                   5586:                        st => 1,
                   5587:              );
                   5588:         }
                   5589:         foreach my $entry (keys(%roleshash)) {
                   5590:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   5591:             if ($trole =~ /^cr/) { 
                   5592:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   5593:             } else {
                   5594:                 next if (!exists($roles{$trole}));
                   5595:             }
                   5596:             if ($tend) {
                   5597:                 next if ($tend < $now);
                   5598:             }
                   5599:             if ($tstart) {
                   5600:                 next if ($tstart > $now);
                   5601:             }
1.1058    raeburn  5602:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role);
1.482     raeburn  5603:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
1.1058    raeburn  5604:             my $value = $trole.'/'.$cdom.'/';
1.482     raeburn  5605:             if ($secpart eq '') {
                   5606:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   5607:                 $sec = 'none';
1.1058    raeburn  5608:                 $value .= $cnum.'/';
1.482     raeburn  5609:             } else {
                   5610:                 $cnum = $cnumpart;
                   5611:                 ($sec,$role) = split(/_/,$secpart);
1.1058    raeburn  5612:                 $value .= $cnum.'/'.$sec;
                   5613:             }
                   5614:             if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   5615:                 unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   5616:                     push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   5617:                 }
                   5618:             } else {
                   5619:                 @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.490     raeburn  5620:             }
1.482     raeburn  5621:         }
                   5622:     } else {
                   5623:         foreach my $key (keys(%env)) {
1.483     albertel 5624: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   5625:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  5626: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   5627: 	        next if ($role eq 'ca' || $role eq 'aa');
                   5628: 	        next if (%roles && !exists($roles{$role}));
                   5629: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   5630:                 my $active=1;
                   5631:                 if ($starttime) {
                   5632: 		    if ($now<$starttime) { $active=0; }
                   5633:                 }
                   5634:                 if ($endtime) {
                   5635:                     if ($now>$endtime) { $active=0; }
                   5636:                 }
                   5637:                 if ($active) {
1.1058    raeburn  5638:                     my $value = $role.'/'.$cdom.'/'.$cnum.'/';
1.482     raeburn  5639:                     if ($sec eq '') {
                   5640:                         $sec = 'none';
1.1058    raeburn  5641:                     } else {
                   5642:                         $value .= $sec;
                   5643:                     }
                   5644:                     if (ref($courses{$cdom.'_'.$cnum}{$sec}) eq 'ARRAY') {
                   5645:                         unless (grep(/^\Q$value\E$/,@{$courses{$cdom.'_'.$cnum}{$sec}})) {
                   5646:                             push(@{$courses{$cdom.'_'.$cnum}{$sec}},$value);
                   5647:                         }
                   5648:                     } else {
                   5649:                         @{$courses{$cdom.'_'.$cnum}{$sec}} = ($value);
1.482     raeburn  5650:                     }
1.474     raeburn  5651:                 }
                   5652:             }
1.51      www      5653:         }
                   5654:     }
1.474     raeburn  5655:     return %courses;
1.51      www      5656: }
1.37      matthew  5657: 
1.54      www      5658: ###############################################
1.474     raeburn  5659: 
                   5660: sub blockcheck {
1.1372    raeburn  5661:     my ($setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
                   5662:     unless (($activity eq 'docs') || ($activity eq 'reinit') || ($activity eq 'alert')) {
                   5663:         my ($has_evb,$check_ipaccess);
                   5664:         my $dom = $env{'user.domain'};
                   5665:         if ($env{'request.course.id'}) {
                   5666:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   5667:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   5668:             my $checkrole = "cm./$cdom/$cnum";
                   5669:             my $sec = $env{'request.course.sec'};
                   5670:             if ($sec ne '') {
                   5671:                 $checkrole .= "/$sec";
                   5672:             }
                   5673:             if ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   5674:                 ($env{'request.role'} !~ /^st/)) {
                   5675:                 $has_evb = 1;
                   5676:             }
                   5677:             unless ($has_evb) {
                   5678:                 if (($activity eq 'printout') || ($activity eq 'grades') || ($activity eq 'search') ||
                   5679:                     ($activity eq 'boards') || ($activity eq 'groups') || ($activity eq 'chat')) {
                   5680:                     if ($udom eq $cdom) {
                   5681:                         $check_ipaccess = 1;
                   5682:                     }
                   5683:                 }
                   5684:             }
1.1375    raeburn  5685:         } elsif (($activity eq 'com') || ($activity eq 'port') || ($activity eq 'blogs') ||
                   5686:                 ($activity eq 'about') || ($activity eq 'wishlist') || ($activity eq 'passwd')) {
                   5687:             my $checkrole;
                   5688:             if ($env{'request.role.domain'} eq '') {
                   5689:                 $checkrole = "cm./$env{'user.domain'}/";
                   5690:             } else {
                   5691:                 $checkrole = "cm./$env{'request.role.domain'}/";
                   5692:             }
                   5693:             if (($checkrole) && (&Apache::lonnet::allowed('evb',undef,undef,$checkrole))) {
                   5694:                 $has_evb = 1;
                   5695:             }
1.1372    raeburn  5696:         }
                   5697:         unless ($has_evb || $check_ipaccess) {
                   5698:             my @machinedoms = &Apache::lonnet::current_machine_domains();
                   5699:             if (($dom eq 'public') && ($activity eq 'port')) {
                   5700:                 $dom = $udom;
                   5701:             }
                   5702:             if (($dom ne '') && (grep(/^\Q$dom\E$/,@machinedoms))) {
                   5703:                 $check_ipaccess = 1;
                   5704:             } else {
                   5705:                 my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   5706:                 my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
                   5707:                 my $prim = &Apache::lonnet::domain($dom,'primary');
                   5708:                 my $intdom = &Apache::lonnet::internet_dom($prim);
                   5709:                 if (($intdom ne '') && (ref($internet_names) eq 'ARRAY')) {
                   5710:                     if (grep(/^\Q$intdom\E$/,@{$internet_names})) {
                   5711:                         $check_ipaccess = 1;
                   5712:                     }
                   5713:                 }
                   5714:             }
                   5715:         }
                   5716:         if ($check_ipaccess) {
                   5717:             my ($ipaccessref,$cached)=&Apache::lonnet::is_cached_new('ipaccess',$dom);
                   5718:             unless (defined($cached)) {
                   5719:                 my %domconfig =
                   5720:                     &Apache::lonnet::get_dom('configuration',['ipaccess'],$dom);
                   5721:                 $ipaccessref = &Apache::lonnet::do_cache_new('ipaccess',$dom,$domconfig{'ipaccess'},1800);
                   5722:             }
                   5723:             if ((ref($ipaccessref) eq 'HASH') && ($clientip)) {
                   5724:                 foreach my $id (keys(%{$ipaccessref})) {
                   5725:                     if (ref($ipaccessref->{$id}) eq 'HASH') {
                   5726:                         my $range = $ipaccessref->{$id}->{'ip'};
                   5727:                         if ($range) {
                   5728:                             if (&Apache::lonnet::ip_match($clientip,$range)) {
                   5729:                                 if (ref($ipaccessref->{$id}->{'commblocks'}) eq 'HASH') {
                   5730:                                     if ($ipaccessref->{$id}->{'commblocks'}->{$activity} eq 'on') {
                   5731:                                         return ('','','',$id,$dom);
                   5732:                                         last;
                   5733:                                     }
                   5734:                                 }
                   5735:                             }
                   5736:                         }
                   5737:                     }
                   5738:                 }
                   5739:             }
                   5740:         }
1.1373    raeburn  5741:         if (($activity eq 'wishlist') || ($activity eq 'annotate')) {
                   5742:             return ();
                   5743:         }
1.1372    raeburn  5744:     }
1.1189    raeburn  5745:     if (defined($udom) && defined($uname)) {
                   5746:         # If uname and udom are for a course, check for blocks in the course.
                   5747:         if (($is_course) || (&Apache::lonnet::is_course($udom,$uname))) {
                   5748:             my ($startblock,$endblock,$triggerblock) =
1.1347    raeburn  5749:                 &get_blocks($setters,$activity,$udom,$uname,$url,$symb,$caller);
1.1189    raeburn  5750:             return ($startblock,$endblock,$triggerblock);
                   5751:         }
                   5752:     } else {
1.490     raeburn  5753:         $udom = $env{'user.domain'};
                   5754:         $uname = $env{'user.name'};
                   5755:     }
                   5756: 
1.502     raeburn  5757:     my $startblock = 0;
                   5758:     my $endblock = 0;
1.1062    raeburn  5759:     my $triggerblock = '';
1.1373    raeburn  5760:     my %live_courses;
                   5761:     unless (($activity eq 'wishlist') || ($activity eq 'annotate')) {
                   5762:         %live_courses = &findallcourses(undef,$uname,$udom);
                   5763:     }
1.474     raeburn  5764: 
1.490     raeburn  5765:     # If uname is for a user, and activity is course-specific, i.e.,
                   5766:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  5767: 
1.490     raeburn  5768:     if (($activity eq 'boards' || $activity eq 'chat' ||
1.1282    raeburn  5769:          $activity eq 'groups' || $activity eq 'printout' ||
1.1346    raeburn  5770:          $activity eq 'search' || $activity eq 'reinit' ||
                   5771:          $activity eq 'alert') &&
1.1189    raeburn  5772:         ($env{'request.course.id'})) {
1.490     raeburn  5773:         foreach my $key (keys(%live_courses)) {
                   5774:             if ($key ne $env{'request.course.id'}) {
                   5775:                 delete($live_courses{$key});
                   5776:             }
                   5777:         }
                   5778:     }
                   5779: 
                   5780:     my $otheruser = 0;
                   5781:     my %own_courses;
                   5782:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   5783:         # Resource belongs to user other than current user.
                   5784:         $otheruser = 1;
                   5785:         # Gather courses for current user
                   5786:         %own_courses = 
                   5787:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   5788:     }
                   5789: 
                   5790:     # Gather active course roles - course coordinator, instructor, 
                   5791:     # exam proctor, ta, student, or custom role.
1.474     raeburn  5792: 
                   5793:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  5794:         my ($cdom,$cnum);
                   5795:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   5796:             $cdom = $env{'course.'.$course.'.domain'};
                   5797:             $cnum = $env{'course.'.$course.'.num'};
                   5798:         } else {
1.490     raeburn  5799:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  5800:         }
                   5801:         my $no_ownblock = 0;
                   5802:         my $no_userblock = 0;
1.533     raeburn  5803:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  5804:             # Check if current user has 'evb' priv for this
                   5805:             if (defined($own_courses{$course})) {
                   5806:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   5807:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   5808:                     if ($sec ne 'none') {
                   5809:                         $checkrole .= '/'.$sec;
                   5810:                     }
                   5811:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   5812:                         $no_ownblock = 1;
                   5813:                         last;
                   5814:                     }
                   5815:                 }
                   5816:             }
                   5817:             # if they have 'evb' priv and are currently not playing student
                   5818:             next if (($no_ownblock) &&
                   5819:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   5820:         }
1.474     raeburn  5821:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  5822:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  5823:             if ($sec ne 'none') {
1.482     raeburn  5824:                 $checkrole .= '/'.$sec;
1.474     raeburn  5825:             }
1.490     raeburn  5826:             if ($otheruser) {
                   5827:                 # Resource belongs to user other than current user.
                   5828:                 # Assemble privs for that user, and check for 'evb' priv.
1.1058    raeburn  5829:                 my (%allroles,%userroles);
                   5830:                 if (ref($live_courses{$course}{$sec}) eq 'ARRAY') {
                   5831:                     foreach my $entry (@{$live_courses{$course}{$sec}}) { 
                   5832:                         my ($trole,$tdom,$tnum,$tsec);
                   5833:                         if ($entry =~ /^cr/) {
                   5834:                             ($trole,$tdom,$tnum,$tsec) = 
                   5835:                                 ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   5836:                         } else {
                   5837:                            ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   5838:                         }
                   5839:                         my ($spec,$area,$trest);
                   5840:                         $area = '/'.$tdom.'/'.$tnum;
                   5841:                         $trest = $tnum;
                   5842:                         if ($tsec ne '') {
                   5843:                             $area .= '/'.$tsec;
                   5844:                             $trest .= '/'.$tsec;
                   5845:                         }
                   5846:                         $spec = $trole.'.'.$area;
                   5847:                         if ($trole =~ /^cr/) {
                   5848:                             &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   5849:                                                               $tdom,$spec,$trest,$area);
                   5850:                         } else {
                   5851:                             &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   5852:                                                                 $tdom,$spec,$trest,$area);
                   5853:                         }
                   5854:                     }
1.1276    raeburn  5855:                     my ($author,$adv,$rar) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.1058    raeburn  5856:                     if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   5857:                         if ($1) {
                   5858:                             $no_userblock = 1;
                   5859:                             last;
                   5860:                         }
1.486     raeburn  5861:                     }
                   5862:                 }
1.490     raeburn  5863:             } else {
                   5864:                 # Resource belongs to current user
                   5865:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  5866:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   5867:                     $no_ownblock = 1;
                   5868:                     last;
                   5869:                 }
1.474     raeburn  5870:             }
                   5871:         }
                   5872:         # if they have the evb priv and are currently not playing student
1.482     raeburn  5873:         next if (($no_ownblock) &&
1.491     albertel 5874:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  5875:         next if ($no_userblock);
1.474     raeburn  5876: 
1.1303    raeburn  5877:         # Retrieve blocking times and identity of blocker for course
1.490     raeburn  5878:         # of specified user, unless user has 'evb' privilege.
1.1284    raeburn  5879: 
1.1062    raeburn  5880:         my ($start,$end,$trigger) = 
1.1347    raeburn  5881:             &get_blocks($setters,$activity,$cdom,$cnum,$url,$symb,$caller);
1.502     raeburn  5882:         if (($start != 0) && 
                   5883:             (($startblock == 0) || ($startblock > $start))) {
                   5884:             $startblock = $start;
1.1062    raeburn  5885:             if ($trigger ne '') {
                   5886:                 $triggerblock = $trigger;
                   5887:             }
1.502     raeburn  5888:         }
                   5889:         if (($end != 0)  &&
                   5890:             (($endblock == 0) || ($endblock < $end))) {
                   5891:             $endblock = $end;
1.1062    raeburn  5892:             if ($trigger ne '') {
                   5893:                 $triggerblock = $trigger;
                   5894:             }
1.502     raeburn  5895:         }
1.490     raeburn  5896:     }
1.1062    raeburn  5897:     return ($startblock,$endblock,$triggerblock);
1.490     raeburn  5898: }
                   5899: 
                   5900: sub get_blocks {
1.1347    raeburn  5901:     my ($setters,$activity,$cdom,$cnum,$url,$symb,$caller) = @_;
1.490     raeburn  5902:     my $startblock = 0;
                   5903:     my $endblock = 0;
1.1062    raeburn  5904:     my $triggerblock = '';
1.490     raeburn  5905:     my $course = $cdom.'_'.$cnum;
                   5906:     $setters->{$course} = {};
                   5907:     $setters->{$course}{'staff'} = [];
                   5908:     $setters->{$course}{'times'} = [];
1.1062    raeburn  5909:     $setters->{$course}{'triggers'} = [];
                   5910:     my (@blockers,%triggered);
                   5911:     my $now = time;
                   5912:     my %commblocks = &Apache::lonnet::get_comm_blocks($cdom,$cnum);
                   5913:     if ($activity eq 'docs') {
1.1348    raeburn  5914:         my ($blocked,$nosymbcache,$noenccheck);
1.1347    raeburn  5915:         if (($caller eq 'blockedaccess') || ($caller eq 'blockingstatus')) {
                   5916:             $blocked = 1;
                   5917:             $nosymbcache = 1;
1.1348    raeburn  5918:             $noenccheck = 1;
1.1347    raeburn  5919:         }
1.1348    raeburn  5920:         @blockers = &Apache::lonnet::has_comm_blocking('bre',$symb,$url,$nosymbcache,$noenccheck,$blocked,\%commblocks);
1.1062    raeburn  5921:         foreach my $block (@blockers) {
                   5922:             if ($block =~ /^firstaccess____(.+)$/) {
                   5923:                 my $item = $1;
                   5924:                 my $type = 'map';
                   5925:                 my $timersymb = $item;
                   5926:                 if ($item eq 'course') {
                   5927:                     $type = 'course';
                   5928:                 } elsif ($item =~ /___\d+___/) {
                   5929:                     $type = 'resource';
                   5930:                 } else {
                   5931:                     $timersymb = &Apache::lonnet::symbread($item);
                   5932:                 }
                   5933:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   5934:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb};
                   5935:                 $triggered{$block} = {
                   5936:                                        start => $start,
                   5937:                                        end   => $end,
                   5938:                                        type  => $type,
                   5939:                                      };
                   5940:             }
                   5941:         }
                   5942:     } else {
                   5943:         foreach my $block (keys(%commblocks)) {
                   5944:             if ($block =~ m/^(\d+)____(\d+)$/) { 
                   5945:                 my ($start,$end) = ($1,$2);
                   5946:                 if ($start <= time && $end >= time) {
                   5947:                     if (ref($commblocks{$block}) eq 'HASH') {
                   5948:                         if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   5949:                             if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   5950:                                 unless(grep(/^\Q$block\E$/,@blockers)) {
                   5951:                                     push(@blockers,$block);
                   5952:                                 }
                   5953:                             }
                   5954:                         }
                   5955:                     }
                   5956:                 }
                   5957:             } elsif ($block =~ /^firstaccess____(.+)$/) {
                   5958:                 my $item = $1;
                   5959:                 my $timersymb = $item; 
                   5960:                 my $type = 'map';
                   5961:                 if ($item eq 'course') {
                   5962:                     $type = 'course';
                   5963:                 } elsif ($item =~ /___\d+___/) {
                   5964:                     $type = 'resource';
                   5965:                 } else {
                   5966:                     $timersymb = &Apache::lonnet::symbread($item);
                   5967:                 }
                   5968:                 my $start = $env{'course.'.$cdom.'_'.$cnum.'.firstaccess.'.$timersymb};
                   5969:                 my $end = $start + $env{'course.'.$cdom.'_'.$cnum.'.timerinterval.'.$timersymb}; 
                   5970:                 if ($start && $end) {
                   5971:                     if (($start <= time) && ($end >= time)) {
1.1281    raeburn  5972:                         if (ref($commblocks{$block}) eq 'HASH') {
                   5973:                             if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
                   5974:                                 if ($commblocks{$block}{'blocks'}{$activity} eq 'on') {
                   5975:                                     unless(grep(/^\Q$block\E$/,@blockers)) {
                   5976:                                         push(@blockers,$block);
                   5977:                                         $triggered{$block} = {
                   5978:                                                                start => $start,
                   5979:                                                                end   => $end,
                   5980:                                                                type  => $type,
                   5981:                                                              };
                   5982:                                     }
                   5983:                                 }
                   5984:                             }
1.1062    raeburn  5985:                         }
                   5986:                     }
1.490     raeburn  5987:                 }
1.1062    raeburn  5988:             }
                   5989:         }
                   5990:     }
                   5991:     foreach my $blocker (@blockers) {
                   5992:         my ($staff_name,$staff_dom,$title,$blocks) =
                   5993:             &parse_block_record($commblocks{$blocker});
                   5994:         push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   5995:         my ($start,$end,$triggertype);
                   5996:         if ($blocker =~ m/^(\d+)____(\d+)$/) {
                   5997:             ($start,$end) = ($1,$2);
                   5998:         } elsif (ref($triggered{$blocker}) eq 'HASH') {
                   5999:             $start = $triggered{$blocker}{'start'};
                   6000:             $end = $triggered{$blocker}{'end'};
                   6001:             $triggertype = $triggered{$blocker}{'type'};
                   6002:         }
                   6003:         if ($start) {
                   6004:             push(@{$$setters{$course}{'times'}}, [$start,$end]);
                   6005:             if ($triggertype) {
                   6006:                 push(@{$$setters{$course}{'triggers'}},$triggertype);
                   6007:             } else {
                   6008:                 push(@{$$setters{$course}{'triggers'}},0);
                   6009:             }
                   6010:             if ( ($startblock == 0) || ($startblock > $start) ) {
                   6011:                 $startblock = $start;
                   6012:                 if ($triggertype) {
                   6013:                     $triggerblock = $blocker;
1.474     raeburn  6014:                 }
                   6015:             }
1.1062    raeburn  6016:             if ( ($endblock == 0) || ($endblock < $end) ) {
                   6017:                $endblock = $end;
                   6018:                if ($triggertype) {
                   6019:                    $triggerblock = $blocker;
                   6020:                }
                   6021:             }
1.474     raeburn  6022:         }
                   6023:     }
1.1062    raeburn  6024:     return ($startblock,$endblock,$triggerblock);
1.474     raeburn  6025: }
                   6026: 
                   6027: sub parse_block_record {
                   6028:     my ($record) = @_;
                   6029:     my ($setuname,$setudom,$title,$blocks);
                   6030:     if (ref($record) eq 'HASH') {
                   6031:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   6032:         $title = &unescape($record->{'event'});
                   6033:         $blocks = $record->{'blocks'};
                   6034:     } else {
                   6035:         my @data = split(/:/,$record,3);
                   6036:         if (scalar(@data) eq 2) {
                   6037:             $title = $data[1];
                   6038:             ($setuname,$setudom) = split(/@/,$data[0]);
                   6039:         } else {
                   6040:             ($setuname,$setudom,$title) = @data;
                   6041:         }
                   6042:         $blocks = { 'com' => 'on' };
                   6043:     }
                   6044:     return ($setuname,$setudom,$title,$blocks);
                   6045: }
                   6046: 
1.854     kalberla 6047: sub blocking_status {
1.1372    raeburn  6048:     my ($activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller) = @_;
1.1061    raeburn  6049:     my %setters;
1.890     droeschl 6050: 
1.1061    raeburn  6051: # check for active blocking
1.1372    raeburn  6052:     if ($clientip eq '') {
                   6053:         $clientip = &Apache::lonnet::get_requestor_ip();
                   6054:     }
                   6055:     my ($startblock,$endblock,$triggerblock,$by_ip,$blockdom) = 
                   6056:         &blockcheck(\%setters,$activity,$clientip,$uname,$udom,$url,$is_course,$symb,$caller);
1.1062    raeburn  6057:     my $blocked = 0;
1.1372    raeburn  6058:     if (($startblock && $endblock) || ($by_ip)) {
1.1062    raeburn  6059:         $blocked = 1;
                   6060:     }
1.890     droeschl 6061: 
1.1061    raeburn  6062: # caller just wants to know whether a block is active
                   6063:     if (!wantarray) { return $blocked; }
                   6064: 
                   6065: # build a link to a popup window containing the details
                   6066:     my $querystring  = "?activity=$activity";
1.1351    raeburn  6067: # $uname and $udom decide whose portfolio (or information page) the user is trying to look at
                   6068:     if (($activity eq 'port') || ($activity eq 'about') || ($activity eq 'passwd')) {
1.1232    raeburn  6069:         $querystring .= "&amp;udom=$udom"      if ($udom =~ /^$match_domain$/); 
                   6070:         $querystring .= "&amp;uname=$uname"    if ($uname =~ /^$match_username$/);
1.1062    raeburn  6071:     } elsif ($activity eq 'docs') {
1.1347    raeburn  6072:         my $showurl = &Apache::lonenc::check_encrypt($url);
                   6073:         $querystring .= '&amp;url='.&HTML::Entities::encode($showurl,'\'&"<>');
                   6074:         if ($symb) {
                   6075:             my $showsymb = &Apache::lonenc::check_encrypt($symb);
                   6076:             $querystring .= '&amp;symb='.&HTML::Entities::encode($showsymb,'\'&"<>');
                   6077:         }
1.1062    raeburn  6078:     }
1.1061    raeburn  6079: 
                   6080:     my $output .= <<'END_MYBLOCK';
                   6081: function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   6082:     var options = "width=" + w + ",height=" + h + ",";
                   6083:     options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   6084:     options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   6085:     var newWin = window.open(url, wdwName, options);
                   6086:     newWin.focus();
                   6087: }
1.890     droeschl 6088: END_MYBLOCK
1.854     kalberla 6089: 
1.1061    raeburn  6090:     $output = Apache::lonhtmlcommon::scripttag($output);
1.890     droeschl 6091:   
1.1061    raeburn  6092:     my $popupUrl = "/adm/blockingstatus/$querystring";
1.1062    raeburn  6093:     my $text = &mt('Communication Blocked');
1.1217    raeburn  6094:     my $class = 'LC_comblock';
1.1062    raeburn  6095:     if ($activity eq 'docs') {
                   6096:         $text = &mt('Content Access Blocked');
1.1217    raeburn  6097:         $class = '';
1.1063    raeburn  6098:     } elsif ($activity eq 'printout') {
                   6099:         $text = &mt('Printing Blocked');
1.1232    raeburn  6100:     } elsif ($activity eq 'passwd') {
                   6101:         $text = &mt('Password Changing Blocked');
1.1345    raeburn  6102:     } elsif ($activity eq 'grades') {
                   6103:         $text = &mt('Gradebook Blocked');
1.1346    raeburn  6104:     } elsif ($activity eq 'search') {
                   6105:         $text = &mt('Search Blocked');
1.1282    raeburn  6106:     } elsif ($activity eq 'alert') {
                   6107:         $text = &mt('Checking Critical Messages Blocked');
                   6108:     } elsif ($activity eq 'reinit') {
                   6109:         $text = &mt('Checking Course Update Blocked');
1.1351    raeburn  6110:     } elsif ($activity eq 'about') {
                   6111:         $text = &mt('Access to User Information Pages Blocked');
1.1373    raeburn  6112:     } elsif ($activity eq 'wishlist') {
                   6113:         $text = &mt('Access to Stored Links Blocked');
                   6114:     } elsif ($activity eq 'annotate') {
                   6115:         $text = &mt('Access to Annotations Blocked');
1.1062    raeburn  6116:     }
1.1061    raeburn  6117:     $output .= <<"END_BLOCK";
1.1217    raeburn  6118: <div class='$class'>
1.869     kalberla 6119:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 6120:   title='$text'>
                   6121:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 6122:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 6123:   title='$text'>$text</a>
1.867     kalberla 6124: </div>
                   6125: 
                   6126: END_BLOCK
1.474     raeburn  6127: 
1.1061    raeburn  6128:     return ($blocked, $output);
1.854     kalberla 6129: }
1.490     raeburn  6130: 
1.60      matthew  6131: ###############################################
                   6132: 
1.682     raeburn  6133: sub check_ip_acc {
1.1201    raeburn  6134:     my ($acc,$clientip)=@_;
1.682     raeburn  6135:     &Apache::lonxml::debug("acc is $acc");
                   6136:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   6137:         return 1;
                   6138:     }
1.1339    raeburn  6139:     my ($ip,$allowed);
                   6140:     if (($ENV{'REMOTE_ADDR'} eq '127.0.0.1') ||
                   6141:         ($ENV{'REMOTE_ADDR'} eq &Apache::lonnet::get_host_ip($Apache::lonnet::perlvar{'lonHostID'}))) {
                   6142:         $ip = $env{'request.host'} || $ENV{'REMOTE_ADDR'} || $clientip;
                   6143:     } else {
1.1350    raeburn  6144:         my $remote_ip = &Apache::lonnet::get_requestor_ip();
                   6145:         $ip = $remote_ip || $env{'request.host'} || $clientip;
1.1339    raeburn  6146:     }
1.682     raeburn  6147: 
                   6148:     my $name;
1.1219    raeburn  6149:     my %access = (
                   6150:                      allowfrom => 1,
                   6151:                      denyfrom  => 0,
                   6152:                  );
                   6153:     my @allows;
                   6154:     my @denies;
                   6155:     foreach my $item (split(',',$acc)) {
                   6156:         $item =~ s/^\s*//;
                   6157:         $item =~ s/\s*$//;
                   6158:         my $pattern;
                   6159:         if ($item =~ /^\!(.+)$/) {
                   6160:             push(@denies,$1);
                   6161:         } else {
                   6162:             push(@allows,$item);
                   6163:         }
                   6164:    }
                   6165:    my $numdenies = scalar(@denies);
                   6166:    my $numallows = scalar(@allows);
                   6167:    my $count = 0;
                   6168:    foreach my $pattern (@denies,@allows) {
                   6169:         $count ++; 
                   6170:         my $acctype = 'allowfrom';
                   6171:         if ($count <= $numdenies) {
                   6172:             $acctype = 'denyfrom';
                   6173:         }
1.682     raeburn  6174:         if ($pattern =~ /\*$/) {
                   6175:             #35.8.*
                   6176:             $pattern=~s/\*//;
1.1219    raeburn  6177:             if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682     raeburn  6178:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   6179:             #35.8.3.[34-56]
                   6180:             my $low=$2;
                   6181:             my $high=$3;
                   6182:             $pattern=$1;
                   6183:             if ($ip =~ /^\Q$pattern\E/) {
                   6184:                 my $last=(split(/\./,$ip))[3];
1.1219    raeburn  6185:                 if ($last <=$high && $last >=$low) { $allowed=$access{$acctype}; }
1.682     raeburn  6186:             }
                   6187:         } elsif ($pattern =~ /^\*/) {
                   6188:             #*.msu.edu
                   6189:             $pattern=~s/\*//;
                   6190:             if (!defined($name)) {
                   6191:                 use Socket;
                   6192:                 my $netaddr=inet_aton($ip);
                   6193:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   6194:             }
1.1219    raeburn  6195:             if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
1.682     raeburn  6196:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   6197:             #127.0.0.1
1.1219    raeburn  6198:             if ($ip =~ /^\Q$pattern\E/) { $allowed=$access{$acctype}; }
1.682     raeburn  6199:         } else {
                   6200:             #some.name.com
                   6201:             if (!defined($name)) {
                   6202:                 use Socket;
                   6203:                 my $netaddr=inet_aton($ip);
                   6204:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   6205:             }
1.1219    raeburn  6206:             if ($name =~ /\Q$pattern\E$/i) { $allowed=$access{$acctype}; }
                   6207:         }
                   6208:         if ($allowed =~ /^(0|1)$/) { last; }
                   6209:     }
                   6210:     if ($allowed eq '') {
                   6211:         if ($numdenies && !$numallows) {
                   6212:             $allowed = 1;
                   6213:         } else {
                   6214:             $allowed = 0;
1.682     raeburn  6215:         }
                   6216:     }
                   6217:     return $allowed;
                   6218: }
                   6219: 
                   6220: ###############################################
                   6221: 
1.60      matthew  6222: =pod
                   6223: 
1.112     bowersj2 6224: =head1 Domain Template Functions
                   6225: 
                   6226: =over 4
                   6227: 
                   6228: =item * &determinedomain()
1.60      matthew  6229: 
                   6230: Inputs: $domain (usually will be undef)
                   6231: 
1.63      www      6232: Returns: Determines which domain should be used for designs
1.60      matthew  6233: 
                   6234: =cut
1.54      www      6235: 
1.60      matthew  6236: ###############################################
1.63      www      6237: sub determinedomain {
                   6238:     my $domain=shift;
1.531     albertel 6239:     if (! $domain) {
1.60      matthew  6240:         # Determine domain if we have not been given one
1.893     raeburn  6241:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 6242:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   6243:         if ($env{'request.role.domain'}) { 
                   6244:             $domain=$env{'request.role.domain'}; 
1.60      matthew  6245:         }
                   6246:     }
1.63      www      6247:     return $domain;
                   6248: }
                   6249: ###############################################
1.517     raeburn  6250: 
1.518     albertel 6251: sub devalidate_domconfig_cache {
                   6252:     my ($udom)=@_;
                   6253:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   6254: }
                   6255: 
                   6256: # ---------------------- Get domain configuration for a domain
                   6257: sub get_domainconf {
                   6258:     my ($udom) = @_;
                   6259:     my $cachetime=1800;
                   6260:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   6261:     if (defined($cached)) { return %{$result}; }
                   6262: 
                   6263:     my %domconfig = &Apache::lonnet::get_dom('configuration',
1.948     raeburn  6264: 					     ['login','rolecolors','autoenroll'],$udom);
1.632     raeburn  6265:     my (%designhash,%legacy);
1.518     albertel 6266:     if (keys(%domconfig) > 0) {
                   6267:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  6268:             if (keys(%{$domconfig{'login'}})) {
                   6269:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  6270:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
1.1208    raeburn  6271:                         if (($key eq 'loginvia') || ($key eq 'headtag')) {
                   6272:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   6273:                                 foreach my $hostname (keys(%{$domconfig{'login'}{$key}})) {
                   6274:                                     if (ref($domconfig{'login'}{$key}{$hostname}) eq 'HASH') {
                   6275:                                         if ($key eq 'loginvia') {
                   6276:                                             if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) {
                   6277:                                                 my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'};
                   6278:                                                 $designhash{$udom.'.login.loginvia'} = $server;
                   6279:                                                 if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') {
                   6280: 
                   6281:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'};
                   6282:                                                 } else {
                   6283:                                                     $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'};
                   6284:                                                 }
1.948     raeburn  6285:                                             }
1.1208    raeburn  6286:                                         } elsif ($key eq 'headtag') {
                   6287:                                             if ($domconfig{'login'}{'headtag'}{$hostname}{'url'}) {
                   6288:                                                 $designhash{$udom.'.login.headtag_'.$hostname} = $domconfig{'login'}{'headtag'}{$hostname}{'url'};
1.948     raeburn  6289:                                             }
1.946     raeburn  6290:                                         }
1.1208    raeburn  6291:                                         if ($domconfig{'login'}{$key}{$hostname}{'exempt'}) {
                   6292:                                             $designhash{$udom.'.login.'.$key.'_exempt_'.$hostname} = $domconfig{'login'}{$key}{$hostname}{'exempt'};
                   6293:                                         }
1.946     raeburn  6294:                                     }
                   6295:                                 }
                   6296:                             }
1.1366    raeburn  6297:                         } elsif ($key eq 'saml') {
                   6298:                             if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   6299:                                 foreach my $host (keys(%{$domconfig{'login'}{$key}})) {
                   6300:                                     if (ref($domconfig{'login'}{$key}{$host}) eq 'HASH') {
                   6301:                                         $designhash{$udom.'.login.'.$key.'_'.$host} = 1;
1.1386    raeburn  6302:                                         foreach my $item ('text','img','alt','url','title','window','notsso') {
1.1366    raeburn  6303:                                             $designhash{$udom.'.login.'.$key.'_'.$item.'_'.$host} = $domconfig{'login'}{$key}{$host}{$item};
                   6304:                                         }
                   6305:                                     }
                   6306:                                 }
                   6307:                             }
1.946     raeburn  6308:                         } else {
                   6309:                             foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   6310:                                 $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   6311:                                     $domconfig{'login'}{$key}{$img};
                   6312:                             }
1.699     raeburn  6313:                         }
                   6314:                     } else {
                   6315:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   6316:                     }
1.632     raeburn  6317:                 }
                   6318:             } else {
                   6319:                 $legacy{'login'} = 1;
1.518     albertel 6320:             }
1.632     raeburn  6321:         } else {
                   6322:             $legacy{'login'} = 1;
1.518     albertel 6323:         }
                   6324:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  6325:             if (keys(%{$domconfig{'rolecolors'}})) {
                   6326:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   6327:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   6328:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   6329:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   6330:                         }
1.518     albertel 6331:                     }
                   6332:                 }
1.632     raeburn  6333:             } else {
                   6334:                 $legacy{'rolecolors'} = 1;
1.518     albertel 6335:             }
1.632     raeburn  6336:         } else {
                   6337:             $legacy{'rolecolors'} = 1;
1.518     albertel 6338:         }
1.948     raeburn  6339:         if (ref($domconfig{'autoenroll'}) eq 'HASH') {
                   6340:             if ($domconfig{'autoenroll'}{'co-owners'}) {
                   6341:                 $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'};
                   6342:             }
                   6343:         }
1.632     raeburn  6344:         if (keys(%legacy) > 0) {
                   6345:             my %legacyhash = &get_legacy_domconf($udom);
                   6346:             foreach my $item (keys(%legacyhash)) {
                   6347:                 if ($item =~ /^\Q$udom\E\.login/) {
                   6348:                     if ($legacy{'login'}) { 
                   6349:                         $designhash{$item} = $legacyhash{$item};
                   6350:                     }
                   6351:                 } else {
                   6352:                     if ($legacy{'rolecolors'}) {
                   6353:                         $designhash{$item} = $legacyhash{$item};
                   6354:                     }
1.518     albertel 6355:                 }
                   6356:             }
                   6357:         }
1.632     raeburn  6358:     } else {
                   6359:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 6360:     }
                   6361:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   6362: 				  $cachetime);
                   6363:     return %designhash;
                   6364: }
                   6365: 
1.632     raeburn  6366: sub get_legacy_domconf {
                   6367:     my ($udom) = @_;
                   6368:     my %legacyhash;
                   6369:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   6370:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   6371:     if (-e $designfile) {
1.1317    raeburn  6372:         if ( open (my $fh,'<',$designfile) ) {
1.632     raeburn  6373:             while (my $line = <$fh>) {
                   6374:                 next if ($line =~ /^\#/);
                   6375:                 chomp($line);
                   6376:                 my ($key,$val)=(split(/\=/,$line));
                   6377:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   6378:             }
                   6379:             close($fh);
                   6380:         }
                   6381:     }
1.1026    raeburn  6382:     if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/adm/lonDomLogos/'.$udom.'.gif') {
1.632     raeburn  6383:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   6384:     }
                   6385:     return %legacyhash;
                   6386: }
                   6387: 
1.63      www      6388: =pod
                   6389: 
1.112     bowersj2 6390: =item * &domainlogo()
1.63      www      6391: 
                   6392: Inputs: $domain (usually will be undef)
                   6393: 
                   6394: Returns: A link to a domain logo, if the domain logo exists.
                   6395: If the domain logo does not exist, a description of the domain.
                   6396: 
                   6397: =cut
1.112     bowersj2 6398: 
1.63      www      6399: ###############################################
                   6400: sub domainlogo {
1.517     raeburn  6401:     my $domain = &determinedomain(shift);
1.518     albertel 6402:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  6403:     # See if there is a logo
                   6404:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  6405:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 6406:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   6407: 	    if ($imgsrc =~ m{^/res/}) {
                   6408: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   6409: 		&Apache::lonnet::repcopy($local_name);
                   6410: 	    }
                   6411: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.1374    raeburn  6412:         }
                   6413:         my $alttext = $domain;
                   6414:         if ($designhash{$domain.'.login.alttext_domlogo'} ne '') {
                   6415:             $alttext = $designhash{$domain.'.login.alttext_domlogo'};
                   6416:         }
                   6417:         return '<img src="'.$imgsrc.'" alt="'.$alttext.'" id="lclogindomlogo" />';
1.514     albertel 6418:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   6419:         return &Apache::lonnet::domain($domain,'description');
1.59      www      6420:     } else {
1.60      matthew  6421:         return '';
1.59      www      6422:     }
                   6423: }
1.63      www      6424: ##############################################
                   6425: 
                   6426: =pod
                   6427: 
1.112     bowersj2 6428: =item * &designparm()
1.63      www      6429: 
                   6430: Inputs: $which parameter; $domain (usually will be undef)
                   6431: 
                   6432: Returns: value of designparamter $which
                   6433: 
                   6434: =cut
1.112     bowersj2 6435: 
1.397     albertel 6436: 
1.400     albertel 6437: ##############################################
1.397     albertel 6438: sub designparm {
                   6439:     my ($which,$domain)=@_;
                   6440:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   6441:         return $env{'environment.color.'.$which};
1.96      www      6442:     }
1.63      www      6443:     $domain=&determinedomain($domain);
1.1016    raeburn  6444:     my %domdesign;
                   6445:     unless ($domain eq 'public') {
                   6446:         %domdesign = &get_domainconf($domain);
                   6447:     }
1.520     raeburn  6448:     my $output;
1.517     raeburn  6449:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   6450:         $output = $domdesign{$domain.'.'.$which};
1.63      www      6451:     } else {
1.520     raeburn  6452:         $output = $defaultdesign{$which};
                   6453:     }
                   6454:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  6455:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 6456:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   6457:             if ($output =~ m{^/res/}) {
                   6458:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   6459:                 &Apache::lonnet::repcopy($local_name);
                   6460:             }
1.520     raeburn  6461:             $output = &lonhttpdurl($output);
                   6462:         }
1.63      www      6463:     }
1.520     raeburn  6464:     return $output;
1.63      www      6465: }
1.59      www      6466: 
1.822     bisitz   6467: ##############################################
                   6468: =pod
                   6469: 
1.832     bisitz   6470: =item * &authorspace()
                   6471: 
1.1028    raeburn  6472: Inputs: $url (usually will be undef).
1.832     bisitz   6473: 
1.1132    raeburn  6474: Returns: Path to Authoring Space containing the resource or 
1.1028    raeburn  6475:          directory being viewed (or for which action is being taken). 
                   6476:          If $url is provided, and begins /priv/<domain>/<uname>
                   6477:          the path will be that portion of the $context argument.
                   6478:          Otherwise the path will be for the author space of the current
                   6479:          user when the current role is author, or for that of the 
                   6480:          co-author/assistant co-author space when the current role 
                   6481:          is co-author or assistant co-author.
1.832     bisitz   6482: 
                   6483: =cut
                   6484: 
                   6485: sub authorspace {
1.1028    raeburn  6486:     my ($url) = @_;
                   6487:     if ($url ne '') {
                   6488:         if ($url =~ m{^(/priv/$match_domain/$match_username/)}) {
                   6489:            return $1;
                   6490:         }
                   6491:     }
1.832     bisitz   6492:     my $caname = '';
1.1024    www      6493:     my $cadom = '';
1.1028    raeburn  6494:     if ($env{'request.role'} =~ /^(?:ca|aa)/) {
1.1024    www      6495:         ($cadom,$caname) =
1.832     bisitz   6496:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
1.1028    raeburn  6497:     } elsif ($env{'request.role'} =~ m{^au\./($match_domain)/}) {
1.832     bisitz   6498:         $caname = $env{'user.name'};
1.1024    www      6499:         $cadom = $env{'user.domain'};
1.832     bisitz   6500:     }
1.1028    raeburn  6501:     if (($caname ne '') && ($cadom ne '')) {
                   6502:         return "/priv/$cadom/$caname/";
                   6503:     }
                   6504:     return;
1.832     bisitz   6505: }
                   6506: 
                   6507: ##############################################
                   6508: =pod
                   6509: 
1.822     bisitz   6510: =item * &head_subbox()
                   6511: 
                   6512: Inputs: $content (contains HTML code with page functions, etc.)
                   6513: 
                   6514: Returns: HTML div with $content
                   6515:          To be included in page header
                   6516: 
                   6517: =cut
                   6518: 
                   6519: sub head_subbox {
                   6520:     my ($content)=@_;
                   6521:     my $output =
1.993     raeburn  6522:         '<div class="LC_head_subbox">'
1.822     bisitz   6523:        .$content
                   6524:        .'</div>'
                   6525: }
                   6526: 
                   6527: ##############################################
                   6528: =pod
                   6529: 
                   6530: =item * &CSTR_pageheader()
                   6531: 
1.1026    raeburn  6532: Input: (optional) filename from which breadcrumb trail is built.
                   6533:        In most cases no input as needed, as $env{'request.filename'}
                   6534:        is appropriate for use in building the breadcrumb trail.
1.1379    raeburn  6535:        frameset flag
                   6536:        If page header is being requested for use in a frameset, then
                   6537:        the second (option) argument -- frameset will be true, and
                   6538:        the target attribute set for links should be target="_parent".
1.1407    raeburn  6539:        If $title is supplied as the thitd arg, that will be used to 
                   6540:        the left of the breadcrumbs tail for the current path.
1.822     bisitz   6541: 
                   6542: Returns: HTML div with CSTR path and recent box
1.1132    raeburn  6543:          To be included on Authoring Space pages
1.822     bisitz   6544: 
                   6545: =cut
                   6546: 
                   6547: sub CSTR_pageheader {
1.1407    raeburn  6548:     my ($trailfile,$frameset,$title) = @_;
1.1026    raeburn  6549:     if ($trailfile eq '') {
                   6550:         $trailfile = $env{'request.filename'};
                   6551:     }
                   6552: 
                   6553: # this is for resources; directories have customtitle, and crumbs
                   6554: # and select recent are created in lonpubdir.pm
                   6555: 
                   6556:     my $londocroot = $Apache::lonnet::perlvar{'lonDocRoot'};
1.1022    www      6557:     my ($udom,$uname,$thisdisfn)=
1.1113    raeburn  6558:         ($trailfile =~ m{^\Q$londocroot\E/priv/([^/]+)/([^/]+)(?:|/(.*))$});
1.1026    raeburn  6559:     my $formaction = "/priv/$udom/$uname/$thisdisfn";
                   6560:     $formaction =~ s{/+}{/}g;
1.822     bisitz   6561: 
                   6562:     my $parentpath = '';
                   6563:     my $lastitem = '';
                   6564:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   6565:         $parentpath = $1;
                   6566:         $lastitem = $2;
                   6567:     } else {
                   6568:         $lastitem = $thisdisfn;
                   6569:     }
1.921     bisitz   6570: 
1.1406    raeburn  6571:     my $crsauthor;
1.1246    raeburn  6572:     if (($env{'request.course.id'}) &&
                   6573:         ($env{'course.'.$env{'request.course.id'}.'.num'} eq $uname) &&
1.1247    raeburn  6574:         ($env{'course.'.$env{'request.course.id'}.'.domain'} eq $udom)) {
1.1246    raeburn  6575:         $crsauthor = 1;
1.1406    raeburn  6576:         if ($title eq '') {
                   6577:             $title = &mt('Course Authoring Space');
                   6578:         }
                   6579:     } elsif ($title eq '') {
1.1246    raeburn  6580:         $title = &mt('Authoring Space');
                   6581:     }
                   6582: 
1.1379    raeburn  6583:     my ($target,$crumbtarget) = (' target="_top"','_top');
                   6584:     if ($frameset) {
                   6585:         $target = ' target="_parent"';
                   6586:         $crumbtarget = '_parent';
                   6587:     } elsif (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
1.1314    raeburn  6588:         $target = '';
                   6589:         $crumbtarget = '';
1.1379    raeburn  6590:     } elsif (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'})) {
1.1378    raeburn  6591:         $target = ' target="'.$env{'request.deeplink.target'}.'"';
                   6592:         $crumbtarget = $env{'request.deeplink.target'};
                   6593:     }
1.1313    raeburn  6594: 
1.921     bisitz   6595:     my $output =
1.1407    raeburn  6596:          '<div>'
1.822     bisitz   6597:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
1.1246    raeburn  6598:         .'<b>'.$title.'</b> '
1.1314    raeburn  6599:         .'<form name="dirs" method="post" action="'.$formaction.'"'.$target.'>'
                   6600:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,$crumbtarget,'/priv/'.$udom,undef,undef);
1.921     bisitz   6601: 
                   6602:     if ($lastitem) {
                   6603:         $output .=
                   6604:              '<span class="LC_filename">'
                   6605:             .$lastitem
                   6606:             .'</span>';
                   6607:     }
1.1245    raeburn  6608: 
1.1246    raeburn  6609:     if ($crsauthor) {
1.1379    raeburn  6610:         $output .= '</form>'.&Apache::lonmenu::constspaceform($frameset);
1.1246    raeburn  6611:     } else {
                   6612:         $output .=
                   6613:              '<br />'
1.1314    raeburn  6614:             #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/',$crumbtarget,'/priv','','+1',1)."</b></tt><br />"
1.1246    raeburn  6615:             .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   6616:             .'</form>'
1.1379    raeburn  6617:             .&Apache::lonmenu::constspaceform($frameset);
1.1246    raeburn  6618:     }
1.1407    raeburn  6619:     $output .= '</div>';
1.921     bisitz   6620: 
                   6621:     return $output;
1.822     bisitz   6622: }
                   6623: 
1.1419    raeburn  6624: ##############################################
                   6625: =pod
                   6626: 
                   6627: =item * &nocodemirror()
                   6628: 
                   6629: Input: None
                   6630: 
                   6631: Returns: 1 if CodeMirror is deactivated based on
                   6632:          user's preference, or domain default,
                   6633:          if user indicated use of default.
                   6634: 
                   6635: =cut
                   6636: 
1.1416    raeburn  6637: sub nocodemirror {
                   6638:     my $nocodem = $env{'environment.nocodemirror'};
                   6639:     unless ($nocodem) {
                   6640:         my %domdefs = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   6641:         if ($domdefs{'nocodemirror'}) {
                   6642:             $nocodem = 'yes';
                   6643:         }
                   6644:     }
1.1417    raeburn  6645:     if ($nocodem eq 'yes') {
                   6646:         return 1;
                   6647:     }
                   6648:     return;
1.1416    raeburn  6649: }
                   6650: 
1.1419    raeburn  6651: ##############################################
                   6652: =pod
                   6653: 
                   6654: =item * &permitted_editors()
                   6655: 
1.1422    raeburn  6656: Input: $uri (optional)
1.1419    raeburn  6657: 
                   6658: Returns: %editors hash in which keys are editors
                   6659:          permitted in current Authoring Space.
                   6660:          Value for each key is 1. Possible keys
                   6661:          are: edit, xml, and daxe. If no specific
                   6662:          set of editors has been set for the Author
                   6663:          who owns the Authoring Space, then the
                   6664:          domain default will be used.  If no domain
                   6665:          default has been set, then the keys will be
                   6666:          edit and xml.
                   6667: 
                   6668: =cut
                   6669: 
1.1418    raeburn  6670: sub permitted_editors {
1.1422    raeburn  6671:     my ($uri) = @_;
1.1418    raeburn  6672:     my ($is_author,$is_coauthor,$auname,$audom,%editors);
                   6673:     if ($env{'request.role'} =~ m{^au\./}) {
                   6674:         $is_author = 1;
                   6675:     } elsif ($env{'request.role'} =~ m{^(?:ca|aa)\./($match_domain)/($match_username)}) {
                   6676:         ($audom,$auname) = ($1,$2);
                   6677:         if (($audom ne '') && ($auname ne '')) {
                   6678:             if (($env{'user.domain'} eq $audom) &&
                   6679:                 ($env{'user.name'} eq $auname)) {
                   6680:                 $is_author = 1;
                   6681:             } else {
                   6682:                 $is_coauthor = 1;
                   6683:             }
                   6684:         }
                   6685:     } elsif ($env{'request.course.id'}) {
                   6686:         if ($env{'request.editurl'} =~ m{^/priv/($match_domain)/($match_username)/}) {
                   6687:             ($audom,$auname) = ($1,$2);
                   6688:         } elsif ($env{'request.uri'} =~ m{^/priv/($match_domain)/($match_username)/}) {
                   6689:             ($audom,$auname) = ($1,$2);
1.1422    raeburn  6690:         } elsif (($uri eq '/daxesave') &&
                   6691:                  ($env{'form.path'} =~ m{^/daxeopen/priv/($match_domain)/($match_username)/})) {
                   6692:             ($audom,$auname) = ($1,$2);
1.1418    raeburn  6693:         }
                   6694:         if (($audom ne '') && ($auname ne '')) {
                   6695:             if (($env{'user.domain'} eq $audom) &&
                   6696:                 ($env{'user.name'} eq $auname)) {
                   6697:                 $is_author = 1;
                   6698:             } else {
                   6699:                 $is_coauthor = 1;
                   6700:             }
                   6701:         }
                   6702:     }
                   6703:     if ($is_author) {
                   6704:         if (exists($env{'environment.editors'})) {
                   6705:             map { $editors{$_} = 1; } split(/,/,$env{'environment.editors'});
                   6706:         } else {
                   6707:             %editors = ( edit => 1,
                   6708:                          xml => 1,
                   6709:                        );
                   6710:         }
                   6711:     } elsif ($is_coauthor) {
                   6712:         if (exists($env{"environment.internal.editors./$audom/$auname"})) {
                   6713:             map { $editors{$_} = 1; } split(/,/,$env{"environment.internal.editors./$audom/$auname"});
                   6714:         } else {
                   6715:             %editors = ( edit => 1,
                   6716:                          xml => 1,
                   6717:                        );
                   6718:         }
                   6719:     } else {
                   6720:         %editors = ( edit => 1,
                   6721:                      xml => 1,
                   6722:                    );
                   6723:     }
                   6724:     return %editors;
                   6725: }
                   6726: 
1.60      matthew  6727: ###############################################
                   6728: ###############################################
                   6729: 
                   6730: =pod
                   6731: 
1.112     bowersj2 6732: =back
                   6733: 
1.549     albertel 6734: =head1 HTML Helpers
1.112     bowersj2 6735: 
                   6736: =over 4
                   6737: 
                   6738: =item * &bodytag()
1.60      matthew  6739: 
                   6740: Returns a uniform header for LON-CAPA web pages.
                   6741: 
                   6742: Inputs: 
                   6743: 
1.112     bowersj2 6744: =over 4
                   6745: 
                   6746: =item * $title, A title to be displayed on the page.
                   6747: 
                   6748: =item * $function, the current role (can be undef).
                   6749: 
                   6750: =item * $addentries, extra parameters for the <body> tag.
                   6751: 
                   6752: =item * $bodyonly, if defined, only return the <body> tag.
                   6753: 
                   6754: =item * $domain, if defined, force a given domain.
                   6755: 
                   6756: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      6757:             text interface only)
1.60      matthew  6758: 
1.814     bisitz   6759: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   6760:                      navigational links
1.317     albertel 6761: 
1.338     albertel 6762: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   6763: 
1.460     albertel 6764: =item * $args, optional argument valid values are
                   6765:             no_auto_mt_title -> prevents &mt()ing the title arg
1.1274    raeburn  6766:             use_absolute     -> for external resource or syllabus, this will
                   6767:                                 contain https://<hostname> if server uses
                   6768:                                 https (as per hosts.tab), but request is for http
                   6769:             hostname         -> hostname, from $r->hostname().
1.460     albertel 6770: 
1.1096    raeburn  6771: =item * $advtoolsref, optional argument, ref to an array containing
                   6772:             inlineremote items to be added in "Functions" menu below
                   6773:             breadcrumbs.
                   6774: 
1.1316    raeburn  6775: =item * $ltiscope, optional argument, will be one of: resource, map or
                   6776:             course, if LON-CAPA is in LTI Provider context. Value is
                   6777:             the scope of use, i.e., launch was for access to a single, a map
                   6778:             or the entire course.
                   6779: 
                   6780: =item * $ltiuri, optional argument, if LON-CAPA is in LTI Provider
                   6781:             context, this will contain the URL for the landing item in
                   6782:             the course, after launch from an LTI Consumer
                   6783: 
1.1318    raeburn  6784: =item * $ltimenu, optional argument, if LON-CAPA is in LTI Provider
                   6785:             context, this will contain a reference to hash of items
                   6786:             to be included in the page header and/or inline menu.
                   6787: 
1.1385    raeburn  6788: =item * $menucoll, optional argument, if specific menu collection is in
                   6789:             effect, either set as the default for the course, or set for
                   6790:             the deeplink paramater for $env{'request.deeplink.login'}
                   6791:             then $menucoll will be the number of that collection. 
                   6792: 
                   6793: =item * $menuref, optional argument, reference to a hash, containing the
                   6794:             menu options included for the menu in effect, based on the
                   6795:             configuration for the numbered menu collection in use.  
                   6796: 
                   6797: =item * $showncrumbsref, reference to a scalar. Calls to lonmenu::innerregister
                   6798:             within &bodytag() can result in calls to lonhtmlcommon::breadcrumbs(),
                   6799:             if so, $showncrumbsref is set there to 1, and will propagate back
                   6800:             via &bodytag() to &start_page(), to prevent lonhtmlcommon::breadcrumbs()
                   6801:             being called a second time.
                   6802: 
1.112     bowersj2 6803: =back
                   6804: 
1.60      matthew  6805: Returns: A uniform header for LON-CAPA web pages.  
                   6806: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   6807: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   6808: other decorations will be returned.
                   6809: 
                   6810: =cut
                   6811: 
1.54      www      6812: sub bodytag {
1.831     bisitz   6813:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.1359    raeburn  6814:         $no_nav_bar,$bgcolor,$args,$advtoolsref,$ltiscope,$ltiuri,
1.1385    raeburn  6815:         $ltimenu,$menucoll,$menuref,$showncrumbsref)=@_;
1.339     albertel 6816: 
1.954     raeburn  6817:     my $public;
                   6818:     if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public'))
                   6819:         || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   6820:         $public = 1;
                   6821:     }
1.460     albertel 6822:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.1154    raeburn  6823:     my $httphost = $args->{'use_absolute'};
1.1274    raeburn  6824:     my $hostname = $args->{'hostname'};
1.339     albertel 6825: 
1.183     matthew  6826:     $function = &get_users_function() if (!$function);
1.339     albertel 6827:     my $img =    &designparm($function.'.img',$domain);
                   6828:     my $font =   &designparm($function.'.font',$domain);
                   6829:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   6830: 
1.803     bisitz   6831:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 6832: 		   'bgcolor' => $pgbg,
1.339     albertel 6833: 		   'text'    => $font,
                   6834:                    'alink'   => &designparm($function.'.alink',$domain),
                   6835: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   6836: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 6837:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 6838: 
1.63      www      6839:  # role and realm
1.1178    raeburn  6840:     my ($role,$realm) = split(m{\./},$env{'request.role'},2);
                   6841:     if ($realm) {
                   6842:         $realm = '/'.$realm;
                   6843:     }
1.1357    raeburn  6844:     if ($role eq 'ca') {
1.479     albertel 6845:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 6846:         $realm = &plainname($rname,$rdom);
1.378     raeburn  6847:     } 
1.55      www      6848: # realm
1.1357    raeburn  6849:     my ($cid,$sec);
1.258     albertel 6850:     if ($env{'request.course.id'}) {
1.1357    raeburn  6851:         $cid = $env{'request.course.id'};
                   6852:         if ($env{'request.course.sec'}) {
                   6853:             $sec = $env{'request.course.sec'};
                   6854:         }
                   6855:     } elsif ($realm =~ m{^/($match_domain)/($match_courseid)(?:|/(\w+))$}) {
                   6856:         if (&Apache::lonnet::is_course($1,$2)) {
                   6857:             $cid = $1.'_'.$2;
                   6858:             $sec = $3;
                   6859:         }
                   6860:     }
                   6861:     if ($cid) {
1.378     raeburn  6862:         if ($env{'request.role'} !~ /^cr/) {
                   6863:             $role = &Apache::lonnet::plaintext($role,&course_type());
1.1257    raeburn  6864:         } elsif ($role =~ m{^cr/($match_domain)/\1-domainconfig/(\w+)$}) {
1.1269    raeburn  6865:             if ($env{'request.role.desc'}) {
                   6866:                 $role = $env{'request.role.desc'};
                   6867:             } else {
                   6868:                 $role = &mt('Helpdesk[_1]','&nbsp;'.$2);
                   6869:             }
1.1257    raeburn  6870:         } else {
                   6871:             $role = (split(/\//,$role,4))[-1]; 
1.378     raeburn  6872:         }
1.1357    raeburn  6873:         if ($sec) {
                   6874:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$sec;
1.898     raeburn  6875:         }   
1.1357    raeburn  6876: 	$realm = $env{'course.'.$cid.'.description'};
1.378     raeburn  6877:     } else {
                   6878:         $role = &Apache::lonnet::plaintext($role);
1.54      www      6879:     }
1.433     albertel 6880: 
1.359     albertel 6881:     if (!$realm) { $realm='&nbsp;'; }
1.330     albertel 6882: 
1.438     albertel 6883:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 6884: 
1.101     www      6885: # construct main body tag
1.359     albertel 6886:     my $bodytag = "<body $extra_body_attr>".
1.1235    raeburn  6887: 	&Apache::lontexconvert::init_math_support();
1.252     albertel 6888: 
1.1131    raeburn  6889:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6890: 
1.1130    raeburn  6891:     if (($bodyonly) || ($no_nav_bar) || ($env{'form.inhibitmenu'} eq 'yes')) {
1.60      matthew  6892:         return $bodytag;
1.1130    raeburn  6893:     }
1.359     albertel 6894: 
1.954     raeburn  6895:     if ($public) {
1.433     albertel 6896: 	undef($role);
                   6897:     }
1.1318    raeburn  6898: 
1.1359    raeburn  6899:     my $showcrstitle = 1;
1.1357    raeburn  6900:     if (($cid) && ($env{'request.lti.login'})) {
1.1318    raeburn  6901:         if (ref($ltimenu) eq 'HASH') {
                   6902:             unless ($ltimenu->{'role'}) {
                   6903:                 undef($role);
                   6904:             }
                   6905:             unless ($ltimenu->{'coursetitle'}) {
                   6906:                 $realm='&nbsp;';
1.1359    raeburn  6907:                 $showcrstitle = 0;
                   6908:             }
                   6909:         }
                   6910:     } elsif (($cid) && ($menucoll)) {
                   6911:         if (ref($menuref) eq 'HASH') {
                   6912:             unless ($menuref->{'role'}) {
                   6913:                 undef($role);
                   6914:             }
                   6915:             unless ($menuref->{'crs'}) {
                   6916:                 $realm='&nbsp;';
                   6917:                 $showcrstitle = 0;
1.1318    raeburn  6918:             }
                   6919:         }
                   6920:     }
                   6921: 
1.762     bisitz   6922:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 6923:     #
                   6924:     # Extra info if you are the DC
                   6925:     my $dc_info = '';
1.1359    raeburn  6926:     if (($env{'user.adv'}) && ($env{'request.course.id'}) && $showcrstitle &&
1.1357    raeburn  6927:         (exists($env{'user.role.dc./'.$env{'course.'.$cid.'.domain'}.'/'}))) {
1.917     raeburn  6928:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      6929:         $dc_info =~ s/\s+$//;
1.359     albertel 6930:     }
                   6931: 
1.1237    raeburn  6932:     my $crstype;
1.1357    raeburn  6933:     if ($cid) {
                   6934:         $crstype = $env{'course.'.$cid.'.type'};
1.1237    raeburn  6935:     } elsif ($args->{'crstype'}) {
                   6936:         $crstype = $args->{'crstype'};
                   6937:     }
                   6938:     if (($crstype eq 'Placement') && (!$env{'request.role.adv'})) {
                   6939:         undef($role);
                   6940:     } else {
1.1242    raeburn  6941:         $role = '<span class="LC_nobreak">('.$role.')</span>' if ($role && !$env{'browser.mobile'});
1.1237    raeburn  6942:     }
1.853     droeschl 6943: 
1.903     droeschl 6944:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   6945: 
                   6946:         #    if ($env{'request.state'} eq 'construct') {
                   6947:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   6948:         #    }
                   6949: 
1.1130    raeburn  6950:         $bodytag .= Apache::lonhtmlcommon::scripttag(
1.1154    raeburn  6951:             Apache::lonmenu::utilityfunctions($httphost), 'start');
1.359     albertel 6952: 
1.1423    raeburn  6953:         if ($args->{'collapsible_header'} ne '') {
1.1421    raeburn  6954:             my $alttext = &mt('menu state: collapsed');
                   6955:             my $tooltip = &mt('display standard menus');
                   6956:             $bodytag .= <<"END";
                   6957: <div id="LC_expandingContainer" style="display:inline;">
                   6958: <div id="LC_collapsible" class="LC_collapse_trigger" style="position: absolute;top: -5px;left: 0px; z-index:101; display:inline;">
                   6959: <a href="#" style="text-decoration:none;"><img class="LC_collapsible_indicator" alt="$alttext" title="$tooltip" src="/res/adm/pages/collapsed.png" style="border:0;margin:0;padding:0;max-width:100%;height:auto" /></a></div>
                   6960: <div class="LC_menus_content hidden">
                   6961: END
                   6962:         }
1.1318    raeburn  6963:         unless ($args->{'no_primary_menu'}) {
1.1369    raeburn  6964:             my ($left,$right) = Apache::lonmenu::primary_menu($crstype,$ltimenu,$menucoll,$menuref,
1.1380    raeburn  6965:                                                               $args->{'links_disabled'},
1.1421    raeburn  6966:                                                               $args->{'links_target'},
                   6967:                                                               $args->{'collapsible_header'});
1.359     albertel 6968: 
1.1318    raeburn  6969:             if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
                   6970:                 if ($dc_info) {
                   6971:                     $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   6972:                 }
                   6973:                 $bodytag .= qq|<div id="LC_nav_bar">$left $role<br />
                   6974:                                <em>$realm</em> $dc_info</div>|;
                   6975:                 return $bodytag;
                   6976:             }
1.894     droeschl 6977: 
1.1318    raeburn  6978:             unless ($env{'request.symb'} =~ m/\.page___\d+___/) {
                   6979:                 $bodytag .= qq|<div id="LC_nav_bar">$left $role</div>|;
                   6980:             }
1.916     droeschl 6981: 
1.1318    raeburn  6982:             $bodytag .= $right;
1.852     droeschl 6983: 
1.1318    raeburn  6984:             if ($dc_info) {
                   6985:                 $dc_info = &dc_courseid_toggle($dc_info);
                   6986:             }
                   6987:             $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.917     raeburn  6988:         }
1.916     droeschl 6989: 
1.1169    raeburn  6990:         #if directed to not display the secondary menu, don't.  
1.1168    raeburn  6991:         if ($args->{'no_secondary_menu'}) {
                   6992:             return $bodytag;
                   6993:         }
1.1169    raeburn  6994:         #don't show menus for public users
1.954     raeburn  6995:         if (!$public){
1.1318    raeburn  6996:             unless ($args->{'no_inline_menu'}) {
                   6997:                 $bodytag .= Apache::lonmenu::secondary_menu($httphost,$ltiscope,$ltimenu,
1.1359    raeburn  6998:                                                             $args->{'no_primary_menu'},
1.1369    raeburn  6999:                                                             $menucoll,$menuref,
1.1380    raeburn  7000:                                                             $args->{'links_disabled'},
                   7001:                                                             $args->{'links_target'});
1.1318    raeburn  7002:             }
1.903     droeschl 7003:             $bodytag .= Apache::lonmenu::serverform();
1.920     raeburn  7004:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end');
                   7005:             if ($env{'request.state'} eq 'construct') {
1.962     droeschl 7006:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,
1.1385    raeburn  7007:                                 $args->{'bread_crumbs'},'','',$hostname,
                   7008:                                 $ltiscope,$ltiuri,$showncrumbsref);
1.1096    raeburn  7009:             } elsif ($forcereg) {
                   7010:                 $bodytag .= &Apache::lonmenu::innerregister($forcereg,undef,
1.1385    raeburn  7011:                                 $args->{'group'},$args->{'hide_buttons'},
                   7012:                                 $hostname,$ltiscope,$ltiuri,$showncrumbsref);
1.1096    raeburn  7013:             } else {
                   7014:                 $bodytag .= 
                   7015:                     &Apache::lonmenu::prepare_functions($env{'request.noversionuri'},
                   7016:                                                         $forcereg,$args->{'group'},
                   7017:                                                         $args->{'bread_crumbs'},
1.1274    raeburn  7018:                                                         $advtoolsref,'',$hostname);
1.920     raeburn  7019:             }
1.903     droeschl 7020:         }else{
                   7021:             # this is to seperate menu from content when there's no secondary
                   7022:             # menu. Especially needed for public accessible ressources.
                   7023:             $bodytag .= '<hr style="clear:both" />';
                   7024:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  7025:         }
1.1423    raeburn  7026:         if ($args->{'collapsible_header'} ne '') {
                   7027:             $bodytag .= $args->{'collapsible_header'}.
                   7028:                         '<div id="LC_collapsible_separator"></div>'.
1.1421    raeburn  7029:                         '</div></div>';
                   7030:         }
1.235     raeburn  7031:         return $bodytag;
1.182     matthew  7032: }
                   7033: 
1.917     raeburn  7034: sub dc_courseid_toggle {
                   7035:     my ($dc_info) = @_;
1.980     raeburn  7036:     return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'.
1.1069    raeburn  7037:            '<a href="javascript:showCourseID();" class="LC_menubuttons_link">'.
1.917     raeburn  7038:            &mt('(More ...)').'</a></span>'.
                   7039:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   7040: }
                   7041: 
1.330     albertel 7042: sub make_attr_string {
                   7043:     my ($register,$attr_ref) = @_;
                   7044: 
                   7045:     if ($attr_ref && !ref($attr_ref)) {
                   7046: 	die("addentries Must be a hash ref ".
                   7047: 	    join(':',caller(1))." ".
                   7048: 	    join(':',caller(0))." ");
                   7049:     }
                   7050: 
                   7051:     if ($register) {
1.339     albertel 7052: 	my ($on_load,$on_unload);
                   7053: 	foreach my $key (keys(%{$attr_ref})) {
                   7054: 	    if      (lc($key) eq 'onload') {
                   7055: 		$on_load.=$attr_ref->{$key}.';';
                   7056: 		delete($attr_ref->{$key});
                   7057: 
                   7058: 	    } elsif (lc($key) eq 'onunload') {
                   7059: 		$on_unload.=$attr_ref->{$key}.';';
                   7060: 		delete($attr_ref->{$key});
                   7061: 	    }
                   7062: 	}
1.953     droeschl 7063: 	$attr_ref->{'onload'}  = $on_load;
                   7064: 	$attr_ref->{'onunload'}= $on_unload;
1.330     albertel 7065:     }
1.339     albertel 7066: 
1.330     albertel 7067:     my $attr_string;
1.1159    raeburn  7068:     foreach my $attr (sort(keys(%$attr_ref))) {
1.330     albertel 7069: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   7070:     }
                   7071:     return $attr_string;
                   7072: }
                   7073: 
                   7074: 
1.182     matthew  7075: ###############################################
1.251     albertel 7076: ###############################################
                   7077: 
                   7078: =pod
                   7079: 
                   7080: =item * &endbodytag()
                   7081: 
                   7082: Returns a uniform footer for LON-CAPA web pages.
                   7083: 
1.635     raeburn  7084: Inputs: 1 - optional reference to an args hash
                   7085: If in the hash, key for noredirectlink has a value which evaluates to true,
                   7086: a 'Continue' link is not displayed if the page contains an
                   7087: internal redirect in the <head></head> section,
                   7088: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 7089: 
                   7090: =cut
                   7091: 
                   7092: sub endbodytag {
1.635     raeburn  7093:     my ($args) = @_;
1.1080    raeburn  7094:     my $endbodytag;
                   7095:     unless ((ref($args) eq 'HASH') && ($args->{'notbody'})) {
                   7096:         $endbodytag='</body>';
                   7097:     }
1.315     albertel 7098:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  7099:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
1.1386    raeburn  7100:             my ($endbodyjs,$idattr);
                   7101:             if ($env{'internal.head.to_opener'}) {
                   7102:                 my $linkid = 'LC_continue_link';
                   7103:                 $idattr = ' id="'.$linkid.'"';
                   7104:                 my $redirect_for_js = &js_escape($env{'internal.head.redirect'});
                   7105:                 $endbodyjs=<<ENDJS;
                   7106: <script type="text/javascript">
                   7107: // <![CDATA[
                   7108: function ebFunction(evt) {
                   7109:     evt.preventDefault();
                   7110:     var dest = '$redirect_for_js';
                   7111:     if (window.opener != null && !window.opener.closed) {
                   7112:         window.opener.location.href=dest;
                   7113:         window.close();
                   7114:     } else {
                   7115:         window.location.href=dest;
                   7116:     }
                   7117:     return false;
                   7118: }
                   7119: 
                   7120: \$(document).ready(function () {
                   7121:   if (document.getElementById('$linkid')) {
                   7122:     var clickelem = document.getElementById('$linkid');
                   7123:     clickelem.addEventListener('click',ebFunction,false);
                   7124:   }
                   7125: });
                   7126: // ]]>
                   7127: </script>
                   7128: ENDJS
                   7129:             }
1.635     raeburn  7130: 	    $endbodytag=
1.1386    raeburn  7131: 	        "$endbodyjs<br /><a href=\"$env{'internal.head.redirect'}\"$idattr>".
1.635     raeburn  7132: 	        &mt('Continue').'</a>'.
                   7133: 	        $endbodytag;
                   7134:         }
1.315     albertel 7135:     }
1.1411    raeburn  7136:     if ((ref($args) eq 'HASH') && ($args->{'dashjs'})) {
                   7137:         $endbodytag = &Apache::lonhtmlcommon::dash_to_minus_js().$endbodytag;
                   7138:     }
1.251     albertel 7139:     return $endbodytag;
                   7140: }
                   7141: 
1.352     albertel 7142: =pod
                   7143: 
                   7144: =item * &standard_css()
                   7145: 
                   7146: Returns a style sheet
                   7147: 
                   7148: Inputs: (all optional)
                   7149:             domain         -> force to color decorate a page for a specific
                   7150:                                domain
                   7151:             function       -> force usage of a specific rolish color scheme
                   7152:             bgcolor        -> override the default page bgcolor
                   7153: 
                   7154: =cut
                   7155: 
1.343     albertel 7156: sub standard_css {
1.345     albertel 7157:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 7158:     $function  = &get_users_function() if (!$function);
                   7159:     my $img    = &designparm($function.'.img',   $domain);
                   7160:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   7161:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 7162:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 7163: #second colour for later usage
1.345     albertel 7164:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 7165:     my $pgbg_or_bgcolor =
                   7166: 	         $bgcolor ||
1.352     albertel 7167: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 7168:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 7169:     my $alink  = &designparm($function.'.alink', $domain);
                   7170:     my $vlink  = &designparm($function.'.vlink', $domain);
                   7171:     my $link   = &designparm($function.'.link',  $domain);
                   7172: 
1.602     albertel 7173:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 7174:     my $mono                 = 'monospace';
1.850     bisitz   7175:     my $data_table_head      = $sidebg;
                   7176:     my $data_table_light     = '#FAFAFA';
1.1060    bisitz   7177:     my $data_table_dark      = '#E0E0E0';
1.470     banghart 7178:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 7179:     my $data_table_highlight = '#FFFF00';
1.352     albertel 7180:     my $mail_new             = '#FFBB77';
                   7181:     my $mail_new_hover       = '#DD9955';
                   7182:     my $mail_read            = '#BBBB77';
                   7183:     my $mail_read_hover      = '#999944';
                   7184:     my $mail_replied         = '#AAAA88';
                   7185:     my $mail_replied_hover   = '#888855';
                   7186:     my $mail_other           = '#99BBBB';
                   7187:     my $mail_other_hover     = '#669999';
1.391     albertel 7188:     my $table_header         = '#DDDDDD';
1.489     raeburn  7189:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   7190:     my $lg_border_color      = '#C8C8C8';
1.952     onken    7191:     my $button_hover         = '#BF2317';
1.392     albertel 7192: 
1.608     albertel 7193:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   7194:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   7195:                                              : '0 3px 0 4px';
1.448     albertel 7196: 
1.523     albertel 7197: 
1.343     albertel 7198:     return <<END;
1.947     droeschl 7199: 
                   7200: /* needed for iframe to allow 100% height in FF */
                   7201: body, html { 
                   7202:     margin: 0;
                   7203:     padding: 0 0.5%;
                   7204:     height: 99%; /* to avoid scrollbars */
                   7205: }
                   7206: 
1.795     www      7207: body {
1.911     bisitz   7208:   font-family: $sans;
                   7209:   line-height:130%;
                   7210:   font-size:0.83em;
                   7211:   color:$font;
1.795     www      7212: }
                   7213: 
1.959     onken    7214: a:focus,
                   7215: a:focus img {
1.795     www      7216:   color: red;
                   7217: }
1.698     harmsja  7218: 
1.911     bisitz   7219: form, .inline {
                   7220:   display: inline;
1.795     www      7221: }
1.721     harmsja  7222: 
1.1421    raeburn  7223: .LC_menus_content.shown{
                   7224:   display: inline;
                   7225: }
                   7226: 
                   7227: .LC_menus_content.hidden {
                   7228:   display: none;
                   7229: }
                   7230: 
1.795     www      7231: .LC_right {
1.911     bisitz   7232:   text-align:right;
1.795     www      7233: }
                   7234: 
                   7235: .LC_middle {
1.911     bisitz   7236:   vertical-align:middle;
1.795     www      7237: }
1.721     harmsja  7238: 
1.1130    raeburn  7239: .LC_floatleft {
                   7240:   float: left;
                   7241: }
                   7242: 
                   7243: .LC_floatright {
                   7244:   float: right;
                   7245: }
                   7246: 
1.911     bisitz   7247: .LC_400Box {
                   7248:   width:400px;
                   7249: }
1.721     harmsja  7250: 
1.1421    raeburn  7251: #LC_collapsible_separator {
                   7252:     border: 1px solid black;
                   7253:     width: 99.9%;
                   7254:     height: 0px;
                   7255: }
                   7256: 
1.947     droeschl 7257: .LC_iframecontainer {
                   7258:     width: 98%;
                   7259:     margin: 0;
                   7260:     position: fixed;
                   7261:     top: 8.5em;
                   7262:     bottom: 0;
                   7263: }
                   7264: 
                   7265: .LC_iframecontainer iframe{
                   7266:     border: none;
                   7267:     width: 100%;
                   7268:     height: 100%;
                   7269: }
                   7270: 
1.778     bisitz   7271: .LC_filename {
                   7272:   font-family: $mono;
                   7273:   white-space:pre;
1.921     bisitz   7274:   font-size: 120%;
1.778     bisitz   7275: }
                   7276: 
                   7277: .LC_fileicon {
                   7278:   border: none;
                   7279:   height: 1.3em;
                   7280:   vertical-align: text-bottom;
                   7281:   margin-right: 0.3em;
                   7282:   text-decoration:none;
                   7283: }
                   7284: 
1.1008    www      7285: .LC_setting {
                   7286:   text-decoration:underline;
                   7287: }
                   7288: 
1.350     albertel 7289: .LC_error {
                   7290:   color: red;
                   7291: }
1.795     www      7292: 
1.1097    bisitz   7293: .LC_warning {
                   7294:   color: darkorange;
                   7295: }
                   7296: 
1.457     albertel 7297: .LC_diff_removed {
1.733     bisitz   7298:   color: red;
1.394     albertel 7299: }
1.532     albertel 7300: 
                   7301: .LC_info,
1.457     albertel 7302: .LC_success,
                   7303: .LC_diff_added {
1.350     albertel 7304:   color: green;
                   7305: }
1.795     www      7306: 
1.802     bisitz   7307: div.LC_confirm_box {
                   7308:   background-color: #FAFAFA;
                   7309:   border: 1px solid $lg_border_color;
                   7310:   margin-right: 0;
                   7311:   padding: 5px;
                   7312: }
                   7313: 
                   7314: div.LC_confirm_box .LC_error img,
                   7315: div.LC_confirm_box .LC_success img {
                   7316:   vertical-align: middle;
                   7317: }
                   7318: 
1.1242    raeburn  7319: .LC_maxwidth {
                   7320:   max-width: 100%;
                   7321:   height: auto;
                   7322: }
                   7323: 
1.1243    raeburn  7324: .LC_textsize_mobile {
                   7325:   \@media only screen and (max-device-width: 480px) {
                   7326:       -webkit-text-size-adjust:100%; -moz-text-size-adjust:100%; -ms-text-size-adjust:100%;
                   7327:   }
                   7328: }
                   7329: 
1.440     albertel 7330: .LC_icon {
1.771     droeschl 7331:   border: none;
1.790     droeschl 7332:   vertical-align: middle;
1.771     droeschl 7333: }
                   7334: 
1.543     albertel 7335: .LC_docs_spacer {
                   7336:   width: 25px;
                   7337:   height: 1px;
1.771     droeschl 7338:   border: none;
1.543     albertel 7339: }
1.346     albertel 7340: 
1.532     albertel 7341: .LC_internal_info {
1.735     bisitz   7342:   color: #999999;
1.532     albertel 7343: }
                   7344: 
1.794     www      7345: .LC_discussion {
1.1050    www      7346:   background: $data_table_dark;
1.911     bisitz   7347:   border: 1px solid black;
                   7348:   margin: 2px;
1.794     www      7349: }
                   7350: 
                   7351: .LC_disc_action_left {
1.1050    www      7352:   background: $sidebg;
1.911     bisitz   7353:   text-align: left;
1.1050    www      7354:   padding: 4px;
                   7355:   margin: 2px;
1.794     www      7356: }
                   7357: 
                   7358: .LC_disc_action_right {
1.1050    www      7359:   background: $sidebg;
1.911     bisitz   7360:   text-align: right;
1.1050    www      7361:   padding: 4px;
                   7362:   margin: 2px;
1.794     www      7363: }
                   7364: 
                   7365: .LC_disc_new_item {
1.911     bisitz   7366:   background: white;
                   7367:   border: 2px solid red;
1.1050    www      7368:   margin: 4px;
                   7369:   padding: 4px;
1.794     www      7370: }
                   7371: 
                   7372: .LC_disc_old_item {
1.911     bisitz   7373:   background: white;
1.1050    www      7374:   margin: 4px;
                   7375:   padding: 4px;
1.794     www      7376: }
                   7377: 
1.458     albertel 7378: table.LC_pastsubmission {
                   7379:   border: 1px solid black;
                   7380:   margin: 2px;
                   7381: }
                   7382: 
1.924     bisitz   7383: table#LC_menubuttons {
1.345     albertel 7384:   width: 100%;
                   7385:   background: $pgbg;
1.392     albertel 7386:   border: 2px;
1.402     albertel 7387:   border-collapse: separate;
1.803     bisitz   7388:   padding: 0;
1.345     albertel 7389: }
1.392     albertel 7390: 
1.801     tempelho 7391: table#LC_title_bar a {
                   7392:   color: $fontmenu;
                   7393: }
1.836     bisitz   7394: 
1.807     droeschl 7395: table#LC_title_bar {
1.819     tempelho 7396:   clear: both;
1.836     bisitz   7397:   display: none;
1.807     droeschl 7398: }
                   7399: 
1.795     www      7400: table#LC_title_bar,
1.933     droeschl 7401: table.LC_breadcrumbs, /* obsolete? */
1.393     albertel 7402: table#LC_title_bar.LC_with_remote {
1.359     albertel 7403:   width: 100%;
1.392     albertel 7404:   border-color: $pgbg;
                   7405:   border-style: solid;
                   7406:   border-width: $border;
1.379     albertel 7407:   background: $pgbg;
1.801     tempelho 7408:   color: $fontmenu;
1.392     albertel 7409:   border-collapse: collapse;
1.803     bisitz   7410:   padding: 0;
1.819     tempelho 7411:   margin: 0;
1.359     albertel 7412: }
1.795     www      7413: 
1.933     droeschl 7414: ul.LC_breadcrumb_tools_outerlist {
1.913     droeschl 7415:     margin: 0;
                   7416:     padding: 0;
1.933     droeschl 7417:     position: relative;
                   7418:     list-style: none;
1.913     droeschl 7419: }
1.933     droeschl 7420: ul.LC_breadcrumb_tools_outerlist li {
1.913     droeschl 7421:     display: inline;
                   7422: }
1.933     droeschl 7423: 
                   7424: .LC_breadcrumb_tools_navigation {
1.913     droeschl 7425:     padding: 0;
1.933     droeschl 7426:     margin: 0;
                   7427:     float: left;
1.913     droeschl 7428: }
1.933     droeschl 7429: .LC_breadcrumb_tools_tools {
                   7430:     padding: 0;
                   7431:     margin: 0;
1.913     droeschl 7432:     float: right;
                   7433: }
                   7434: 
1.1240    raeburn  7435: .LC_placement_prog {
                   7436:     padding-right: 20px;
                   7437:     font-weight: bold;
                   7438:     font-size: 90%;
                   7439: }
                   7440: 
1.359     albertel 7441: table#LC_title_bar td {
                   7442:   background: $tabbg;
                   7443: }
1.795     www      7444: 
1.911     bisitz   7445: table#LC_menubuttons img {
1.803     bisitz   7446:   border: none;
1.346     albertel 7447: }
1.795     www      7448: 
1.842     droeschl 7449: .LC_breadcrumbs_component {
1.911     bisitz   7450:   float: right;
                   7451:   margin: 0 1em;
1.357     albertel 7452: }
1.842     droeschl 7453: .LC_breadcrumbs_component img {
1.911     bisitz   7454:   vertical-align: middle;
1.777     tempelho 7455: }
1.795     www      7456: 
1.1243    raeburn  7457: .LC_breadcrumbs_hoverable {
                   7458:   background: $sidebg;
                   7459: }
                   7460: 
1.383     albertel 7461: td.LC_table_cell_checkbox {
                   7462:   text-align: center;
                   7463: }
1.795     www      7464: 
                   7465: .LC_fontsize_small {
1.911     bisitz   7466:   font-size: 70%;
1.705     tempelho 7467: }
                   7468: 
1.844     bisitz   7469: #LC_breadcrumbs {
1.911     bisitz   7470:   clear:both;
                   7471:   background: $sidebg;
                   7472:   border-bottom: 1px solid $lg_border_color;
                   7473:   line-height: 2.5em;
1.933     droeschl 7474:   overflow: hidden;
1.911     bisitz   7475:   margin: 0;
                   7476:   padding: 0;
1.995     raeburn  7477:   text-align: left;
1.819     tempelho 7478: }
1.862     bisitz   7479: 
1.1098    bisitz   7480: .LC_head_subbox, .LC_actionbox {
1.911     bisitz   7481:   clear:both;
                   7482:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 7483:   border: 1px solid $sidebg;
1.1098    bisitz   7484:   margin: 0 0 10px 0;
1.966     bisitz   7485:   padding: 3px;
1.995     raeburn  7486:   text-align: left;
1.822     bisitz   7487: }
                   7488: 
1.795     www      7489: .LC_fontsize_medium {
1.911     bisitz   7490:   font-size: 85%;
1.705     tempelho 7491: }
                   7492: 
1.795     www      7493: .LC_fontsize_large {
1.911     bisitz   7494:   font-size: 120%;
1.705     tempelho 7495: }
                   7496: 
1.346     albertel 7497: .LC_menubuttons_inline_text {
                   7498:   color: $font;
1.698     harmsja  7499:   font-size: 90%;
1.701     harmsja  7500:   padding-left:3px;
1.346     albertel 7501: }
                   7502: 
1.934     droeschl 7503: .LC_menubuttons_inline_text img{
                   7504:   vertical-align: middle;
                   7505: }
                   7506: 
1.1051    www      7507: li.LC_menubuttons_inline_text img {
1.951     onken    7508:   cursor:pointer;
1.1002    droeschl 7509:   text-decoration: none;
1.951     onken    7510: }
                   7511: 
1.526     www      7512: .LC_menubuttons_link {
                   7513:   text-decoration: none;
                   7514: }
1.795     www      7515: 
1.522     albertel 7516: .LC_menubuttons_category {
1.521     www      7517:   color: $font;
1.526     www      7518:   background: $pgbg;
1.521     www      7519:   font-size: larger;
                   7520:   font-weight: bold;
                   7521: }
                   7522: 
1.346     albertel 7523: td.LC_menubuttons_text {
1.911     bisitz   7524:   color: $font;
1.346     albertel 7525: }
1.706     harmsja  7526: 
1.346     albertel 7527: .LC_current_location {
                   7528:   background: $tabbg;
                   7529: }
1.795     www      7530: 
1.1286    raeburn  7531: td.LC_zero_height {
                   7532:   line-height: 0; 
                   7533:   cellpadding: 0;
                   7534: }
                   7535: 
1.938     bisitz   7536: table.LC_data_table {
1.347     albertel 7537:   border: 1px solid #000000;
1.402     albertel 7538:   border-collapse: separate;
1.426     albertel 7539:   border-spacing: 1px;
1.610     albertel 7540:   background: $pgbg;
1.347     albertel 7541: }
1.795     www      7542: 
1.422     albertel 7543: .LC_data_table_dense {
                   7544:   font-size: small;
                   7545: }
1.795     www      7546: 
1.507     raeburn  7547: table.LC_nested_outer {
                   7548:   border: 1px solid #000000;
1.589     raeburn  7549:   border-collapse: collapse;
1.803     bisitz   7550:   border-spacing: 0;
1.507     raeburn  7551:   width: 100%;
                   7552: }
1.795     www      7553: 
1.879     raeburn  7554: table.LC_innerpickbox,
1.507     raeburn  7555: table.LC_nested {
1.803     bisitz   7556:   border: none;
1.589     raeburn  7557:   border-collapse: collapse;
1.803     bisitz   7558:   border-spacing: 0;
1.507     raeburn  7559:   width: 100%;
                   7560: }
1.795     www      7561: 
1.911     bisitz   7562: table.LC_data_table tr th,
                   7563: table.LC_calendar tr th,
1.879     raeburn  7564: table.LC_prior_tries tr th,
                   7565: table.LC_innerpickbox tr th {
1.349     albertel 7566:   font-weight: bold;
                   7567:   background-color: $data_table_head;
1.801     tempelho 7568:   color:$fontmenu;
1.701     harmsja  7569:   font-size:90%;
1.347     albertel 7570: }
1.795     www      7571: 
1.879     raeburn  7572: table.LC_innerpickbox tr th,
                   7573: table.LC_innerpickbox tr td {
                   7574:   vertical-align: top;
                   7575: }
                   7576: 
1.711     raeburn  7577: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   7578:   background-color: #CCCCCC;
1.711     raeburn  7579:   font-weight: bold;
                   7580:   text-align: left;
                   7581: }
1.795     www      7582: 
1.912     bisitz   7583: table.LC_data_table tr.LC_odd_row > td {
                   7584:   background-color: $data_table_light;
                   7585:   padding: 2px;
                   7586:   vertical-align: top;
                   7587: }
                   7588: 
1.809     bisitz   7589: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 7590:   background-color: $data_table_light;
1.912     bisitz   7591:   vertical-align: top;
                   7592: }
                   7593: 
                   7594: table.LC_data_table tr.LC_even_row > td {
                   7595:   background-color: $data_table_dark;
1.425     albertel 7596:   padding: 2px;
1.900     bisitz   7597:   vertical-align: top;
1.347     albertel 7598: }
1.795     www      7599: 
1.809     bisitz   7600: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 7601:   background-color: $data_table_dark;
1.900     bisitz   7602:   vertical-align: top;
1.347     albertel 7603: }
1.795     www      7604: 
1.425     albertel 7605: table.LC_data_table tr.LC_data_table_highlight td {
                   7606:   background-color: $data_table_darker;
                   7607: }
1.795     www      7608: 
1.639     raeburn  7609: table.LC_data_table tr td.LC_leftcol_header {
                   7610:   background-color: $data_table_head;
                   7611:   font-weight: bold;
                   7612: }
1.795     www      7613: 
1.451     albertel 7614: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  7615: table.LC_nested tr.LC_empty_row td {
1.421     albertel 7616:   font-weight: bold;
                   7617:   font-style: italic;
                   7618:   text-align: center;
                   7619:   padding: 8px;
1.347     albertel 7620: }
1.795     www      7621: 
1.1114    raeburn  7622: table.LC_data_table tr.LC_empty_row td,
                   7623: table.LC_data_table tr.LC_footer_row td {
1.940     bisitz   7624:   background-color: $sidebg;
                   7625: }
                   7626: 
                   7627: table.LC_nested tr.LC_empty_row td {
                   7628:   background-color: #FFFFFF;
                   7629: }
                   7630: 
1.890     droeschl 7631: table.LC_caption {
                   7632: }
                   7633: 
1.507     raeburn  7634: table.LC_nested tr.LC_empty_row td {
1.465     albertel 7635:   padding: 4ex
                   7636: }
1.795     www      7637: 
1.507     raeburn  7638: table.LC_nested_outer tr th {
                   7639:   font-weight: bold;
1.801     tempelho 7640:   color:$fontmenu;
1.507     raeburn  7641:   background-color: $data_table_head;
1.701     harmsja  7642:   font-size: small;
1.507     raeburn  7643:   border-bottom: 1px solid #000000;
                   7644: }
1.795     www      7645: 
1.507     raeburn  7646: table.LC_nested_outer tr td.LC_subheader {
                   7647:   background-color: $data_table_head;
                   7648:   font-weight: bold;
                   7649:   font-size: small;
                   7650:   border-bottom: 1px solid #000000;
                   7651:   text-align: right;
1.451     albertel 7652: }
1.795     www      7653: 
1.507     raeburn  7654: table.LC_nested tr.LC_info_row td {
1.735     bisitz   7655:   background-color: #CCCCCC;
1.451     albertel 7656:   font-weight: bold;
                   7657:   font-size: small;
1.507     raeburn  7658:   text-align: center;
                   7659: }
1.795     www      7660: 
1.589     raeburn  7661: table.LC_nested tr.LC_info_row td.LC_left_item,
                   7662: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  7663:   text-align: left;
1.451     albertel 7664: }
1.795     www      7665: 
1.507     raeburn  7666: table.LC_nested td {
1.735     bisitz   7667:   background-color: #FFFFFF;
1.451     albertel 7668:   font-size: small;
1.507     raeburn  7669: }
1.795     www      7670: 
1.507     raeburn  7671: table.LC_nested_outer tr th.LC_right_item,
                   7672: table.LC_nested tr.LC_info_row td.LC_right_item,
                   7673: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   7674: table.LC_nested tr td.LC_right_item {
1.451     albertel 7675:   text-align: right;
                   7676: }
                   7677: 
1.507     raeburn  7678: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   7679:   background-color: #EEEEEE;
1.451     albertel 7680: }
                   7681: 
1.473     raeburn  7682: table.LC_createuser {
                   7683: }
                   7684: 
                   7685: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  7686:   font-size: small;
1.473     raeburn  7687: }
                   7688: 
                   7689: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   7690:   background-color: #CCCCCC;
1.473     raeburn  7691:   font-weight: bold;
                   7692:   text-align: center;
                   7693: }
                   7694: 
1.349     albertel 7695: table.LC_calendar {
                   7696:   border: 1px solid #000000;
                   7697:   border-collapse: collapse;
1.917     raeburn  7698:   width: 98%;
1.349     albertel 7699: }
1.795     www      7700: 
1.349     albertel 7701: table.LC_calendar_pickdate {
                   7702:   font-size: xx-small;
                   7703: }
1.795     www      7704: 
1.349     albertel 7705: table.LC_calendar tr td {
                   7706:   border: 1px solid #000000;
                   7707:   vertical-align: top;
1.917     raeburn  7708:   width: 14%;
1.349     albertel 7709: }
1.795     www      7710: 
1.349     albertel 7711: table.LC_calendar tr td.LC_calendar_day_empty {
                   7712:   background-color: $data_table_dark;
                   7713: }
1.795     www      7714: 
1.779     bisitz   7715: table.LC_calendar tr td.LC_calendar_day_current {
                   7716:   background-color: $data_table_highlight;
1.777     tempelho 7717: }
1.795     www      7718: 
1.938     bisitz   7719: table.LC_data_table tr td.LC_mail_new {
1.349     albertel 7720:   background-color: $mail_new;
                   7721: }
1.795     www      7722: 
1.938     bisitz   7723: table.LC_data_table tr.LC_mail_new:hover {
1.349     albertel 7724:   background-color: $mail_new_hover;
                   7725: }
1.795     www      7726: 
1.938     bisitz   7727: table.LC_data_table tr td.LC_mail_read {
1.349     albertel 7728:   background-color: $mail_read;
                   7729: }
1.795     www      7730: 
1.938     bisitz   7731: /*
                   7732: table.LC_data_table tr.LC_mail_read:hover {
1.349     albertel 7733:   background-color: $mail_read_hover;
                   7734: }
1.938     bisitz   7735: */
1.795     www      7736: 
1.938     bisitz   7737: table.LC_data_table tr td.LC_mail_replied {
1.349     albertel 7738:   background-color: $mail_replied;
                   7739: }
1.795     www      7740: 
1.938     bisitz   7741: /*
                   7742: table.LC_data_table tr.LC_mail_replied:hover {
1.349     albertel 7743:   background-color: $mail_replied_hover;
                   7744: }
1.938     bisitz   7745: */
1.795     www      7746: 
1.938     bisitz   7747: table.LC_data_table tr td.LC_mail_other {
1.349     albertel 7748:   background-color: $mail_other;
                   7749: }
1.795     www      7750: 
1.938     bisitz   7751: /*
                   7752: table.LC_data_table tr.LC_mail_other:hover {
1.349     albertel 7753:   background-color: $mail_other_hover;
                   7754: }
1.938     bisitz   7755: */
1.494     raeburn  7756: 
1.777     tempelho 7757: table.LC_data_table tr > td.LC_browser_file,
                   7758: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   7759:   background: #AAEE77;
1.389     albertel 7760: }
1.795     www      7761: 
1.777     tempelho 7762: table.LC_data_table tr > td.LC_browser_file_locked,
                   7763: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 7764:   background: #FFAA99;
1.387     albertel 7765: }
1.795     www      7766: 
1.777     tempelho 7767: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   7768:   background: #888888;
1.779     bisitz   7769: }
1.795     www      7770: 
1.777     tempelho 7771: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   7772: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   7773:   background: #F8F866;
1.777     tempelho 7774: }
1.795     www      7775: 
1.696     bisitz   7776: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   7777:   background: #E0E8FF;
1.387     albertel 7778: }
1.696     bisitz   7779: 
1.707     bisitz   7780: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   7781:   /* background: #77FF77; */
1.707     bisitz   7782: }
1.795     www      7783: 
1.707     bisitz   7784: table.LC_data_table tr > td.LC_roles_future {
1.939     bisitz   7785:   border-right: 8px solid #FFFF77;
1.707     bisitz   7786: }
1.795     www      7787: 
1.707     bisitz   7788: table.LC_data_table tr > td.LC_roles_will {
1.939     bisitz   7789:   border-right: 8px solid #FFAA77;
1.707     bisitz   7790: }
1.795     www      7791: 
1.707     bisitz   7792: table.LC_data_table tr > td.LC_roles_expired {
1.939     bisitz   7793:   border-right: 8px solid #FF7777;
1.707     bisitz   7794: }
1.795     www      7795: 
1.707     bisitz   7796: table.LC_data_table tr > td.LC_roles_will_not {
1.939     bisitz   7797:   border-right: 8px solid #AAFF77;
1.707     bisitz   7798: }
1.795     www      7799: 
1.707     bisitz   7800: table.LC_data_table tr > td.LC_roles_selected {
1.939     bisitz   7801:   border-right: 8px solid #11CC55;
1.707     bisitz   7802: }
                   7803: 
1.388     albertel 7804: span.LC_current_location {
1.701     harmsja  7805:   font-size:larger;
1.388     albertel 7806:   background: $pgbg;
                   7807: }
1.387     albertel 7808: 
1.1029    www      7809: span.LC_current_nav_location {
                   7810:   font-weight:bold;
                   7811:   background: $sidebg;
                   7812: }
                   7813: 
1.395     albertel 7814: span.LC_parm_menu_item {
                   7815:   font-size: larger;
                   7816: }
1.795     www      7817: 
1.395     albertel 7818: span.LC_parm_scope_all {
                   7819:   color: red;
                   7820: }
1.795     www      7821: 
1.395     albertel 7822: span.LC_parm_scope_folder {
                   7823:   color: green;
                   7824: }
1.795     www      7825: 
1.395     albertel 7826: span.LC_parm_scope_resource {
                   7827:   color: orange;
                   7828: }
1.795     www      7829: 
1.395     albertel 7830: span.LC_parm_part {
                   7831:   color: blue;
                   7832: }
1.795     www      7833: 
1.911     bisitz   7834: span.LC_parm_folder,
                   7835: span.LC_parm_symb {
1.395     albertel 7836:   font-size: x-small;
                   7837:   font-family: $mono;
                   7838:   color: #AAAAAA;
                   7839: }
                   7840: 
1.977     bisitz   7841: ul.LC_parm_parmlist li {
                   7842:   display: inline-block;
                   7843:   padding: 0.3em 0.8em;
                   7844:   vertical-align: top;
                   7845:   width: 150px;
                   7846:   border-top:1px solid $lg_border_color;
                   7847: }
                   7848: 
1.795     www      7849: td.LC_parm_overview_level_menu,
                   7850: td.LC_parm_overview_map_menu,
                   7851: td.LC_parm_overview_parm_selectors,
                   7852: td.LC_parm_overview_restrictions  {
1.396     albertel 7853:   border: 1px solid black;
                   7854:   border-collapse: collapse;
                   7855: }
1.795     www      7856: 
1.1285    raeburn  7857: span.LC_parm_recursive,
                   7858: td.LC_parm_recursive {
                   7859:   font-weight: bold;
                   7860:   font-size: smaller;
                   7861: }
                   7862: 
1.396     albertel 7863: table.LC_parm_overview_restrictions td {
                   7864:   border-width: 1px 4px 1px 4px;
                   7865:   border-style: solid;
                   7866:   border-color: $pgbg;
                   7867:   text-align: center;
                   7868: }
1.795     www      7869: 
1.396     albertel 7870: table.LC_parm_overview_restrictions th {
                   7871:   background: $tabbg;
                   7872:   border-width: 1px 4px 1px 4px;
                   7873:   border-style: solid;
                   7874:   border-color: $pgbg;
                   7875: }
1.795     www      7876: 
1.398     albertel 7877: table#LC_helpmenu {
1.803     bisitz   7878:   border: none;
1.398     albertel 7879:   height: 55px;
1.803     bisitz   7880:   border-spacing: 0;
1.398     albertel 7881: }
                   7882: 
                   7883: table#LC_helpmenu fieldset legend {
                   7884:   font-size: larger;
                   7885: }
1.795     www      7886: 
1.397     albertel 7887: table#LC_helpmenu_links {
                   7888:   width: 100%;
                   7889:   border: 1px solid black;
                   7890:   background: $pgbg;
1.803     bisitz   7891:   padding: 0;
1.397     albertel 7892:   border-spacing: 1px;
                   7893: }
1.795     www      7894: 
1.397     albertel 7895: table#LC_helpmenu_links tr td {
                   7896:   padding: 1px;
                   7897:   background: $tabbg;
1.399     albertel 7898:   text-align: center;
                   7899:   font-weight: bold;
1.397     albertel 7900: }
1.396     albertel 7901: 
1.795     www      7902: table#LC_helpmenu_links a:link,
                   7903: table#LC_helpmenu_links a:visited,
1.397     albertel 7904: table#LC_helpmenu_links a:active {
                   7905:   text-decoration: none;
                   7906:   color: $font;
                   7907: }
1.795     www      7908: 
1.397     albertel 7909: table#LC_helpmenu_links a:hover {
                   7910:   text-decoration: underline;
                   7911:   color: $vlink;
                   7912: }
1.396     albertel 7913: 
1.417     albertel 7914: .LC_chrt_popup_exists {
                   7915:   border: 1px solid #339933;
                   7916:   margin: -1px;
                   7917: }
1.795     www      7918: 
1.417     albertel 7919: .LC_chrt_popup_up {
                   7920:   border: 1px solid yellow;
                   7921:   margin: -1px;
                   7922: }
1.795     www      7923: 
1.417     albertel 7924: .LC_chrt_popup {
                   7925:   border: 1px solid #8888FF;
                   7926:   background: #CCCCFF;
                   7927: }
1.795     www      7928: 
1.421     albertel 7929: table.LC_pick_box {
                   7930:   border-collapse: separate;
                   7931:   background: white;
                   7932:   border: 1px solid black;
                   7933:   border-spacing: 1px;
                   7934: }
1.795     www      7935: 
1.421     albertel 7936: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   7937:   background: $sidebg;
1.421     albertel 7938:   font-weight: bold;
1.900     bisitz   7939:   text-align: left;
1.740     bisitz   7940:   vertical-align: top;
1.421     albertel 7941:   width: 184px;
                   7942:   padding: 8px;
                   7943: }
1.795     www      7944: 
1.579     raeburn  7945: table.LC_pick_box td.LC_pick_box_value {
                   7946:   text-align: left;
                   7947:   padding: 8px;
                   7948: }
1.795     www      7949: 
1.579     raeburn  7950: table.LC_pick_box td.LC_pick_box_select {
                   7951:   text-align: left;
                   7952:   padding: 8px;
                   7953: }
1.795     www      7954: 
1.424     albertel 7955: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   7956:   padding: 0;
1.421     albertel 7957:   height: 1px;
                   7958:   background: black;
                   7959: }
1.795     www      7960: 
1.421     albertel 7961: table.LC_pick_box td.LC_pick_box_submit {
                   7962:   text-align: right;
                   7963: }
1.795     www      7964: 
1.579     raeburn  7965: table.LC_pick_box td.LC_evenrow_value {
                   7966:   text-align: left;
                   7967:   padding: 8px;
                   7968:   background-color: $data_table_light;
                   7969: }
1.795     www      7970: 
1.579     raeburn  7971: table.LC_pick_box td.LC_oddrow_value {
                   7972:   text-align: left;
                   7973:   padding: 8px;
                   7974:   background-color: $data_table_light;
                   7975: }
1.795     www      7976: 
1.579     raeburn  7977: span.LC_helpform_receipt_cat {
                   7978:   font-weight: bold;
                   7979: }
1.795     www      7980: 
1.424     albertel 7981: table.LC_group_priv_box {
                   7982:   background: white;
                   7983:   border: 1px solid black;
                   7984:   border-spacing: 1px;
                   7985: }
1.795     www      7986: 
1.424     albertel 7987: table.LC_group_priv_box td.LC_pick_box_title {
                   7988:   background: $tabbg;
                   7989:   font-weight: bold;
                   7990:   text-align: right;
                   7991:   width: 184px;
                   7992: }
1.795     www      7993: 
1.424     albertel 7994: table.LC_group_priv_box td.LC_groups_fixed {
                   7995:   background: $data_table_light;
                   7996:   text-align: center;
                   7997: }
1.795     www      7998: 
1.424     albertel 7999: table.LC_group_priv_box td.LC_groups_optional {
                   8000:   background: $data_table_dark;
                   8001:   text-align: center;
                   8002: }
1.795     www      8003: 
1.424     albertel 8004: table.LC_group_priv_box td.LC_groups_functionality {
                   8005:   background: $data_table_darker;
                   8006:   text-align: center;
                   8007:   font-weight: bold;
                   8008: }
1.795     www      8009: 
1.424     albertel 8010: table.LC_group_priv td {
                   8011:   text-align: left;
1.803     bisitz   8012:   padding: 0;
1.424     albertel 8013: }
                   8014: 
                   8015: .LC_navbuttons {
                   8016:   margin: 2ex 0ex 2ex 0ex;
                   8017: }
1.795     www      8018: 
1.423     albertel 8019: .LC_topic_bar {
                   8020:   font-weight: bold;
                   8021:   background: $tabbg;
1.918     wenzelju 8022:   margin: 1em 0em 1em 2em;
1.805     bisitz   8023:   padding: 3px;
1.918     wenzelju 8024:   font-size: 1.2em;
1.423     albertel 8025: }
1.795     www      8026: 
1.423     albertel 8027: .LC_topic_bar span {
1.918     wenzelju 8028:   left: 0.5em;
                   8029:   position: absolute;
1.423     albertel 8030:   vertical-align: middle;
1.918     wenzelju 8031:   font-size: 1.2em;
1.423     albertel 8032: }
1.795     www      8033: 
1.423     albertel 8034: table.LC_course_group_status {
                   8035:   margin: 20px;
                   8036: }
1.795     www      8037: 
1.423     albertel 8038: table.LC_status_selector td {
                   8039:   vertical-align: top;
                   8040:   text-align: center;
1.424     albertel 8041:   padding: 4px;
                   8042: }
1.795     www      8043: 
1.599     albertel 8044: div.LC_feedback_link {
1.616     albertel 8045:   clear: both;
1.829     kalberla 8046:   background: $sidebg;
1.779     bisitz   8047:   width: 100%;
1.829     kalberla 8048:   padding-bottom: 10px;
                   8049:   border: 1px $tabbg solid;
1.833     kalberla 8050:   height: 22px;
                   8051:   line-height: 22px;
                   8052:   padding-top: 5px;
                   8053: }
                   8054: 
                   8055: div.LC_feedback_link img {
                   8056:   height: 22px;
1.867     kalberla 8057:   vertical-align:middle;
1.829     kalberla 8058: }
                   8059: 
1.911     bisitz   8060: div.LC_feedback_link a {
1.829     kalberla 8061:   text-decoration: none;
1.489     raeburn  8062: }
1.795     www      8063: 
1.867     kalberla 8064: div.LC_comblock {
1.911     bisitz   8065:   display:inline;
1.867     kalberla 8066:   color:$font;
                   8067:   font-size:90%;
                   8068: }
                   8069: 
                   8070: div.LC_feedback_link div.LC_comblock {
                   8071:   padding-left:5px;
                   8072: }
                   8073: 
                   8074: div.LC_feedback_link div.LC_comblock a {
                   8075:   color:$font;
                   8076: }
                   8077: 
1.489     raeburn  8078: span.LC_feedback_link {
1.858     bisitz   8079:   /* background: $feedback_link_bg; */
1.599     albertel 8080:   font-size: larger;
                   8081: }
1.795     www      8082: 
1.599     albertel 8083: span.LC_message_link {
1.858     bisitz   8084:   /* background: $feedback_link_bg; */
1.599     albertel 8085:   font-size: larger;
                   8086:   position: absolute;
                   8087:   right: 1em;
1.489     raeburn  8088: }
1.421     albertel 8089: 
1.515     albertel 8090: table.LC_prior_tries {
1.524     albertel 8091:   border: 1px solid #000000;
                   8092:   border-collapse: separate;
                   8093:   border-spacing: 1px;
1.515     albertel 8094: }
1.523     albertel 8095: 
1.515     albertel 8096: table.LC_prior_tries td {
1.524     albertel 8097:   padding: 2px;
1.515     albertel 8098: }
1.523     albertel 8099: 
                   8100: .LC_answer_correct {
1.795     www      8101:   background: lightgreen;
                   8102:   color: darkgreen;
                   8103:   padding: 6px;
1.523     albertel 8104: }
1.795     www      8105: 
1.523     albertel 8106: .LC_answer_charged_try {
1.797     www      8107:   background: #FFAAAA;
1.795     www      8108:   color: darkred;
                   8109:   padding: 6px;
1.523     albertel 8110: }
1.795     www      8111: 
1.779     bisitz   8112: .LC_answer_not_charged_try,
1.523     albertel 8113: .LC_answer_no_grade,
                   8114: .LC_answer_late {
1.795     www      8115:   background: lightyellow;
1.523     albertel 8116:   color: black;
1.795     www      8117:   padding: 6px;
1.523     albertel 8118: }
1.795     www      8119: 
1.523     albertel 8120: .LC_answer_previous {
1.795     www      8121:   background: lightblue;
                   8122:   color: darkblue;
                   8123:   padding: 6px;
1.523     albertel 8124: }
1.795     www      8125: 
1.779     bisitz   8126: .LC_answer_no_message {
1.777     tempelho 8127:   background: #FFFFFF;
                   8128:   color: black;
1.795     www      8129:   padding: 6px;
1.779     bisitz   8130: }
1.795     www      8131: 
1.1334    raeburn  8132: .LC_answer_unknown,
                   8133: .LC_answer_warning {
1.779     bisitz   8134:   background: orange;
                   8135:   color: black;
1.795     www      8136:   padding: 6px;
1.777     tempelho 8137: }
1.795     www      8138: 
1.529     albertel 8139: span.LC_prior_numerical,
                   8140: span.LC_prior_string,
                   8141: span.LC_prior_custom,
                   8142: span.LC_prior_reaction,
                   8143: span.LC_prior_math {
1.925     bisitz   8144:   font-family: $mono;
1.523     albertel 8145:   white-space: pre;
                   8146: }
                   8147: 
1.525     albertel 8148: span.LC_prior_string {
1.925     bisitz   8149:   font-family: $mono;
1.525     albertel 8150:   white-space: pre;
                   8151: }
                   8152: 
1.523     albertel 8153: table.LC_prior_option {
                   8154:   width: 100%;
                   8155:   border-collapse: collapse;
                   8156: }
1.795     www      8157: 
1.911     bisitz   8158: table.LC_prior_rank,
1.795     www      8159: table.LC_prior_match {
1.528     albertel 8160:   border-collapse: collapse;
                   8161: }
1.795     www      8162: 
1.528     albertel 8163: table.LC_prior_option tr td,
                   8164: table.LC_prior_rank tr td,
                   8165: table.LC_prior_match tr td {
1.524     albertel 8166:   border: 1px solid #000000;
1.515     albertel 8167: }
                   8168: 
1.855     bisitz   8169: .LC_nobreak {
1.544     albertel 8170:   white-space: nowrap;
1.519     raeburn  8171: }
                   8172: 
1.576     raeburn  8173: span.LC_cusr_emph {
                   8174:   font-style: italic;
                   8175: }
                   8176: 
1.633     raeburn  8177: span.LC_cusr_subheading {
                   8178:   font-weight: normal;
                   8179:   font-size: 85%;
                   8180: }
                   8181: 
1.861     bisitz   8182: div.LC_docs_entry_move {
1.859     bisitz   8183:   border: 1px solid #BBBBBB;
1.545     albertel 8184:   background: #DDDDDD;
1.861     bisitz   8185:   width: 22px;
1.859     bisitz   8186:   padding: 1px;
                   8187:   margin: 0;
1.545     albertel 8188: }
                   8189: 
1.861     bisitz   8190: table.LC_data_table tr > td.LC_docs_entry_commands,
                   8191: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 8192:   font-size: x-small;
                   8193: }
1.795     www      8194: 
1.861     bisitz   8195: .LC_docs_entry_parameter {
                   8196:   white-space: nowrap;
                   8197: }
                   8198: 
1.544     albertel 8199: .LC_docs_copy {
1.545     albertel 8200:   color: #000099;
1.544     albertel 8201: }
1.795     www      8202: 
1.544     albertel 8203: .LC_docs_cut {
1.545     albertel 8204:   color: #550044;
1.544     albertel 8205: }
1.795     www      8206: 
1.544     albertel 8207: .LC_docs_rename {
1.545     albertel 8208:   color: #009900;
1.544     albertel 8209: }
1.795     www      8210: 
1.544     albertel 8211: .LC_docs_remove {
1.545     albertel 8212:   color: #990000;
                   8213: }
                   8214: 
1.1284    raeburn  8215: .LC_docs_alias {
                   8216:   color: #440055;  
                   8217: }
                   8218: 
1.1286    raeburn  8219: .LC_domprefs_email,
1.1284    raeburn  8220: .LC_docs_alias_name,
1.547     albertel 8221: .LC_docs_reinit_warn,
                   8222: .LC_docs_ext_edit {
                   8223:   font-size: x-small;
                   8224: }
                   8225: 
1.545     albertel 8226: table.LC_docs_adddocs td,
                   8227: table.LC_docs_adddocs th {
                   8228:   border: 1px solid #BBBBBB;
                   8229:   padding: 4px;
                   8230:   background: #DDDDDD;
1.543     albertel 8231: }
                   8232: 
1.584     albertel 8233: table.LC_sty_begin {
                   8234:   background: #BBFFBB;
                   8235: }
1.795     www      8236: 
1.584     albertel 8237: table.LC_sty_end {
                   8238:   background: #FFBBBB;
                   8239: }
                   8240: 
1.589     raeburn  8241: table.LC_double_column {
1.803     bisitz   8242:   border-width: 0;
1.589     raeburn  8243:   border-collapse: collapse;
                   8244:   width: 100%;
                   8245:   padding: 2px;
                   8246: }
                   8247: 
                   8248: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  8249:   top: 2px;
1.589     raeburn  8250:   left: 2px;
                   8251:   width: 47%;
                   8252:   vertical-align: top;
                   8253: }
                   8254: 
                   8255: table.LC_double_column tr td.LC_right_col {
                   8256:   top: 2px;
1.779     bisitz   8257:   right: 2px;
1.589     raeburn  8258:   width: 47%;
                   8259:   vertical-align: top;
                   8260: }
                   8261: 
1.591     raeburn  8262: div.LC_left_float {
                   8263:   float: left;
                   8264:   padding-right: 5%;
1.597     albertel 8265:   padding-bottom: 4px;
1.591     raeburn  8266: }
                   8267: 
                   8268: div.LC_clear_float_header {
1.597     albertel 8269:   padding-bottom: 2px;
1.591     raeburn  8270: }
                   8271: 
                   8272: div.LC_clear_float_footer {
1.597     albertel 8273:   padding-top: 10px;
1.591     raeburn  8274:   clear: both;
                   8275: }
                   8276: 
1.597     albertel 8277: div.LC_grade_show_user {
1.941     bisitz   8278: /*  border-left: 5px solid $sidebg; */
                   8279:   border-top: 5px solid #000000;
                   8280:   margin: 50px 0 0 0;
1.936     bisitz   8281:   padding: 15px 0 5px 10px;
1.597     albertel 8282: }
1.795     www      8283: 
1.936     bisitz   8284: div.LC_grade_show_user_odd_row {
1.941     bisitz   8285: /*  border-left: 5px solid #000000; */
                   8286: }
                   8287: 
                   8288: div.LC_grade_show_user div.LC_Box {
                   8289:   margin-right: 50px;
1.597     albertel 8290: }
                   8291: 
                   8292: div.LC_grade_submissions,
                   8293: div.LC_grade_message_center,
1.936     bisitz   8294: div.LC_grade_info_links {
1.597     albertel 8295:   margin: 5px;
                   8296:   width: 99%;
                   8297:   background: #FFFFFF;
                   8298: }
1.795     www      8299: 
1.597     albertel 8300: div.LC_grade_submissions_header,
1.936     bisitz   8301: div.LC_grade_message_center_header {
1.705     tempelho 8302:   font-weight: bold;
                   8303:   font-size: large;
1.597     albertel 8304: }
1.795     www      8305: 
1.597     albertel 8306: div.LC_grade_submissions_body,
1.936     bisitz   8307: div.LC_grade_message_center_body {
1.597     albertel 8308:   border: 1px solid black;
                   8309:   width: 99%;
                   8310:   background: #FFFFFF;
                   8311: }
1.795     www      8312: 
1.613     albertel 8313: table.LC_scantron_action {
                   8314:   width: 100%;
                   8315: }
1.795     www      8316: 
1.613     albertel 8317: table.LC_scantron_action tr th {
1.698     harmsja  8318:   font-weight:bold;
                   8319:   font-style:normal;
1.613     albertel 8320: }
1.795     www      8321: 
1.779     bisitz   8322: .LC_edit_problem_header,
1.614     albertel 8323: div.LC_edit_problem_footer {
1.705     tempelho 8324:   font-weight: normal;
                   8325:   font-size:  medium;
1.602     albertel 8326:   margin: 2px;
1.1060    bisitz   8327:   background-color: $sidebg;
1.600     albertel 8328: }
1.795     www      8329: 
1.600     albertel 8330: div.LC_edit_problem_header,
1.602     albertel 8331: div.LC_edit_problem_header div,
1.614     albertel 8332: div.LC_edit_problem_footer,
                   8333: div.LC_edit_problem_footer div,
1.602     albertel 8334: div.LC_edit_problem_editxml_header,
                   8335: div.LC_edit_problem_editxml_header div {
1.1205    golterma 8336:   z-index: 100;
1.600     albertel 8337: }
1.795     www      8338: 
1.600     albertel 8339: div.LC_edit_problem_header_title {
1.705     tempelho 8340:   font-weight: bold;
                   8341:   font-size: larger;
1.602     albertel 8342:   background: $tabbg;
                   8343:   padding: 3px;
1.1060    bisitz   8344:   margin: 0 0 5px 0;
1.602     albertel 8345: }
1.795     www      8346: 
1.602     albertel 8347: table.LC_edit_problem_header_title {
                   8348:   width: 100%;
1.600     albertel 8349:   background: $tabbg;
1.602     albertel 8350: }
                   8351: 
1.1205    golterma 8352: div.LC_edit_actionbar {
                   8353:     background-color: $sidebg;
1.1218    droeschl 8354:     margin: 0;
                   8355:     padding: 0;
                   8356:     line-height: 200%;
1.602     albertel 8357: }
1.795     www      8358: 
1.1218    droeschl 8359: div.LC_edit_actionbar div{
                   8360:     padding: 0;
                   8361:     margin: 0;
                   8362:     display: inline-block;
1.600     albertel 8363: }
1.795     www      8364: 
1.1124    bisitz   8365: .LC_edit_opt {
                   8366:   padding-left: 1em;
                   8367:   white-space: nowrap;
                   8368: }
                   8369: 
1.1152    golterma 8370: .LC_edit_problem_latexhelper{
                   8371:     text-align: right;
                   8372: }
                   8373: 
                   8374: #LC_edit_problem_colorful div{
                   8375:     margin-left: 40px;
                   8376: }
                   8377: 
1.1205    golterma 8378: #LC_edit_problem_codemirror div{
                   8379:     margin-left: 0px;
                   8380: }
                   8381: 
1.911     bisitz   8382: img.stift {
1.803     bisitz   8383:   border-width: 0;
                   8384:   vertical-align: middle;
1.677     riegler  8385: }
1.680     riegler  8386: 
1.923     bisitz   8387: table td.LC_mainmenu_col_fieldset {
1.680     riegler  8388:   vertical-align: top;
1.777     tempelho 8389: }
1.795     www      8390: 
1.716     raeburn  8391: div.LC_createcourse {
1.911     bisitz   8392:   margin: 10px 10px 10px 10px;
1.716     raeburn  8393: }
                   8394: 
1.917     raeburn  8395: .LC_dccid {
1.1130    raeburn  8396:   float: right;
1.917     raeburn  8397:   margin: 0.2em 0 0 0;
                   8398:   padding: 0;
                   8399:   font-size: 90%;
                   8400:   display:none;
                   8401: }
                   8402: 
1.897     wenzelju 8403: ol.LC_primary_menu a:hover,
1.721     harmsja  8404: ol#LC_MenuBreadcrumbs a:hover,
                   8405: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 8406: ul#LC_secondary_menu a:hover,
1.721     harmsja  8407: .LC_FormSectionClearButton input:hover
1.795     www      8408: ul.LC_TabContent   li:hover a {
1.952     onken    8409:   color:$button_hover;
1.911     bisitz   8410:   text-decoration:none;
1.693     droeschl 8411: }
                   8412: 
1.779     bisitz   8413: h1 {
1.911     bisitz   8414:   padding: 0;
                   8415:   line-height:130%;
1.693     droeschl 8416: }
1.698     harmsja  8417: 
1.911     bisitz   8418: h2,
                   8419: h3,
                   8420: h4,
                   8421: h5,
                   8422: h6 {
                   8423:   margin: 5px 0 5px 0;
                   8424:   padding: 0;
                   8425:   line-height:130%;
1.693     droeschl 8426: }
1.795     www      8427: 
                   8428: .LC_hcell {
1.911     bisitz   8429:   padding:3px 15px 3px 15px;
                   8430:   margin: 0;
                   8431:   background-color:$tabbg;
                   8432:   color:$fontmenu;
                   8433:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 8434: }
1.795     www      8435: 
1.840     bisitz   8436: .LC_Box > .LC_hcell {
1.911     bisitz   8437:   margin: 0 -10px 10px -10px;
1.835     bisitz   8438: }
                   8439: 
1.721     harmsja  8440: .LC_noBorder {
1.911     bisitz   8441:   border: 0;
1.698     harmsja  8442: }
1.693     droeschl 8443: 
1.721     harmsja  8444: .LC_FormSectionClearButton input {
1.911     bisitz   8445:   background-color:transparent;
                   8446:   border: none;
                   8447:   cursor:pointer;
                   8448:   text-decoration:underline;
1.693     droeschl 8449: }
1.763     bisitz   8450: 
                   8451: .LC_help_open_topic {
1.911     bisitz   8452:   color: #FFFFFF;
                   8453:   background-color: #EEEEFF;
                   8454:   margin: 1px;
                   8455:   padding: 4px;
                   8456:   border: 1px solid #000033;
                   8457:   white-space: nowrap;
                   8458:   /* vertical-align: middle; */
1.759     neumanie 8459: }
1.693     droeschl 8460: 
1.911     bisitz   8461: dl,
                   8462: ul,
                   8463: div,
                   8464: fieldset {
                   8465:   margin: 10px 10px 10px 0;
                   8466:   /* overflow: hidden; */
1.693     droeschl 8467: }
1.795     www      8468: 
1.1404    raeburn  8469: fieldset#LC_selectuser {
                   8470:     margin: 0;
                   8471:     padding: 0;
                   8472: }
                   8473: 
1.1211    raeburn  8474: article.geogebraweb div {
                   8475:     margin: 0;
                   8476: }
                   8477: 
1.838     bisitz   8478: fieldset > legend {
1.911     bisitz   8479:   font-weight: bold;
                   8480:   padding: 0 5px 0 5px;
1.838     bisitz   8481: }
                   8482: 
1.813     bisitz   8483: #LC_nav_bar {
1.911     bisitz   8484:   float: left;
1.995     raeburn  8485:   background-color: $pgbg_or_bgcolor;
1.966     bisitz   8486:   margin: 0 0 2px 0;
1.807     droeschl 8487: }
                   8488: 
1.916     droeschl 8489: #LC_realm {
                   8490:   margin: 0.2em 0 0 0;
                   8491:   padding: 0;
                   8492:   font-weight: bold;
                   8493:   text-align: center;
1.995     raeburn  8494:   background-color: $pgbg_or_bgcolor;
1.916     droeschl 8495: }
                   8496: 
1.911     bisitz   8497: #LC_nav_bar em {
                   8498:   font-weight: bold;
                   8499:   font-style: normal;
1.807     droeschl 8500: }
                   8501: 
1.897     wenzelju 8502: ol.LC_primary_menu {
1.934     droeschl 8503:   margin: 0;
1.1076    raeburn  8504:   padding: 0;
1.807     droeschl 8505: }
                   8506: 
1.852     droeschl 8507: ol#LC_PathBreadcrumbs {
1.911     bisitz   8508:   margin: 0;
1.693     droeschl 8509: }
                   8510: 
1.897     wenzelju 8511: ol.LC_primary_menu li {
1.1076    raeburn  8512:   color: RGB(80, 80, 80);
                   8513:   vertical-align: middle;
                   8514:   text-align: left;
                   8515:   list-style: none;
1.1205    golterma 8516:   position: relative;
1.1076    raeburn  8517:   float: left;
1.1205    golterma 8518:   z-index: 100; /* will be displayed above codemirror and underneath the help-layer */
                   8519:   line-height: 1.5em;
1.1076    raeburn  8520: }
                   8521: 
1.1205    golterma 8522: ol.LC_primary_menu li a,
                   8523: ol.LC_primary_menu li p {
1.1076    raeburn  8524:   display: block;
                   8525:   margin: 0;
                   8526:   padding: 0 5px 0 10px;
                   8527:   text-decoration: none;
                   8528: }
                   8529: 
1.1205    golterma 8530: ol.LC_primary_menu li p span.LC_primary_menu_innertitle {
                   8531:   display: inline-block;
                   8532:   width: 95%;
                   8533:   text-align: left;
                   8534: }
                   8535: 
                   8536: ol.LC_primary_menu li p span.LC_primary_menu_innerarrow {
                   8537:   display: inline-block;	
                   8538:   width: 5%;
                   8539:   float: right;
                   8540:   text-align: right;
                   8541:   font-size: 70%;
                   8542: }
                   8543: 
                   8544: ol.LC_primary_menu ul {
1.1076    raeburn  8545:   display: none;
1.1205    golterma 8546:   width: 15em;
1.1076    raeburn  8547:   background-color: $data_table_light;
1.1205    golterma 8548:   position: absolute;
                   8549:   top: 100%;
1.1076    raeburn  8550: }
                   8551: 
1.1205    golterma 8552: ol.LC_primary_menu ul ul {
                   8553:   left: 100%;
                   8554:   top: 0;
                   8555: }
                   8556: 
                   8557: ol.LC_primary_menu li:hover > ul, ol.LC_primary_menu li.hover > ul {
1.1076    raeburn  8558:   display: block;
                   8559:   position: absolute;
                   8560:   margin: 0;
                   8561:   padding: 0;
1.1078    raeburn  8562:   z-index: 2;
1.1076    raeburn  8563: }
                   8564: 
                   8565: ol.LC_primary_menu li:hover li, ol.LC_primary_menu li.hover li {
1.1205    golterma 8566: /* First Submenu -> size should be smaller than the menu title of the whole menu */
1.1076    raeburn  8567:   font-size: 90%;
1.911     bisitz   8568:   vertical-align: top;
1.1076    raeburn  8569:   float: none;
1.1079    raeburn  8570:   border-left: 1px solid black;
                   8571:   border-right: 1px solid black;
1.1205    golterma 8572: /* A dark bottom border to visualize different menu options; 
                   8573: overwritten in the create_submenu routine for the last border-bottom of the menu */
                   8574:   border-bottom: 1px solid $data_table_dark; 
1.1076    raeburn  8575: }
                   8576: 
1.1205    golterma 8577: ol.LC_primary_menu li li p:hover {
                   8578:   color:$button_hover;
                   8579:   text-decoration:none;
                   8580:   background-color:$data_table_dark;
1.1076    raeburn  8581: }
                   8582: 
                   8583: ol.LC_primary_menu li li a:hover {
                   8584:    color:$button_hover;
                   8585:    background-color:$data_table_dark;
1.693     droeschl 8586: }
                   8587: 
1.1205    golterma 8588: /* Font-size equal to the size of the predecessors*/
                   8589: ol.LC_primary_menu li:hover li li {
                   8590:   font-size: 100%;
                   8591: }
                   8592: 
1.897     wenzelju 8593: ol.LC_primary_menu li img {
1.911     bisitz   8594:   vertical-align: bottom;
1.934     droeschl 8595:   height: 1.1em;
1.1077    raeburn  8596:   margin: 0.2em 0 0 0;
1.693     droeschl 8597: }
                   8598: 
1.897     wenzelju 8599: ol.LC_primary_menu a {
1.911     bisitz   8600:   color: RGB(80, 80, 80);
                   8601:   text-decoration: none;
1.693     droeschl 8602: }
1.795     www      8603: 
1.949     droeschl 8604: ol.LC_primary_menu a.LC_new_message {
                   8605:   font-weight:bold;
                   8606:   color: darkred;
                   8607: }
                   8608: 
1.975     raeburn  8609: ol.LC_docs_parameters {
                   8610:   margin-left: 0;
                   8611:   padding: 0;
                   8612:   list-style: none;
                   8613: }
                   8614: 
                   8615: ol.LC_docs_parameters li {
                   8616:   margin: 0;
                   8617:   padding-right: 20px;
                   8618:   display: inline;
                   8619: }
                   8620: 
1.976     raeburn  8621: ol.LC_docs_parameters li:before {
                   8622:   content: "\\002022 \\0020";
                   8623: }
                   8624: 
                   8625: li.LC_docs_parameters_title {
                   8626:   font-weight: bold;
                   8627: }
                   8628: 
                   8629: ol.LC_docs_parameters li.LC_docs_parameters_title:before {
                   8630:   content: "";
                   8631: }
                   8632: 
1.897     wenzelju 8633: ul#LC_secondary_menu {
1.1107    raeburn  8634:   clear: right;
1.911     bisitz   8635:   color: $fontmenu;
                   8636:   background: $tabbg;
                   8637:   list-style: none;
                   8638:   padding: 0;
                   8639:   margin: 0;
                   8640:   width: 100%;
1.995     raeburn  8641:   text-align: left;
1.1107    raeburn  8642:   float: left;
1.808     droeschl 8643: }
                   8644: 
1.897     wenzelju 8645: ul#LC_secondary_menu li {
1.911     bisitz   8646:   font-weight: bold;
                   8647:   line-height: 1.8em;
1.1107    raeburn  8648:   border-right: 1px solid black;
                   8649:   float: left;
                   8650: }
                   8651: 
                   8652: ul#LC_secondary_menu li.LC_hoverable:hover, ul#LC_secondary_menu li.hover {
                   8653:   background-color: $data_table_light;
                   8654: }
                   8655: 
                   8656: ul#LC_secondary_menu li a {
1.911     bisitz   8657:   padding: 0 0.8em;
1.1107    raeburn  8658: }
                   8659: 
                   8660: ul#LC_secondary_menu li ul {
                   8661:   display: none;
                   8662: }
                   8663: 
                   8664: ul#LC_secondary_menu li:hover ul, ul#LC_secondary_menu li.hover ul {
                   8665:   display: block;
                   8666:   position: absolute;
                   8667:   margin: 0;
                   8668:   padding: 0;
                   8669:   list-style:none;
                   8670:   float: none;
                   8671:   background-color: $data_table_light;
                   8672:   z-index: 2;
                   8673:   margin-left: -1px;
                   8674: }
                   8675: 
                   8676: ul#LC_secondary_menu li ul li {
                   8677:   font-size: 90%;
                   8678:   vertical-align: top;
                   8679:   border-left: 1px solid black;
1.911     bisitz   8680:   border-right: 1px solid black;
1.1119    raeburn  8681:   background-color: $data_table_light;
1.1107    raeburn  8682:   list-style:none;
                   8683:   float: none;
                   8684: }
                   8685: 
                   8686: ul#LC_secondary_menu li ul li:hover, ul#LC_secondary_menu li ul li.hover {
                   8687:   background-color: $data_table_dark;
1.807     droeschl 8688: }
                   8689: 
1.847     tempelho 8690: ul.LC_TabContent {
1.911     bisitz   8691:   display:block;
                   8692:   background: $sidebg;
                   8693:   border-bottom: solid 1px $lg_border_color;
                   8694:   list-style:none;
1.1020    raeburn  8695:   margin: -1px -10px 0 -10px;
1.911     bisitz   8696:   padding: 0;
1.693     droeschl 8697: }
                   8698: 
1.795     www      8699: ul.LC_TabContent li,
                   8700: ul.LC_TabContentBigger li {
1.911     bisitz   8701:   float:left;
1.741     harmsja  8702: }
1.795     www      8703: 
1.897     wenzelju 8704: ul#LC_secondary_menu li a {
1.911     bisitz   8705:   color: $fontmenu;
                   8706:   text-decoration: none;
1.693     droeschl 8707: }
1.795     www      8708: 
1.721     harmsja  8709: ul.LC_TabContent {
1.952     onken    8710:   min-height:20px;
1.721     harmsja  8711: }
1.795     www      8712: 
                   8713: ul.LC_TabContent li {
1.911     bisitz   8714:   vertical-align:middle;
1.959     onken    8715:   padding: 0 16px 0 10px;
1.911     bisitz   8716:   background-color:$tabbg;
                   8717:   border-bottom:solid 1px $lg_border_color;
1.1020    raeburn  8718:   border-left: solid 1px $font;
1.721     harmsja  8719: }
1.795     www      8720: 
1.847     tempelho 8721: ul.LC_TabContent .right {
1.911     bisitz   8722:   float:right;
1.847     tempelho 8723: }
                   8724: 
1.911     bisitz   8725: ul.LC_TabContent li a,
                   8726: ul.LC_TabContent li {
                   8727:   color:rgb(47,47,47);
                   8728:   text-decoration:none;
                   8729:   font-size:95%;
                   8730:   font-weight:bold;
1.952     onken    8731:   min-height:20px;
                   8732: }
                   8733: 
1.959     onken    8734: ul.LC_TabContent li a:hover,
                   8735: ul.LC_TabContent li a:focus {
1.952     onken    8736:   color: $button_hover;
1.959     onken    8737:   background:none;
                   8738:   outline:none;
1.952     onken    8739: }
                   8740: 
                   8741: ul.LC_TabContent li:hover {
                   8742:   color: $button_hover;
                   8743:   cursor:pointer;
1.721     harmsja  8744: }
1.795     www      8745: 
1.911     bisitz   8746: ul.LC_TabContent li.active {
1.952     onken    8747:   color: $font;
1.911     bisitz   8748:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.952     onken    8749:   border-bottom:solid 1px #FFFFFF;
                   8750:   cursor: default;
1.744     ehlerst  8751: }
1.795     www      8752: 
1.959     onken    8753: ul.LC_TabContent li.active a {
                   8754:   color:$font;
                   8755:   background:#FFFFFF;
                   8756:   outline: none;
                   8757: }
1.1047    raeburn  8758: 
                   8759: ul.LC_TabContent li.goback {
                   8760:   float: left;
                   8761:   border-left: none;
                   8762: }
                   8763: 
1.870     tempelho 8764: #maincoursedoc {
1.911     bisitz   8765:   clear:both;
1.870     tempelho 8766: }
                   8767: 
                   8768: ul.LC_TabContentBigger {
1.911     bisitz   8769:   display:block;
                   8770:   list-style:none;
                   8771:   padding: 0;
1.870     tempelho 8772: }
                   8773: 
1.795     www      8774: ul.LC_TabContentBigger li {
1.911     bisitz   8775:   vertical-align:bottom;
                   8776:   height: 30px;
                   8777:   font-size:110%;
                   8778:   font-weight:bold;
                   8779:   color: #737373;
1.841     tempelho 8780: }
                   8781: 
1.957     onken    8782: ul.LC_TabContentBigger li.active {
                   8783:   position: relative;
                   8784:   top: 1px;
                   8785: }
                   8786: 
1.870     tempelho 8787: ul.LC_TabContentBigger li a {
1.911     bisitz   8788:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   8789:   height: 30px;
                   8790:   line-height: 30px;
                   8791:   text-align: center;
                   8792:   display: block;
                   8793:   text-decoration: none;
1.958     onken    8794:   outline: none;  
1.741     harmsja  8795: }
1.795     www      8796: 
1.870     tempelho 8797: ul.LC_TabContentBigger li.active a {
1.911     bisitz   8798:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   8799:   color:$font;
1.744     ehlerst  8800: }
1.795     www      8801: 
1.870     tempelho 8802: ul.LC_TabContentBigger li b {
1.911     bisitz   8803:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   8804:   display: block;
                   8805:   float: left;
                   8806:   padding: 0 30px;
1.957     onken    8807:   border-bottom: 1px solid $lg_border_color;
1.870     tempelho 8808: }
                   8809: 
1.956     onken    8810: ul.LC_TabContentBigger li:hover b {
                   8811:   color:$button_hover;
                   8812: }
                   8813: 
1.870     tempelho 8814: ul.LC_TabContentBigger li.active b {
1.911     bisitz   8815:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   8816:   color:$font;
1.957     onken    8817:   border: 0;
1.741     harmsja  8818: }
1.693     droeschl 8819: 
1.870     tempelho 8820: 
1.862     bisitz   8821: ul.LC_CourseBreadcrumbs {
                   8822:   background: $sidebg;
1.1020    raeburn  8823:   height: 2em;
1.862     bisitz   8824:   padding-left: 10px;
1.1020    raeburn  8825:   margin: 0;
1.862     bisitz   8826:   list-style-position: inside;
                   8827: }
                   8828: 
1.911     bisitz   8829: ol#LC_MenuBreadcrumbs,
1.862     bisitz   8830: ol#LC_PathBreadcrumbs {
1.911     bisitz   8831:   padding-left: 10px;
                   8832:   margin: 0;
1.933     droeschl 8833:   height: 2.5em;  /* equal to #LC_breadcrumbs line-height */
1.693     droeschl 8834: }
                   8835: 
1.911     bisitz   8836: ol#LC_MenuBreadcrumbs li,
                   8837: ol#LC_PathBreadcrumbs li,
1.862     bisitz   8838: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   8839:   display: inline;
1.933     droeschl 8840:   white-space: normal;  
1.693     droeschl 8841: }
                   8842: 
1.823     bisitz   8843: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   8844: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   8845:   text-decoration: none;
                   8846:   font-size:90%;
1.693     droeschl 8847: }
1.795     www      8848: 
1.969     droeschl 8849: ol#LC_MenuBreadcrumbs h1 {
                   8850:   display: inline;
                   8851:   font-size: 90%;
                   8852:   line-height: 2.5em;
                   8853:   margin: 0;
                   8854:   padding: 0;
                   8855: }
                   8856: 
1.795     www      8857: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   8858:   text-decoration:none;
                   8859:   font-size:100%;
                   8860:   font-weight:bold;
1.693     droeschl 8861: }
1.795     www      8862: 
1.840     bisitz   8863: .LC_Box {
1.911     bisitz   8864:   border: solid 1px $lg_border_color;
                   8865:   padding: 0 10px 10px 10px;
1.746     neumanie 8866: }
1.795     www      8867: 
1.1020    raeburn  8868: .LC_DocsBox {
                   8869:   border: solid 1px $lg_border_color;
                   8870:   padding: 0 0 10px 10px;
                   8871: }
                   8872: 
1.795     www      8873: .LC_AboutMe_Image {
1.911     bisitz   8874:   float:left;
                   8875:   margin-right:10px;
1.747     neumanie 8876: }
1.795     www      8877: 
                   8878: .LC_Clear_AboutMe_Image {
1.911     bisitz   8879:   clear:left;
1.747     neumanie 8880: }
1.795     www      8881: 
1.721     harmsja  8882: dl.LC_ListStyleClean dt {
1.911     bisitz   8883:   padding-right: 5px;
                   8884:   display: table-header-group;
1.693     droeschl 8885: }
                   8886: 
1.721     harmsja  8887: dl.LC_ListStyleClean dd {
1.911     bisitz   8888:   display: table-row;
1.693     droeschl 8889: }
                   8890: 
1.721     harmsja  8891: .LC_ListStyleClean,
                   8892: .LC_ListStyleSimple,
                   8893: .LC_ListStyleNormal,
1.795     www      8894: .LC_ListStyleSpecial {
1.911     bisitz   8895:   /* display:block; */
                   8896:   list-style-position: inside;
                   8897:   list-style-type: none;
                   8898:   overflow: hidden;
                   8899:   padding: 0;
1.693     droeschl 8900: }
                   8901: 
1.721     harmsja  8902: .LC_ListStyleSimple li,
                   8903: .LC_ListStyleSimple dd,
                   8904: .LC_ListStyleNormal li,
                   8905: .LC_ListStyleNormal dd,
                   8906: .LC_ListStyleSpecial li,
1.795     www      8907: .LC_ListStyleSpecial dd {
1.911     bisitz   8908:   margin: 0;
                   8909:   padding: 5px 5px 5px 10px;
                   8910:   clear: both;
1.693     droeschl 8911: }
                   8912: 
1.721     harmsja  8913: .LC_ListStyleClean li,
                   8914: .LC_ListStyleClean dd {
1.911     bisitz   8915:   padding-top: 0;
                   8916:   padding-bottom: 0;
1.693     droeschl 8917: }
                   8918: 
1.721     harmsja  8919: .LC_ListStyleSimple dd,
1.795     www      8920: .LC_ListStyleSimple li {
1.911     bisitz   8921:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 8922: }
                   8923: 
1.721     harmsja  8924: .LC_ListStyleSpecial li,
                   8925: .LC_ListStyleSpecial dd {
1.911     bisitz   8926:   list-style-type: none;
                   8927:   background-color: RGB(220, 220, 220);
                   8928:   margin-bottom: 4px;
1.693     droeschl 8929: }
                   8930: 
1.721     harmsja  8931: table.LC_SimpleTable {
1.911     bisitz   8932:   margin:5px;
                   8933:   border:solid 1px $lg_border_color;
1.795     www      8934: }
1.693     droeschl 8935: 
1.721     harmsja  8936: table.LC_SimpleTable tr {
1.911     bisitz   8937:   padding: 0;
                   8938:   border:solid 1px $lg_border_color;
1.693     droeschl 8939: }
1.795     www      8940: 
                   8941: table.LC_SimpleTable thead {
1.911     bisitz   8942:   background:rgb(220,220,220);
1.693     droeschl 8943: }
                   8944: 
1.721     harmsja  8945: div.LC_columnSection {
1.911     bisitz   8946:   display: block;
                   8947:   clear: both;
                   8948:   overflow: hidden;
                   8949:   margin: 0;
1.693     droeschl 8950: }
                   8951: 
1.721     harmsja  8952: div.LC_columnSection>* {
1.911     bisitz   8953:   float: left;
                   8954:   margin: 10px 20px 10px 0;
                   8955:   overflow:hidden;
1.693     droeschl 8956: }
1.721     harmsja  8957: 
1.795     www      8958: table em {
1.911     bisitz   8959:   font-weight: bold;
                   8960:   font-style: normal;
1.748     schulted 8961: }
1.795     www      8962: 
1.779     bisitz   8963: table.LC_tableBrowseRes,
1.795     www      8964: table.LC_tableOfContent {
1.911     bisitz   8965:   border:none;
                   8966:   border-spacing: 1px;
                   8967:   padding: 3px;
                   8968:   background-color: #FFFFFF;
                   8969:   font-size: 90%;
1.753     droeschl 8970: }
1.789     droeschl 8971: 
1.911     bisitz   8972: table.LC_tableOfContent {
                   8973:   border-collapse: collapse;
1.789     droeschl 8974: }
                   8975: 
1.771     droeschl 8976: table.LC_tableBrowseRes a,
1.768     schulted 8977: table.LC_tableOfContent a {
1.911     bisitz   8978:   background-color: transparent;
                   8979:   text-decoration: none;
1.753     droeschl 8980: }
                   8981: 
1.795     www      8982: table.LC_tableOfContent img {
1.911     bisitz   8983:   border: none;
                   8984:   height: 1.3em;
                   8985:   vertical-align: text-bottom;
                   8986:   margin-right: 0.3em;
1.753     droeschl 8987: }
1.757     schulted 8988: 
1.795     www      8989: a#LC_content_toolbar_firsthomework {
1.911     bisitz   8990:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  8991: }
                   8992: 
1.795     www      8993: a#LC_content_toolbar_everything {
1.911     bisitz   8994:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  8995: }
                   8996: 
1.795     www      8997: a#LC_content_toolbar_uncompleted {
1.911     bisitz   8998:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  8999: }
                   9000: 
1.795     www      9001: #LC_content_toolbar_clearbubbles {
1.911     bisitz   9002:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  9003: }
                   9004: 
1.795     www      9005: a#LC_content_toolbar_changefolder {
1.911     bisitz   9006:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 9007: }
                   9008: 
1.795     www      9009: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   9010:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 9011: }
                   9012: 
1.1043    raeburn  9013: a#LC_content_toolbar_edittoplevel {
                   9014:   background-image:url(/res/adm/pages/edittoplevel.gif);
                   9015: }
                   9016: 
1.1384    raeburn  9017: a#LC_content_toolbar_printout {
                   9018:   background-image:url(/res/adm/pages/printout.gif);
                   9019: }
                   9020: 
1.795     www      9021: ul#LC_toolbar li a:hover {
1.911     bisitz   9022:   background-position: bottom center;
1.757     schulted 9023: }
                   9024: 
1.795     www      9025: ul#LC_toolbar {
1.911     bisitz   9026:   padding: 0;
                   9027:   margin: 2px;
                   9028:   list-style:none;
                   9029:   position:relative;
                   9030:   background-color:white;
1.1082    raeburn  9031:   overflow: auto;
1.757     schulted 9032: }
                   9033: 
1.795     www      9034: ul#LC_toolbar li {
1.911     bisitz   9035:   border:1px solid white;
                   9036:   padding: 0;
                   9037:   margin: 0;
                   9038:   float: left;
                   9039:   display:inline;
                   9040:   vertical-align:middle;
1.1082    raeburn  9041:   white-space: nowrap;
1.911     bisitz   9042: }
1.757     schulted 9043: 
1.783     amueller 9044: 
1.795     www      9045: a.LC_toolbarItem {
1.911     bisitz   9046:   display:block;
                   9047:   padding: 0;
                   9048:   margin: 0;
                   9049:   height: 32px;
                   9050:   width: 32px;
                   9051:   color:white;
                   9052:   border: none;
                   9053:   background-repeat:no-repeat;
                   9054:   background-color:transparent;
1.757     schulted 9055: }
                   9056: 
1.915     droeschl 9057: ul.LC_funclist {
                   9058:     margin: 0;
                   9059:     padding: 0.5em 1em 0.5em 0;
                   9060: }
                   9061: 
1.933     droeschl 9062: ul.LC_funclist > li:first-child {
                   9063:     font-weight:bold; 
                   9064:     margin-left:0.8em;
                   9065: }
                   9066: 
1.915     droeschl 9067: ul.LC_funclist + ul.LC_funclist {
                   9068:     /* 
                   9069:        left border as a seperator if we have more than
                   9070:        one list 
                   9071:     */
                   9072:     border-left: 1px solid $sidebg;
                   9073:     /* 
                   9074:        this hides the left border behind the border of the 
                   9075:        outer box if element is wrapped to the next 'line' 
                   9076:     */
                   9077:     margin-left: -1px;
                   9078: }
                   9079: 
1.843     bisitz   9080: ul.LC_funclist li {
1.915     droeschl 9081:   display: inline;
1.782     bisitz   9082:   white-space: nowrap;
1.915     droeschl 9083:   margin: 0 0 0 25px;
                   9084:   line-height: 150%;
1.782     bisitz   9085: }
                   9086: 
1.974     wenzelju 9087: .LC_hidden {
                   9088:   display: none;
                   9089: }
                   9090: 
1.1030    www      9091: .LCmodal-overlay {
                   9092: 		position:fixed;
                   9093: 		top:0;
                   9094: 		right:0;
                   9095: 		bottom:0;
                   9096: 		left:0;
                   9097: 		height:100%;
                   9098: 		width:100%;
                   9099: 		margin:0;
                   9100: 		padding:0;
                   9101: 		background:#999;
                   9102: 		opacity:.75;
                   9103: 		filter: alpha(opacity=75);
                   9104: 		-moz-opacity: 0.75;
                   9105: 		z-index:101;
                   9106: }
                   9107: 
                   9108: * html .LCmodal-overlay {   
                   9109: 		position: absolute;
                   9110: 		height: expression(document.body.scrollHeight > document.body.offsetHeight ? document.body.scrollHeight : document.body.offsetHeight + 'px');
                   9111: }
                   9112: 
                   9113: .LCmodal-window {
                   9114: 		position:fixed;
                   9115: 		top:50%;
                   9116: 		left:50%;
                   9117: 		margin:0;
                   9118: 		padding:0;
                   9119: 		z-index:102;
                   9120: 	}
                   9121: 
                   9122: * html .LCmodal-window {
                   9123: 		position:absolute;
                   9124: }
                   9125: 
                   9126: .LCclose-window {
                   9127: 		position:absolute;
                   9128: 		width:32px;
                   9129: 		height:32px;
                   9130: 		right:8px;
                   9131: 		top:8px;
                   9132: 		background:transparent url('/res/adm/pages/process-stop.png') no-repeat scroll right top;
                   9133: 		text-indent:-99999px;
                   9134: 		overflow:hidden;
                   9135: 		cursor:pointer;
                   9136: }
                   9137: 
1.1369    raeburn  9138: .LCisDisabled {
                   9139:   cursor: not-allowed;
                   9140:   opacity: 0.5;
                   9141: }
                   9142: 
                   9143: a[aria-disabled="true"] {
                   9144:   color: currentColor;
                   9145:   display: inline-block;  /* For IE11/ MS Edge bug */
                   9146:   pointer-events: none;
                   9147:   text-decoration: none;
                   9148: }
                   9149: 
1.1335    raeburn  9150: pre.LC_wordwrap {
                   9151:   white-space: pre-wrap;
                   9152:   white-space: -moz-pre-wrap;
                   9153:   white-space: -pre-wrap;
                   9154:   white-space: -o-pre-wrap;
                   9155:   word-wrap: break-word;
                   9156: }
                   9157: 
1.1100    raeburn  9158: /*
1.1231    damieng  9159:   styles used for response display
                   9160: */
                   9161: div.LC_radiofoil, div.LC_rankfoil {
                   9162:   margin: .5em 0em .5em 0em;
                   9163: }
                   9164: table.LC_itemgroup {
                   9165:   margin-top: 1em;
                   9166: }
                   9167: 
                   9168: /*
1.1100    raeburn  9169:   styles used by TTH when "Default set of options to pass to tth/m
                   9170:   when converting TeX" in course settings has been set
                   9171: 
                   9172:   option passed: -t
                   9173: 
                   9174: */
                   9175: 
                   9176: td div.comp { margin-top: -0.6ex; margin-bottom: -1ex;}
                   9177: td div.comb { margin-top: -0.6ex; margin-bottom: -.6ex;}
                   9178: td div.hrcomp { line-height: 0.9; margin-top: -0.8ex; margin-bottom: -1ex;}
                   9179: td div.norm {line-height:normal;}
                   9180: 
                   9181: /*
                   9182:   option passed -y3
                   9183: */
                   9184: 
                   9185: span.roman {font-family: serif; font-style: normal; font-weight: normal;}
                   9186: span.overacc2 {position: relative;  left: .8em; top: -1.2ex;}
                   9187: span.overacc1 {position: relative;  left: .6em; top: -1.2ex;}
                   9188: 
1.1230    damieng  9189: /*
                   9190:   sections with roles, for content only
                   9191: */
                   9192: section[class^="role-"] {
                   9193:   padding-left: 10px;
                   9194:   padding-right: 5px;
                   9195:   margin-top: 8px;
                   9196:   margin-bottom: 8px;
                   9197:   border: 1px solid #2A4;
                   9198:   border-radius: 5px;
                   9199:   box-shadow: 0px 1px 1px #BBB;
                   9200: }
                   9201: section[class^="role-"]>h1 {
                   9202:   position: relative;
                   9203:   margin: 0px;
                   9204:   padding-top: 10px;
                   9205:   padding-left: 40px;
                   9206: }
                   9207: section[class^="role-"]>h1:before {
                   9208:   position: absolute;
                   9209:   left: -5px;
                   9210:   top: 5px;
                   9211: }
                   9212: section.role-activity>h1:before {
                   9213:   content:url('/adm/daxe/images/section_icons/activity.png');
                   9214: }
                   9215: section.role-advice>h1:before {
                   9216:   content:url('/adm/daxe/images/section_icons/advice.png');
                   9217: }
                   9218: section.role-bibliography>h1:before {
                   9219:   content:url('/adm/daxe/images/section_icons/bibliography.png');
                   9220: }
                   9221: section.role-citation>h1:before {
                   9222:   content:url('/adm/daxe/images/section_icons/citation.png');
                   9223: }
                   9224: section.role-conclusion>h1:before {
                   9225:   content:url('/adm/daxe/images/section_icons/conclusion.png');
                   9226: }
                   9227: section.role-definition>h1:before {
                   9228:   content:url('/adm/daxe/images/section_icons/definition.png');
                   9229: }
                   9230: section.role-demonstration>h1:before {
                   9231:   content:url('/adm/daxe/images/section_icons/demonstration.png');
                   9232: }
                   9233: section.role-example>h1:before {
                   9234:   content:url('/adm/daxe/images/section_icons/example.png');
                   9235: }
                   9236: section.role-explanation>h1:before {
                   9237:   content:url('/adm/daxe/images/section_icons/explanation.png');
                   9238: }
                   9239: section.role-introduction>h1:before {
                   9240:   content:url('/adm/daxe/images/section_icons/introduction.png');
                   9241: }
                   9242: section.role-method>h1:before {
                   9243:   content:url('/adm/daxe/images/section_icons/method.png');
                   9244: }
                   9245: section.role-more_information>h1:before {
                   9246:   content:url('/adm/daxe/images/section_icons/more_information.png');
                   9247: }
                   9248: section.role-objectives>h1:before {
                   9249:   content:url('/adm/daxe/images/section_icons/objectives.png');
                   9250: }
                   9251: section.role-prerequisites>h1:before {
                   9252:   content:url('/adm/daxe/images/section_icons/prerequisites.png');
                   9253: }
                   9254: section.role-remark>h1:before {
                   9255:   content:url('/adm/daxe/images/section_icons/remark.png');
                   9256: }
                   9257: section.role-reminder>h1:before {
                   9258:   content:url('/adm/daxe/images/section_icons/reminder.png');
                   9259: }
                   9260: section.role-summary>h1:before {
                   9261:   content:url('/adm/daxe/images/section_icons/summary.png');
                   9262: }
                   9263: section.role-syntax>h1:before {
                   9264:   content:url('/adm/daxe/images/section_icons/syntax.png');
                   9265: }
                   9266: section.role-warning>h1:before {
                   9267:   content:url('/adm/daxe/images/section_icons/warning.png');
                   9268: }
                   9269: 
1.1269    raeburn  9270: #LC_minitab_header {
                   9271:   float:left;
                   9272:   width:100%;
                   9273:   background:#DAE0D2 url("/res/adm/pages/minitabmenu_bg.gif") repeat-x bottom;
                   9274:   font-size:93%;
                   9275:   line-height:normal;
                   9276:   margin: 0.5em 0 0.5em 0;
                   9277: }
                   9278: #LC_minitab_header ul {
                   9279:   margin:0;
                   9280:   padding:10px 10px 0;
                   9281:   list-style:none;
                   9282: }
                   9283: #LC_minitab_header li {
                   9284:   float:left;
                   9285:   background:url("/res/adm/pages/minitabmenu_left.gif") no-repeat left top;
                   9286:   margin:0;
                   9287:   padding:0 0 0 9px;
                   9288: }
                   9289: #LC_minitab_header a {
                   9290:   display:block;
                   9291:   background:url("/res/adm/pages/minitabmenu_right.gif") no-repeat right top;
                   9292:   padding:5px 15px 4px 6px;
                   9293: }
                   9294: #LC_minitab_header #LC_current_minitab {
                   9295:   background-image:url("/res/adm/pages/minitabmenu_left_on.gif");
                   9296: }
                   9297: #LC_minitab_header #LC_current_minitab a {
                   9298:   background-image:url("/res/adm/pages/minitabmenu_right_on.gif");
                   9299:   padding-bottom:5px;
                   9300: }
                   9301: 
                   9302: 
1.343     albertel 9303: END
                   9304: }
                   9305: 
1.306     albertel 9306: =pod
                   9307: 
                   9308: =item * &headtag()
                   9309: 
                   9310: Returns a uniform footer for LON-CAPA web pages.
                   9311: 
1.307     albertel 9312: Inputs: $title - optional title for the head
                   9313:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 9314:         $args - optional arguments
1.319     albertel 9315:             force_register - if is true call registerurl so the remote is 
                   9316:                              informed
1.415     albertel 9317:             redirect       -> array ref of
                   9318:                                    1- seconds before redirect occurs
                   9319:                                    2- url to redirect to
                   9320:                                    3- whether the side effect should occur
1.315     albertel 9321:                            (side effect of setting 
                   9322:                                $env{'internal.head.redirect'} to the url 
1.1386    raeburn  9323:                                redirected to)
                   9324:                                    4- whether the redirect target should be
                   9325:                                       the opener of the current (pop-up)
                   9326:                                       window (side effect of setting
                   9327:                                       $env{'internal.head.to_opener'} to
                   9328:                                       1, if true.
1.1388    raeburn  9329:                                    5- whether encrypt check should be skipped
1.352     albertel 9330:             domain         -> force to color decorate a page for a specific
                   9331:                                domain
                   9332:             function       -> force usage of a specific rolish color scheme
                   9333:             bgcolor        -> override the default page bgcolor
1.460     albertel 9334:             no_auto_mt_title
                   9335:                            -> prevent &mt()ing the title arg
1.464     albertel 9336: 
1.306     albertel 9337: =cut
                   9338: 
                   9339: sub headtag {
1.313     albertel 9340:     my ($title,$head_extra,$args) = @_;
1.306     albertel 9341:     
1.363     albertel 9342:     my $function = $args->{'function'} || &get_users_function();
                   9343:     my $domain   = $args->{'domain'}   || &determinedomain();
                   9344:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.1154    raeburn  9345:     my $httphost = $args->{'use_absolute'};
1.418     albertel 9346:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 9347: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 9348: 		   #time(),
1.418     albertel 9349: 		   $env{'environment.color.timestamp'},
1.363     albertel 9350: 		   $function,$domain,$bgcolor);
                   9351: 
1.369     www      9352:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 9353: 
1.308     albertel 9354:     my $result =
                   9355: 	'<head>'.
1.1160    raeburn  9356: 	&font_settings($args);
1.319     albertel 9357: 
1.1188    raeburn  9358:     my $inhibitprint;
                   9359:     if ($args->{'print_suppress'}) {
                   9360:         $inhibitprint = &print_suppression();
                   9361:     }
1.1064    raeburn  9362: 
1.461     albertel 9363:     if (!$args->{'frameset'}) {
                   9364: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   9365:     }
1.962     droeschl 9366:     if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) {
                   9367:         $result .= Apache::lonxml::display_title();
1.319     albertel 9368:     }
1.436     albertel 9369:     if (!$args->{'no_nav_bar'} 
                   9370: 	&& !$args->{'only_body'}
                   9371: 	&& !$args->{'frameset'}) {
1.1154    raeburn  9372: 	$result .= &help_menu_js($httphost);
1.1032    www      9373:         $result.=&modal_window();
1.1038    www      9374:         $result.=&togglebox_script();
1.1034    www      9375:         $result.=&wishlist_window();
1.1041    www      9376:         $result.=&LCprogressbarUpdate_script();
1.1034    www      9377:     } else {
                   9378:         if ($args->{'add_modal'}) {
                   9379:            $result.=&modal_window();
                   9380:         }
                   9381:         if ($args->{'add_wishlist'}) {
                   9382:            $result.=&wishlist_window();
                   9383:         }
1.1038    www      9384:         if ($args->{'add_togglebox'}) {
                   9385:            $result.=&togglebox_script();
                   9386:         }
1.1041    www      9387:         if ($args->{'add_progressbar'}) {
                   9388:            $result.=&LCprogressbarUpdate_script();
                   9389:         }
1.436     albertel 9390:     }
1.314     albertel 9391:     if (ref($args->{'redirect'})) {
1.1388    raeburn  9392: 	my ($time,$url,$inhibit_continue,$to_opener,$skip_enc_check) = @{$args->{'redirect'}};
                   9393:         if (!$skip_enc_check) {
                   9394:             $url = &Apache::lonenc::check_encrypt($url);
                   9395:         }
1.414     albertel 9396: 	if (!$inhibit_continue) {
                   9397: 	    $env{'internal.head.redirect'} = $url;
                   9398: 	}
1.1386    raeburn  9399: 	$result.=<<"ADDMETA";
1.313     albertel 9400: <meta http-equiv="pragma" content="no-cache" />
1.1386    raeburn  9401: ADDMETA
                   9402:         if ($to_opener) {
                   9403:             $env{'internal.head.to_opener'} = 1;
                   9404:             my $dest = &js_escape($url);
                   9405:             my $timeout = int($time * 1000);
                   9406:             $result .=<<"ENDJS";
                   9407: <script type="text/javascript">
                   9408: // <![CDATA[
                   9409: function LC_To_Opener() {
                   9410:     var dest = '$dest';
                   9411:     if (dest != '') {
                   9412:         if (window.opener != null && !window.opener.closed) {
                   9413:             window.opener.location.href=dest;
                   9414:             window.close();
                   9415:         } else {
                   9416:             window.location.href=dest;
                   9417:         }
                   9418:     }
                   9419: }
                   9420: \$(document).ready(function () {
                   9421:     setTimeout('LC_To_Opener()',$timeout);
                   9422: });
                   9423: // ]]>
                   9424: </script>
                   9425: ENDJS
                   9426:         } else {
                   9427:             $result.=<<"ADDMETA";
1.344     albertel 9428: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 9429: ADDMETA
1.1386    raeburn  9430:         }
1.1210    raeburn  9431:     } else {
                   9432:         unless (($args->{'frameset'}) || ($args->{'js_ready'}) || ($args->{'only_body'}) || ($args->{'no_nav_bar'})) {
                   9433:             my $requrl = $env{'request.uri'};
                   9434:             if ($requrl eq '') {
                   9435:                 $requrl = $ENV{'REQUEST_URI'};
                   9436:                 $requrl =~ s/\?.+$//;
                   9437:             }
                   9438:             unless (($requrl =~ m{^/adm/(?:switchserver|login|authenticate|logout|groupsort|cleanup|helper|slotrequest|grades)(\?|$)}) ||
                   9439:                     (($requrl =~ m{^/res/}) && (($env{'form.submitted'} eq 'scantron') ||
                   9440:                      ($env{'form.grade_symb'}) || ($Apache::lonhomework::scantronmode)))) {
                   9441:                 my $dom_in_use = $Apache::lonnet::perlvar{'lonDefDomain'};
                   9442:                 unless (&Apache::lonnet::allowed('mau',$dom_in_use)) {
                   9443:                     my %domdefs = &Apache::lonnet::get_domain_defaults($dom_in_use);
1.1340    raeburn  9444:                     my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
1.1352    raeburn  9445:                     my ($offload,$offloadoth);
1.1210    raeburn  9446:                     if (ref($domdefs{'offloadnow'}) eq 'HASH') {
                   9447:                         if ($domdefs{'offloadnow'}{$lonhost}) {
1.1340    raeburn  9448:                             $offload = 1;
1.1353    raeburn  9449:                             if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   9450:                                 (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   9451:                                 unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   9452:                                     $offloadoth = 1;
                   9453:                                     $dom_in_use = $env{'user.domain'};
                   9454:                                 }
                   9455:                             }
1.1340    raeburn  9456:                         }
                   9457:                     }
                   9458:                     unless ($offload) {
                   9459:                         if (ref($domdefs{'offloadoth'}) eq 'HASH') {
                   9460:                             if ($domdefs{'offloadoth'}{$lonhost}) {
                   9461:                                 if (($env{'user.domain'} ne '') && ($env{'user.domain'} ne $dom_in_use) &&
                   9462:                                     (!(($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')))) {
                   9463:                                     unless (&Apache::lonnet::shared_institution($env{'user.domain'})) {
                   9464:                                         $offload = 1;
1.1352    raeburn  9465:                                         $offloadoth = 1;
1.1340    raeburn  9466:                                         $dom_in_use = $env{'user.domain'};
                   9467:                                     }
1.1210    raeburn  9468:                                 }
1.1340    raeburn  9469:                             }
                   9470:                         }
                   9471:                     }
                   9472:                     if ($offload) {
1.1358    raeburn  9473:                         my $newserver = &Apache::lonnet::spareserver(undef,30000,undef,1,$dom_in_use);
1.1352    raeburn  9474:                         if (($newserver eq '') && ($offloadoth)) {
                   9475:                             my @domains = &Apache::lonnet::current_machine_domains();
                   9476:                             if (($dom_in_use ne '') && (!grep(/^\Q$dom_in_use\E$/,@domains))) { 
                   9477:                                 ($newserver) = &Apache::lonnet::choose_server($dom_in_use);
                   9478:                             }
                   9479:                         }
1.1340    raeburn  9480:                         if (($newserver) && ($newserver ne $lonhost)) {
                   9481:                             my $numsec = 5;
                   9482:                             my $timeout = $numsec * 1000;
                   9483:                             my ($newurl,$locknum,%locks,$msg);
                   9484:                             if ($env{'request.role.adv'}) {
                   9485:                                 ($locknum,%locks) = &Apache::lonnet::get_locks();
                   9486:                             }
                   9487:                             my $disable_submit = 0;
                   9488:                             if ($requrl =~ /$LONCAPA::assess_re/) {
                   9489:                                 $disable_submit = 1;
                   9490:                             }
                   9491:                             if ($locknum) {
                   9492:                                 my @lockinfo = sort(values(%locks));
1.1354    raeburn  9493:                                 $msg = &mt('Once the following tasks are complete:')." \n".
1.1340    raeburn  9494:                                        join(", ",sort(values(%locks)))."\n";
                   9495:                                 if (&show_course()) {
                   9496:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Courses".');
                   9497:                                 } else {
                   9498:                                     $msg .= &mt('your session will be transferred to a different server, after you click "Roles".');
1.1210    raeburn  9499:                                 }
1.1340    raeburn  9500:                             } else {
                   9501:                                 if (($requrl =~ m{^/res/}) && ($env{'form.submitted'} =~ /^part_/)) {
                   9502:                                     $msg = &mt('Your LON-CAPA submission has been recorded')."\n";
                   9503:                                 }
                   9504:                                 $msg .= &mt('Your current LON-CAPA session will be transferred to a different server in [quant,_1,second].',$numsec);
                   9505:                                 $newurl = '/adm/switchserver?otherserver='.$newserver;
                   9506:                                 if (($env{'request.role'}) && ($env{'request.role'} ne 'cm')) {
                   9507:                                     $newurl .= '&role='.$env{'request.role'};
                   9508:                                 }
                   9509:                                 if ($env{'request.symb'}) {
                   9510:                                     my $shownsymb = &Apache::lonenc::check_encrypt($env{'request.symb'});
                   9511:                                     if ($shownsymb =~ m{^/enc/}) {
                   9512:                                         my $reqdmajor = 2;
                   9513:                                         my $reqdminor = 11;
                   9514:                                         my $reqdsubminor = 3;
                   9515:                                         my $newserverrev = &Apache::lonnet::get_server_loncaparev('',$newserver);
                   9516:                                         my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$newserver);
                   9517:                                         my ($major,$minor,$subminor) = ($remoterev =~ /^\'?(\d+)\.(\d+)\.(\d+|)[\w.\-]+\'?$/);
                   9518:                                         if (($major eq '' && $minor eq '') ||
                   9519:                                             (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)) ||
                   9520:                                             (($reqdmajor == $major) && ($reqdminor == $minor) && (($subminor eq '') ||
                   9521:                                              ($reqdsubminor > $subminor))))) {
                   9522:                                             undef($shownsymb);
                   9523:                                         }
1.1210    raeburn  9524:                                     }
1.1340    raeburn  9525:                                     if ($shownsymb) {
                   9526:                                         &js_escape(\$shownsymb);
                   9527:                                         $newurl .= '&symb='.$shownsymb;
1.1210    raeburn  9528:                                     }
1.1340    raeburn  9529:                                 } else {
                   9530:                                     my $shownurl = &Apache::lonenc::check_encrypt($requrl);
                   9531:                                     &js_escape(\$shownurl);
                   9532:                                     $newurl .= '&origurl='.$shownurl;
1.1210    raeburn  9533:                                 }
1.1340    raeburn  9534:                             }
                   9535:                             &js_escape(\$msg);
                   9536:                             $result.=<<OFFLOAD
1.1210    raeburn  9537: <meta http-equiv="pragma" content="no-cache" />
                   9538: <script type="text/javascript">
1.1215    raeburn  9539: // <![CDATA[
1.1210    raeburn  9540: function LC_Offload_Now() {
                   9541:     var dest = "$newurl";
                   9542:     if (dest != '') {
                   9543:         window.location.href="$newurl";
                   9544:     }
                   9545: }
1.1214    raeburn  9546: \$(document).ready(function () {
                   9547:     window.alert('$msg');
                   9548:     if ($disable_submit) {
1.1210    raeburn  9549:         \$(".LC_hwk_submit").prop("disabled", true);
                   9550:         \$( ".LC_textline" ).prop( "readonly", "readonly");
1.1214    raeburn  9551:     }
                   9552:     setTimeout('LC_Offload_Now()', $timeout);
                   9553: });
1.1215    raeburn  9554: // ]]>
1.1210    raeburn  9555: </script>
                   9556: OFFLOAD
                   9557:                         }
                   9558:                     }
                   9559:                 }
                   9560:             }
                   9561:         }
1.313     albertel 9562:     }
1.306     albertel 9563:     if (!defined($title)) {
                   9564: 	$title = 'The LearningOnline Network with CAPA';
                   9565:     }
1.460     albertel 9566:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   9567:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.1168    raeburn  9568: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'"';
                   9569:     if (!$args->{'frameset'}) {
                   9570:         $result .= ' /';
                   9571:     }
                   9572:     $result .= '>' 
1.1064    raeburn  9573:         .$inhibitprint
1.414     albertel 9574: 	.$head_extra;
1.1242    raeburn  9575:     my $clientmobile;
                   9576:     if (($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) {
                   9577:         (undef,undef,undef,undef,undef,undef,$clientmobile) = &decode_user_agent();
                   9578:     } else {
                   9579:         $clientmobile = $env{'browser.mobile'};
                   9580:     }
                   9581:     if ($clientmobile) {
1.1137    raeburn  9582:         $result .= '
                   9583: <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=0, minimum-scale=1.0, maximum-scale=1.0">
                   9584: <meta name="apple-mobile-web-app-capable" content="yes" />';
                   9585:     }
1.1278    raeburn  9586:     $result .= '<meta name="google" content="notranslate" />'."\n";
1.962     droeschl 9587:     return $result.'</head>';
1.306     albertel 9588: }
                   9589: 
                   9590: =pod
                   9591: 
1.340     albertel 9592: =item * &font_settings()
                   9593: 
                   9594: Returns neccessary <meta> to set the proper encoding
                   9595: 
1.1160    raeburn  9596: Inputs: optional reference to HASH -- $args passed to &headtag()
1.340     albertel 9597: 
                   9598: =cut
                   9599: 
                   9600: sub font_settings {
1.1160    raeburn  9601:     my ($args) = @_;
1.340     albertel 9602:     my $headerstring='';
1.1160    raeburn  9603:     if ((!$env{'browser.mathml'} && $env{'browser.unicode'}) ||
                   9604:         ((ref($args) eq 'HASH') && ($args->{'browser.unicode'}))) {
1.1168    raeburn  9605:         $headerstring.=
                   9606:             '<meta http-equiv="Content-Type" content="text/html; charset=utf-8"';
                   9607:         if (!$args->{'frameset'}) {
                   9608: 	    $headerstring.= ' /';
                   9609:         }
                   9610: 	$headerstring .= '>'."\n";
1.340     albertel 9611:     }
                   9612:     return $headerstring;
                   9613: }
                   9614: 
1.341     albertel 9615: =pod
                   9616: 
1.1064    raeburn  9617: =item * &print_suppression()
                   9618: 
                   9619: In course context returns css which causes the body to be blank when media="print",
                   9620: if printout generation is unavailable for the current resource.
                   9621: 
                   9622: This could be because:
                   9623: 
                   9624: (a) printstartdate is in the future
                   9625: 
                   9626: (b) printenddate is in the past
                   9627: 
                   9628: (c) there is an active exam block with "printout"
                   9629: functionality blocked
                   9630: 
                   9631: Users with pav, pfo or evb privileges are exempt.
                   9632: 
                   9633: Inputs: none
                   9634: 
                   9635: =cut
                   9636: 
                   9637: 
                   9638: sub print_suppression {
                   9639:     my $noprint;
                   9640:     if ($env{'request.course.id'}) {
                   9641:         my $scope = $env{'request.course.id'};
                   9642:         if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   9643:             (&Apache::lonnet::allowed('pfo',$scope))) {
                   9644:             return;
                   9645:         }
                   9646:         if ($env{'request.course.sec'} ne '') {
                   9647:             $scope .= "/$env{'request.course.sec'}";
                   9648:             if ((&Apache::lonnet::allowed('pav',$scope)) ||
                   9649:                 (&Apache::lonnet::allowed('pfo',$scope))) {
1.1065    raeburn  9650:                 return;
1.1064    raeburn  9651:             }
                   9652:         }
                   9653:         my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9654:         my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372    raeburn  9655:         my $clientip = &Apache::lonnet::get_requestor_ip();
                   9656:         my $blocked = &blocking_status('printout',$clientip,$cnum,$cdom,undef,1);
1.1064    raeburn  9657:         if ($blocked) {
                   9658:             my $checkrole = "cm./$cdom/$cnum";
                   9659:             if ($env{'request.course.sec'} ne '') {
                   9660:                 $checkrole .= "/$env{'request.course.sec'}";
                   9661:             }
                   9662:             unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   9663:                     ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   9664:                 $noprint = 1;
                   9665:             }
                   9666:         }
                   9667:         unless ($noprint) {
                   9668:             my $symb = &Apache::lonnet::symbread();
                   9669:             if ($symb ne '') {
                   9670:                 my $navmap = Apache::lonnavmaps::navmap->new();
                   9671:                 if (ref($navmap)) {
                   9672:                     my $res = $navmap->getBySymb($symb);
                   9673:                     if (ref($res)) {
                   9674:                         if (!$res->resprintable()) {
                   9675:                             $noprint = 1;
                   9676:                         }
                   9677:                     }
                   9678:                 }
                   9679:             }
                   9680:         }
                   9681:         if ($noprint) {
                   9682:             return <<"ENDSTYLE";
                   9683: <style type="text/css" media="print">
                   9684:     body { display:none }
                   9685: </style>
                   9686: ENDSTYLE
                   9687:         }
                   9688:     }
                   9689:     return;
                   9690: }
                   9691: 
                   9692: =pod
                   9693: 
1.341     albertel 9694: =item * &xml_begin()
                   9695: 
                   9696: Returns the needed doctype and <html>
                   9697: 
                   9698: Inputs: none
                   9699: 
                   9700: =cut
                   9701: 
                   9702: sub xml_begin {
1.1168    raeburn  9703:     my ($is_frameset) = @_;
1.341     albertel 9704:     my $output='';
                   9705: 
                   9706:     if ($env{'browser.mathml'}) {
                   9707: 	$output='<?xml version="1.0"?>'
                   9708:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   9709: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   9710:             
                   9711: #	    .'<!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">] >'
                   9712: 	    .'<!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">'
                   9713:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   9714: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
1.1168    raeburn  9715:     } elsif ($is_frameset) {
                   9716:         $output='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'."\n".
                   9717:                 '<html>'."\n";
1.341     albertel 9718:     } else {
1.1168    raeburn  9719: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'."\n".
                   9720:                 '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'."\n";
1.341     albertel 9721:     }
                   9722:     return $output;
                   9723: }
1.340     albertel 9724: 
                   9725: =pod
                   9726: 
1.306     albertel 9727: =item * &start_page()
                   9728: 
                   9729: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   9730: 
1.648     raeburn  9731: Inputs:
                   9732: 
                   9733: =over 4
                   9734: 
                   9735: $title - optional title for the page
                   9736: 
                   9737: $head_extra - optional extra HTML to incude inside the <head>
                   9738: 
                   9739: $args - additional optional args supported are:
                   9740: 
                   9741: =over 8
                   9742: 
                   9743:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 9744:                                     arg on
1.814     bisitz   9745:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  9746:              add_entries    -> additional attributes to add to the  <body>
                   9747:              domain         -> force to color decorate a page for a 
1.317     albertel 9748:                                     specific domain
1.648     raeburn  9749:              function       -> force usage of a specific rolish color
1.317     albertel 9750:                                     scheme
1.648     raeburn  9751:              redirect       -> see &headtag()
                   9752:              bgcolor        -> override the default page bg color
                   9753:              js_ready       -> return a string ready for being used in 
1.317     albertel 9754:                                     a javascript writeln
1.648     raeburn  9755:              html_encode    -> return a string ready for being used in 
1.320     albertel 9756:                                     a html attribute
1.648     raeburn  9757:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 9758:                                     $forcereg arg
1.648     raeburn  9759:              frameset       -> if true will start with a <frameset>
1.330     albertel 9760:                                     rather than <body>
1.648     raeburn  9761:              skip_phases    -> hash ref of 
1.338     albertel 9762:                                     head -> skip the <html><head> generation
                   9763:                                     body -> skip all <body> generation
1.648     raeburn  9764:              no_auto_mt_title -> prevent &mt()ing the title arg
1.867     kalberla 9765:              bread_crumbs ->             Array containing breadcrumbs
1.983     raeburn  9766:              bread_crumbs_component ->  if exists show it as headline else show only the breadcrumbs
1.1272    raeburn  9767:              bread_crumbs_nomenu -> if true will pass false as the value of $menulink
                   9768:                                     to lonhtmlcommon::breadcrumbs
1.1096    raeburn  9769:              group          -> includes the current group, if page is for a 
1.1274    raeburn  9770:                                specific group
                   9771:              use_absolute   -> for request for external resource or syllabus, this
                   9772:                                will contain https://<hostname> if server uses
                   9773:                                https (as per hosts.tab), but request is for http
                   9774:              hostname       -> hostname, originally from $r->hostname(), (optional).
1.1369    raeburn  9775:              links_disabled -> Links in primary and secondary menus are disabled
                   9776:                                (Can enable them once page has loaded - see lonroles.pm
                   9777:                                for an example).
1.1380    raeburn  9778:              links_target   -> Target for links, e.g., _parent (optional).
1.361     albertel 9779: 
1.648     raeburn  9780: =back
1.460     albertel 9781: 
1.648     raeburn  9782: =back
1.562     albertel 9783: 
1.306     albertel 9784: =cut
                   9785: 
                   9786: sub start_page {
1.309     albertel 9787:     my ($title,$head_extra,$args) = @_;
1.318     albertel 9788:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.319     albertel 9789: 
1.315     albertel 9790:     $env{'internal.start_page'}++;
1.1359    raeburn  9791:     my ($result,@advtools,$ltiscope,$ltiuri,%ltimenu,$menucoll,%menu);
1.964     droeschl 9792: 
1.338     albertel 9793:     if (! exists($args->{'skip_phases'}{'head'}) ) {
1.1168    raeburn  9794:         $result .= &xml_begin($args->{'frameset'}) . &headtag($title, $head_extra, $args);
1.338     albertel 9795:     }
1.1316    raeburn  9796: 
                   9797:     if (($env{'request.course.id'}) && ($env{'request.lti.login'})) {
1.1318    raeburn  9798:         if ($env{'course.'.$env{'request.course.id'}.'.lti.override'}) {
                   9799:             unless ($env{'course.'.$env{'request.course.id'}.'.lti.topmenu'}) {
                   9800:                 $args->{'no_primary_menu'} = 1;
                   9801:             }
                   9802:             unless ($env{'course.'.$env{'request.course.id'}.'.lti.inlinemenu'}) {
                   9803:                 $args->{'no_inline_menu'} = 1;
                   9804:             }
                   9805:             if ($env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'}) {
                   9806:                 map { $ltimenu{$_} = 1; } split(/,/,$env{'course.'.$env{'request.course.id'}.'.lti.lcmenu'});
                   9807:             }
                   9808:         } else {
                   9809:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9810:             my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
                   9811:             if (ref($lti{$env{'request.lti.login'}}) eq 'HASH') {
                   9812:                 unless ($lti{$env{'request.lti.login'}}{'topmenu'}) {
                   9813:                     $args->{'no_primary_menu'} = 1;
                   9814:                 }
                   9815:                 unless ($lti{$env{'request.lti.login'}}{'inlinemenu'}) {
                   9816:                     $args->{'no_inline_menu'} = 1;
                   9817:                 }
                   9818:                 if (ref($lti{$env{'request.lti.login'}}{'lcmenu'}) eq 'ARRAY') {
                   9819:                     map { $ltimenu{$_} = 1; } @{$lti{$env{'request.lti.login'}}{'lcmenu'}};
                   9820:                 }
                   9821:             }
                   9822:         }
1.1316    raeburn  9823:         ($ltiscope,$ltiuri) = &LONCAPA::ltiutils::lti_provider_scope($env{'request.lti.uri'},
                   9824:                                   $env{'course.'.$env{'request.course.id'}.'.domain'},
                   9825:                                   $env{'course.'.$env{'request.course.id'}.'.num'});
1.1359    raeburn  9826:     } elsif ($env{'request.course.id'}) {
                   9827:         my $expiretime=600;
                   9828:         if ((time-$env{'course.'.$env{'request.course.id'}.'.last_cache'}) > $expiretime) {
                   9829:             &Apache::lonnet::coursedescription($env{'request.course.id'},{'freshen_cache' => 1});
                   9830:         }
                   9831:         my ($deeplinkmenu,$menuref);
                   9832:         ($menucoll,$deeplinkmenu,$menuref) = &menucoll_in_effect();
                   9833:         if ($menucoll) {
                   9834:             if (ref($menuref) eq 'HASH') {
                   9835:                 %menu = %{$menuref};
                   9836:             }
                   9837:             if ($menu{'top'} eq 'n') {
                   9838:                 $args->{'no_primary_menu'} = 1;
                   9839:             }
                   9840:             if ($menu{'inline'} eq 'n') {
                   9841:                 unless (&Apache::lonnet::allowed('opa')) {
                   9842:                     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9843:                     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   9844:                     my $crstype = &course_type();
                   9845:                     my $now = time;
                   9846:                     my $ccrole;
                   9847:                     if ($crstype eq 'Community') {
                   9848:                         $ccrole = 'co';
                   9849:                     } else {
                   9850:                         $ccrole = 'cc';
                   9851:                     }
                   9852:                     if ($env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum}) {
                   9853:                         my ($start,$end) = split(/\./,$env{'user.role.'.$ccrole.'./'.$cdom.'/'.$cnum});
                   9854:                         if ((($start) && ($start<0)) ||
                   9855:                             (($end) && ($end<$now))  ||
                   9856:                             (($start) && ($now<$start))) {
                   9857:                             $args->{'no_inline_menu'} = 1;
                   9858:                         }
                   9859:                     } else {
                   9860:                         $args->{'no_inline_menu'} = 1;
                   9861:                     }
                   9862:                 }
                   9863:             }
                   9864:         }
1.1316    raeburn  9865:     }
1.1359    raeburn  9866: 
1.1385    raeburn  9867:     my $showncrumbs;
1.338     albertel 9868:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   9869: 	if ($args->{'frameset'}) {
                   9870: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   9871: 						$args->{'add_entries'});
                   9872: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   9873:         } else {
                   9874:             $result .=
                   9875:                 &bodytag($title, 
                   9876:                          $args->{'function'},       $args->{'add_entries'},
                   9877:                          $args->{'only_body'},      $args->{'domain'},
                   9878:                          $args->{'force_register'}, $args->{'no_nav_bar'},
1.1096    raeburn  9879:                          $args->{'bgcolor'},        $args,
1.1385    raeburn  9880:                          \@advtools,$ltiscope,$ltiuri,\%ltimenu,$menucoll,
                   9881:                          \%menu,\$showncrumbs);
1.831     bisitz   9882:         }
1.330     albertel 9883:     }
1.338     albertel 9884: 
1.315     albertel 9885:     if ($args->{'js_ready'}) {
1.713     kaisler  9886: 		$result = &js_ready($result);
1.315     albertel 9887:     }
1.320     albertel 9888:     if ($args->{'html_encode'}) {
1.713     kaisler  9889: 		$result = &html_encode($result);
                   9890:     }
                   9891: 
1.813     bisitz   9892:     # Preparation for new and consistent functionlist at top of screen
                   9893:     # if ($args->{'functionlist'}) {
                   9894:     #            $result .= &build_functionlist();
                   9895:     #}
                   9896: 
1.964     droeschl 9897:     # Don't add anything more if only_body wanted or in const space
                   9898:     return $result if    $args->{'only_body'} 
                   9899:                       || $env{'request.state'} eq 'construct';
1.813     bisitz   9900: 
                   9901:     #Breadcrumbs
1.758     kaisler  9902:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
1.1385    raeburn  9903:         unless ($showncrumbs) {
1.758     kaisler  9904: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   9905: 		#if any br links exists, add them to the breadcrumbs
                   9906: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   9907: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   9908: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   9909: 			}
                   9910: 		}
1.1096    raeburn  9911:                 # if @advtools array contains items add then to the breadcrumbs
                   9912:                 if (@advtools > 0) {
                   9913:                     &Apache::lonmenu::advtools_crumbs(@advtools);
                   9914:                 }
1.1272    raeburn  9915:                 my $menulink;
                   9916:                 # if arg: bread_crumbs_nomenu is true pass 0 as $menulink item.
                   9917:                 if ((exists($args->{'bread_crumbs_nomenu'})) ||
1.1312    raeburn  9918:                      ($ltiscope eq 'map') || ($ltiscope eq 'resource') ||
1.1272    raeburn  9919:                      ((($args->{'crstype'} eq 'Placement') || (($env{'request.course.id'}) &&
                   9920:                      ($env{'course.'.$env{'request.course.id'}.'.type'} eq 'Placement'))) &&
                   9921:                      (!$env{'request.role.adv'}))) {
                   9922:                     $menulink = 0;
                   9923:                 } else {
                   9924:                     undef($menulink);
                   9925:                 }
1.1385    raeburn  9926:                 my $linkprotout;
                   9927:                 if ($env{'request.deeplink.login'}) {
                   9928:                     my $linkprotout = &Apache::lonmenu::linkprot_exit();
                   9929:                     if ($linkprotout) {
                   9930:                         &Apache::lonhtmlcommon::add_breadcrumb_tool('tools',$linkprotout);
                   9931:                     }
                   9932:                 }
1.758     kaisler  9933: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   9934: 		if(exists($args->{'bread_crumbs_component'})){
1.1272    raeburn  9935: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'},'',$menulink);
1.1237    raeburn  9936:                 } else {
1.1272    raeburn  9937: 			$result .= &Apache::lonhtmlcommon::breadcrumbs('','',$menulink);
1.758     kaisler  9938: 		}
1.1385    raeburn  9939:         }
1.320     albertel 9940:     }
1.315     albertel 9941:     return $result;
1.306     albertel 9942: }
                   9943: 
                   9944: sub end_page {
1.315     albertel 9945:     my ($args) = @_;
                   9946:     $env{'internal.end_page'}++;
1.330     albertel 9947:     my $result;
1.335     albertel 9948:     if ($args->{'discussion'}) {
                   9949: 	my ($target,$parser);
                   9950: 	if (ref($args->{'discussion'})) {
                   9951: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   9952: 				$args->{'discussion'}{'parser'});
                   9953: 	}
                   9954: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   9955:     }
1.330     albertel 9956:     if ($args->{'frameset'}) {
                   9957: 	$result .= '</frameset>';
                   9958:     } else {
1.635     raeburn  9959: 	$result .= &endbodytag($args);
1.330     albertel 9960:     }
1.1080    raeburn  9961:     unless ($args->{'notbody'}) {
                   9962:         $result .= "\n</html>";
                   9963:     }
1.330     albertel 9964: 
1.315     albertel 9965:     if ($args->{'js_ready'}) {
1.317     albertel 9966: 	$result = &js_ready($result);
1.315     albertel 9967:     }
1.335     albertel 9968: 
1.320     albertel 9969:     if ($args->{'html_encode'}) {
                   9970: 	$result = &html_encode($result);
                   9971:     }
1.335     albertel 9972: 
1.315     albertel 9973:     return $result;
                   9974: }
                   9975: 
1.1359    raeburn  9976: sub menucoll_in_effect {
                   9977:     my ($menucoll,$deeplinkmenu,%menu);
                   9978:     if ($env{'request.course.id'}) {
                   9979:         $menucoll = $env{'course.'.$env{'request.course.id'}.'.menudefault'};
1.1362    raeburn  9980:         if ($env{'request.deeplink.login'}) {
1.1370    raeburn  9981:             my ($deeplink_symb,$deeplink,$check_login_symb);
1.1362    raeburn  9982:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   9983:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   9984:             if ($env{'request.noversionuri'} =~ m{^/(res|uploaded)/}) {
                   9985:                 if ($env{'request.noversionuri'} =~ /\.(page|sequence)$/) {
                   9986:                     my $navmap = Apache::lonnavmaps::navmap->new();
                   9987:                     if (ref($navmap)) {
                   9988:                         $deeplink = $navmap->get_mapparam(undef,
                   9989:                                                           &Apache::lonnet::declutter($env{'request.noversionuri'}),
                   9990:                                                           '0.deeplink');
1.1370    raeburn  9991:                     } else {
                   9992:                         $check_login_symb = 1;
1.1362    raeburn  9993:                     }
                   9994:                 } else {
1.1370    raeburn  9995:                     my $symb = &Apache::lonnet::symbread();
                   9996:                     if ($symb) {
                   9997:                         $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$symb);
                   9998:                     } else {
                   9999:                         $check_login_symb = 1;
                   10000:                     }
1.1362    raeburn  10001:                 }
                   10002:             } else {
1.1370    raeburn  10003:                 $check_login_symb = 1;
                   10004:             }
                   10005:             if ($check_login_symb) {
1.1362    raeburn  10006:                 $deeplink_symb = &deeplink_login_symb($cnum,$cdom);
                   10007:                 if ($deeplink_symb =~ /\.(page|sequence)$/) {
                   10008:                     my $mapname = &Apache::lonnet::deversion((&Apache::lonnet::decode_symb($deeplink_symb))[2]);
                   10009:                     my $navmap = Apache::lonnavmaps::navmap->new();
                   10010:                     if (ref($navmap)) {
                   10011:                         $deeplink = $navmap->get_mapparam(undef,$mapname,'0.deeplink');
                   10012:                     }
                   10013:                 } else {
                   10014:                     $deeplink = &Apache::lonnet::EXT('resource.0.deeplink',$deeplink_symb);
                   10015:                 }
                   10016:             }
1.1359    raeburn  10017:             if ($deeplink ne '') {
1.1378    raeburn  10018:                 my ($state,$others,$listed,$scope,$protect,$display,$target) = split(/,/,$deeplink);
1.1359    raeburn  10019:                 if ($display =~ /^\d+$/) {
                   10020:                     $deeplinkmenu = 1;
                   10021:                     $menucoll = $display;
                   10022:                 }
                   10023:             }
                   10024:         }
                   10025:         if ($menucoll) {
                   10026:             %menu = &page_menu($env{'course.'.$env{'request.course.id'}.'.menucollections'},$menucoll);
                   10027:         }
                   10028:     }
                   10029:     return ($menucoll,$deeplinkmenu,\%menu);
                   10030: }
                   10031: 
1.1362    raeburn  10032: sub deeplink_login_symb {
                   10033:     my ($cnum,$cdom) = @_;
                   10034:     my $login_symb;
                   10035:     if ($env{'request.deeplink.login'}) {
1.1364    raeburn  10036:         $login_symb = &symb_from_tinyurl($env{'request.deeplink.login'},$cnum,$cdom);
                   10037:     }
                   10038:     return $login_symb;
                   10039: }
                   10040: 
                   10041: sub symb_from_tinyurl {
                   10042:     my ($url,$cnum,$cdom) = @_;
                   10043:     if ($url =~ m{^\Q/tiny/$cdom/\E(\w+)$}) {
                   10044:         my $key = $1;
                   10045:         my ($tinyurl,$login);
                   10046:         my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$cdom."\0".$key);
                   10047:         if (defined($cached)) {
                   10048:             $tinyurl = $result;
                   10049:         } else {
                   10050:             my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   10051:             my %currtiny = &Apache::lonnet::get('tiny',[$key],$cdom,$configuname);
                   10052:             if ($currtiny{$key} ne '') {
                   10053:                 $tinyurl = $currtiny{$key};
                   10054:                 &Apache::lonnet::do_cache_new('tiny',$cdom."\0".$key,$currtiny{$key},600);
1.1362    raeburn  10055:             }
1.1364    raeburn  10056:         }
                   10057:         if ($tinyurl ne '') {
                   10058:             my ($cnumreq,$symb) = split(/\&/,$tinyurl);
                   10059:             if (wantarray) {
                   10060:                 return ($cnumreq,$symb);
                   10061:             } elsif ($cnumreq eq $cnum) {
                   10062:                 return $symb;
1.1362    raeburn  10063:             }
                   10064:         }
                   10065:     }
1.1364    raeburn  10066:     if (wantarray) {
                   10067:         return ();
                   10068:     } else {
                   10069:         return;
                   10070:     }
1.1362    raeburn  10071: }
                   10072: 
1.1405    raeburn  10073: sub usable_exttools {
                   10074:     my %tooltypes;
                   10075:     if ($env{'request.course.id'}) {
                   10076:         if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'}) {
                   10077:            if ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'both') {
                   10078:                %tooltypes = (
                   10079:                              crs => 1,
                   10080:                              dom => 1,
                   10081:                             );
                   10082:            } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'crs') {
                   10083:                $tooltypes{'crs'} = 1;
                   10084:            } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.exttool'} eq 'dom') {
                   10085:                $tooltypes{'dom'} = 1;
                   10086:            }
                   10087:         } else {
                   10088:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   10089:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   10090:             my $crstype = lc($env{'course.'.$env{'request.course.id'}.'.type'});
                   10091:             if ($crstype eq '') {
                   10092:                 $crstype = 'course';
                   10093:             }
                   10094:             if ($crstype eq 'course') {
                   10095:                 if ($env{'course.'.$env{'request.course.id'}.'internal.coursecode'}) {
                   10096:                     $crstype = 'official';
                   10097:                 } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.textbook'}) {
                   10098:                     $crstype = 'textbook';
                   10099:                 } elsif ($env{'course.'.$env{'request.course.id'}.'.internal.lti'}) {
                   10100:                     $crstype = 'lti';
                   10101:                 } else {
                   10102:                     $crstype = 'unofficial';
                   10103:                 }
                   10104:             }
                   10105:             my %domdefaults = &Apache::lonnet::get_domain_defaults($cdom);
                   10106:             if ($domdefaults{$crstype.'domexttool'}) {
                   10107:                 $tooltypes{'dom'} = 1;
                   10108:             }
                   10109:             if ($domdefaults{$crstype.'exttool'}) {
                   10110:                 $tooltypes{'crs'} = 1;
                   10111:             }
                   10112:         }
                   10113:     }
                   10114:     return %tooltypes;
                   10115: }
                   10116: 
1.1034    www      10117: sub wishlist_window {
                   10118:     return(<<'ENDWISHLIST');
1.1046    raeburn  10119: <script type="text/javascript">
1.1034    www      10120: // <![CDATA[
                   10121: // <!-- BEGIN LON-CAPA Internal
                   10122: function set_wishlistlink(title, path) {
                   10123:     if (!title) {
                   10124:         title = document.title;
                   10125:         title = title.replace(/^LON-CAPA /,'');
                   10126:     }
1.1175    raeburn  10127:     title = encodeURIComponent(title);
1.1203    raeburn  10128:     title = title.replace("'","\\\'");
1.1034    www      10129:     if (!path) {
                   10130:         path = location.pathname;
                   10131:     }
1.1175    raeburn  10132:     path = encodeURIComponent(path);
1.1203    raeburn  10133:     path = path.replace("'","\\\'");
1.1034    www      10134:     Win = window.open('/adm/wishlist?mode=newLink&setTitle='+title+'&setPath='+path,
                   10135:                       'wishlistNewLink','width=560,height=350,scrollbars=0');
                   10136: }
                   10137: // END LON-CAPA Internal -->
                   10138: // ]]>
                   10139: </script>
                   10140: ENDWISHLIST
                   10141: }
                   10142: 
1.1030    www      10143: sub modal_window {
                   10144:     return(<<'ENDMODAL');
1.1046    raeburn  10145: <script type="text/javascript">
1.1030    www      10146: // <![CDATA[
                   10147: // <!-- BEGIN LON-CAPA Internal
                   10148: var modalWindow = {
                   10149: 	parent:"body",
                   10150: 	windowId:null,
                   10151: 	content:null,
                   10152: 	width:null,
                   10153: 	height:null,
                   10154: 	close:function()
                   10155: 	{
                   10156: 	        $(".LCmodal-window").remove();
                   10157: 	        $(".LCmodal-overlay").remove();
                   10158: 	},
                   10159: 	open:function()
                   10160: 	{
                   10161: 		var modal = "";
                   10162: 		modal += "<div class=\"LCmodal-overlay\"></div>";
                   10163: 		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;\">";
                   10164: 		modal += this.content;
                   10165: 		modal += "</div>";	
                   10166: 
                   10167: 		$(this.parent).append(modal);
                   10168: 
                   10169: 		$(".LCmodal-window").append("<a class=\"LCclose-window\"></a>");
                   10170: 		$(".LCclose-window").click(function(){modalWindow.close();});
                   10171: 		$(".LCmodal-overlay").click(function(){modalWindow.close();});
                   10172: 	}
                   10173: };
1.1140    raeburn  10174: 	var openMyModal = function(source,width,height,scrolling,transparency,style)
1.1030    www      10175: 	{
1.1266    raeburn  10176:                 source = source.replace(/'/g,"&#39;");
1.1030    www      10177: 		modalWindow.windowId = "myModal";
                   10178: 		modalWindow.width = width;
                   10179: 		modalWindow.height = height;
1.1196    raeburn  10180: 		modalWindow.content = "<iframe width='"+width+"' height='"+height+"' frameborder='0' scrolling='"+scrolling+"' allowtransparency='"+transparency+"' src='" + source + "' style='"+style+"'></iframe>";
1.1030    www      10181: 		modalWindow.open();
1.1208    raeburn  10182: 	};
1.1030    www      10183: // END LON-CAPA Internal -->
                   10184: // ]]>
                   10185: </script>
                   10186: ENDMODAL
                   10187: }
                   10188: 
                   10189: sub modal_link {
1.1140    raeburn  10190:     my ($link,$linktext,$width,$height,$target,$scrolling,$title,$transparency,$style)=@_;
1.1030    www      10191:     unless ($width) { $width=480; }
                   10192:     unless ($height) { $height=400; }
1.1031    www      10193:     unless ($scrolling) { $scrolling='yes'; }
1.1140    raeburn  10194:     unless ($transparency) { $transparency='true'; }
                   10195: 
1.1074    raeburn  10196:     my $target_attr;
                   10197:     if (defined($target)) {
                   10198:         $target_attr = 'target="'.$target.'"';
                   10199:     }
                   10200:     return <<"ENDLINK";
1.1336    raeburn  10201: <a href="$link" $target_attr title="$title" onclick="javascript:openMyModal('$link',$width,$height,'$scrolling','$transparency','$style'); return false;">$linktext</a>
1.1074    raeburn  10202: ENDLINK
1.1030    www      10203: }
                   10204: 
1.1032    www      10205: sub modal_adhoc_script {
1.1365    raeburn  10206:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
                   10207:     my $mathjax;
                   10208:     if ($possmathjax) {
                   10209:         $mathjax = <<'ENDJAX';
                   10210:                if (typeof MathJax == 'object') {
                   10211:                    MathJax.Hub.Queue(["Typeset",MathJax.Hub]);
                   10212:                }
                   10213: ENDJAX
                   10214:     }
1.1032    www      10215:     return (<<ENDADHOC);
1.1046    raeburn  10216: <script type="text/javascript">
1.1032    www      10217: // <![CDATA[
                   10218:         var $funcname = function()
                   10219:         {
                   10220:                 modalWindow.windowId = "myModal";
                   10221:                 modalWindow.width = $width;
                   10222:                 modalWindow.height = $height;
                   10223:                 modalWindow.content = '$content';
                   10224:                 modalWindow.open();
1.1365    raeburn  10225:                 $mathjax
1.1032    www      10226:         };  
                   10227: // ]]>
                   10228: </script>
                   10229: ENDADHOC
                   10230: }
                   10231: 
1.1041    www      10232: sub modal_adhoc_inner {
1.1365    raeburn  10233:     my ($funcname,$width,$height,$content,$possmathjax)=@_;
1.1041    www      10234:     my $innerwidth=$width-20;
                   10235:     $content=&js_ready(
1.1140    raeburn  10236:                  &start_page('Dialog',undef,{'only_body'=>1,'bgcolor'=>'#FFFFFF'}).
                   10237:                  &start_scrollbox($width.'px',$innerwidth.'px',$height.'px','myModal','#FFFFFF',undef,1).
                   10238:                  $content.
1.1041    www      10239:                  &end_scrollbox().
1.1140    raeburn  10240:                  &end_page()
1.1041    www      10241:              );
1.1365    raeburn  10242:     return &modal_adhoc_script($funcname,$width,$height,$content,$possmathjax);
1.1041    www      10243: }
                   10244: 
                   10245: sub modal_adhoc_window {
1.1365    raeburn  10246:     my ($funcname,$width,$height,$content,$linktext,$possmathjax)=@_;
                   10247:     return &modal_adhoc_inner($funcname,$width,$height,$content,$possmathjax).
1.1041    www      10248:            "<a href=\"javascript:$funcname();void(0);\">".$linktext."</a>";
                   10249: }
                   10250: 
                   10251: sub modal_adhoc_launch {
                   10252:     my ($funcname,$width,$height,$content)=@_;
                   10253:     return &modal_adhoc_inner($funcname,$width,$height,$content).(<<ENDLAUNCH);
                   10254: <script type="text/javascript">
                   10255: // <![CDATA[
                   10256: $funcname();
                   10257: // ]]>
                   10258: </script>
                   10259: ENDLAUNCH
                   10260: }
                   10261: 
                   10262: sub modal_adhoc_close {
                   10263:     return (<<ENDCLOSE);
                   10264: <script type="text/javascript">
                   10265: // <![CDATA[
                   10266: modalWindow.close();
                   10267: // ]]>
                   10268: </script>
                   10269: ENDCLOSE
                   10270: }
                   10271: 
1.1038    www      10272: sub togglebox_script {
                   10273:    return(<<ENDTOGGLE);
                   10274: <script type="text/javascript"> 
                   10275: // <![CDATA[
                   10276: function LCtoggleDisplay(id,hidetext,showtext) {
                   10277:    link = document.getElementById(id + "link").childNodes[0];
                   10278:    with (document.getElementById(id).style) {
                   10279:       if (display == "none" ) {
                   10280:           display = "inline";
                   10281:           link.nodeValue = hidetext;
                   10282:         } else {
                   10283:           display = "none";
                   10284:           link.nodeValue = showtext;
                   10285:        }
                   10286:    }
                   10287: }
                   10288: // ]]>
                   10289: </script>
                   10290: ENDTOGGLE
                   10291: }
                   10292: 
1.1039    www      10293: sub start_togglebox {
                   10294:     my ($id,$heading,$headerbg,$hidetext,$showtext)=@_;
                   10295:     unless ($heading) { $heading=''; } else { $heading.=' '; }
                   10296:     unless ($showtext) { $showtext=&mt('show'); }
                   10297:     unless ($hidetext) { $hidetext=&mt('hide'); }
                   10298:     unless ($headerbg) { $headerbg='#FFFFFF'; }
                   10299:     return &start_data_table().
                   10300:            &start_data_table_header_row().
                   10301:            '<td bgcolor="'.$headerbg.'">'.$heading.
                   10302:            '[<a id="'.$id.'link" href="javascript:LCtoggleDisplay(\''.$id.'\',\''.$hidetext.'\',\''.
                   10303:            $showtext.'\')">'.$showtext.'</a>]</td>'.
                   10304:            &end_data_table_header_row().
                   10305:            '<tr id="'.$id.'" style="display:none""><td>';
                   10306: }
                   10307: 
                   10308: sub end_togglebox {
                   10309:     return '</td></tr>'.&end_data_table();
                   10310: }
                   10311: 
1.1041    www      10312: sub LCprogressbar_script {
1.1302    raeburn  10313:    my ($id,$number_to_do)=@_;
                   10314:    if ($number_to_do) {
                   10315:        return(<<ENDPROGRESS);
1.1041    www      10316: <script type="text/javascript">
                   10317: // <![CDATA[
1.1045    www      10318: \$('#progressbar$id').progressbar({
1.1041    www      10319:   value: 0,
                   10320:   change: function(event, ui) {
                   10321:     var newVal = \$(this).progressbar('option', 'value');
                   10322:     \$('.pblabel', this).text(LCprogressTxt);
                   10323:   }
                   10324: });
                   10325: // ]]>
                   10326: </script>
                   10327: ENDPROGRESS
1.1302    raeburn  10328:    } else {
                   10329:        return(<<ENDPROGRESS);
                   10330: <script type="text/javascript">
                   10331: // <![CDATA[
                   10332: \$('#progressbar$id').progressbar({
                   10333:   value: false,
                   10334:   create: function(event, ui) {
                   10335:     \$('.ui-widget-header', this).css({'background':'#F0F0F0'});
                   10336:     \$('.ui-progressbar-overlay', this).css({'margin':'0'});
                   10337:   }
                   10338: });
                   10339: // ]]>
                   10340: </script>
                   10341: ENDPROGRESS
                   10342:    }
1.1041    www      10343: }
                   10344: 
                   10345: sub LCprogressbarUpdate_script {
                   10346:    return(<<ENDPROGRESSUPDATE);
                   10347: <style type="text/css">
                   10348: .ui-progressbar { position:relative; }
1.1302    raeburn  10349: .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      10350: .pblabel { position: absolute; width: 100%; text-align: center; line-height: 1.9em; }
                   10351: </style>
                   10352: <script type="text/javascript">
                   10353: // <![CDATA[
1.1045    www      10354: var LCprogressTxt='---';
                   10355: 
1.1302    raeburn  10356: function LCupdateProgress(percent,progresstext,id,maxnum) {
1.1041    www      10357:    LCprogressTxt=progresstext;
1.1302    raeburn  10358:    if ((maxnum == '') || (maxnum == undefined) || (maxnum == null)) {
                   10359:        \$('#progressbar'+id).find('.progress-label').text(LCprogressTxt);
                   10360:    } else if (percent === \$('#progressbar'+id).progressbar( "value" )) {
1.1301    raeburn  10361:        \$('#progressbar'+id).find('.pblabel').text(LCprogressTxt);
                   10362:    } else {
                   10363:        \$('#progressbar'+id).progressbar('value',percent);
                   10364:    }
1.1041    www      10365: }
                   10366: // ]]>
                   10367: </script>
                   10368: ENDPROGRESSUPDATE
                   10369: }
                   10370: 
1.1042    www      10371: my $LClastpercent;
1.1045    www      10372: my $LCidcnt;
                   10373: my $LCcurrentid;
1.1042    www      10374: 
1.1041    www      10375: sub LCprogressbar {
1.1302    raeburn  10376:     my ($r,$number_to_do,$preamble)=@_;
1.1042    www      10377:     $LClastpercent=0;
1.1045    www      10378:     $LCidcnt++;
                   10379:     $LCcurrentid=$$.'_'.$LCidcnt;
1.1302    raeburn  10380:     my ($starting,$content);
                   10381:     if ($number_to_do) {
                   10382:         $starting=&mt('Starting');
                   10383:         $content=(<<ENDPROGBAR);
                   10384: $preamble
1.1045    www      10385:   <div id="progressbar$LCcurrentid">
1.1041    www      10386:     <span class="pblabel">$starting</span>
                   10387:   </div>
                   10388: ENDPROGBAR
1.1302    raeburn  10389:     } else {
                   10390:         $starting=&mt('Loading...');
                   10391:         $LClastpercent='false';
                   10392:         $content=(<<ENDPROGBAR);
                   10393: $preamble
                   10394:   <div id="progressbar$LCcurrentid">
                   10395:       <div class="progress-label">$starting</div>
                   10396:   </div>
                   10397: ENDPROGBAR
                   10398:     }
                   10399:     &r_print($r,$content.&LCprogressbar_script($LCcurrentid,$number_to_do));
1.1041    www      10400: }
                   10401: 
                   10402: sub LCprogressbarUpdate {
1.1302    raeburn  10403:     my ($r,$val,$text,$number_to_do)=@_;
                   10404:     if ($number_to_do) {
                   10405:         unless ($val) { 
                   10406:             if ($LClastpercent) {
                   10407:                 $val=$LClastpercent;
                   10408:             } else {
                   10409:                 $val=0;
                   10410:             }
                   10411:         }
                   10412:         if ($val<0) { $val=0; }
                   10413:         if ($val>100) { $val=0; }
                   10414:         $LClastpercent=$val;
                   10415:         unless ($text) { $text=$val.'%'; }
                   10416:     } else {
                   10417:         $val = 'false';
1.1042    www      10418:     }
1.1041    www      10419:     $text=&js_ready($text);
1.1044    www      10420:     &r_print($r,<<ENDUPDATE);
1.1041    www      10421: <script type="text/javascript">
                   10422: // <![CDATA[
1.1302    raeburn  10423: LCupdateProgress($val,'$text','$LCcurrentid','$number_to_do');
1.1041    www      10424: // ]]>
                   10425: </script>
                   10426: ENDUPDATE
1.1035    www      10427: }
                   10428: 
1.1042    www      10429: sub LCprogressbarClose {
                   10430:     my ($r)=@_;
                   10431:     $LClastpercent=0;
1.1044    www      10432:     &r_print($r,<<ENDCLOSE);
1.1042    www      10433: <script type="text/javascript">
                   10434: // <![CDATA[
1.1045    www      10435: \$("#progressbar$LCcurrentid").hide('slow'); 
1.1042    www      10436: // ]]>
                   10437: </script>
                   10438: ENDCLOSE
1.1044    www      10439: }
                   10440: 
                   10441: sub r_print {
                   10442:     my ($r,$to_print)=@_;
                   10443:     if ($r) {
                   10444:       $r->print($to_print);
                   10445:       $r->rflush();
                   10446:     } else {
                   10447:       print($to_print);
                   10448:     }
1.1042    www      10449: }
                   10450: 
1.320     albertel 10451: sub html_encode {
                   10452:     my ($result) = @_;
                   10453: 
1.322     albertel 10454:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 10455:     
                   10456:     return $result;
                   10457: }
1.1044    www      10458: 
1.317     albertel 10459: sub js_ready {
                   10460:     my ($result) = @_;
                   10461: 
1.323     albertel 10462:     $result =~ s/[\n\r]/ /xmsg;
                   10463:     $result =~ s/\\/\\\\/xmsg;
                   10464:     $result =~ s/'/\\'/xmsg;
1.372     albertel 10465:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 10466:     
                   10467:     return $result;
                   10468: }
                   10469: 
1.315     albertel 10470: sub validate_page {
                   10471:     if (  exists($env{'internal.start_page'})
1.316     albertel 10472: 	  &&     $env{'internal.start_page'} > 1) {
                   10473: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 10474: 				 $env{'internal.start_page'}.' '.
1.316     albertel 10475: 				 $ENV{'request.filename'});
1.315     albertel 10476:     }
                   10477:     if (  exists($env{'internal.end_page'})
1.316     albertel 10478: 	  &&     $env{'internal.end_page'} > 1) {
                   10479: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 10480: 				 $env{'internal.end_page'}.' '.
1.316     albertel 10481: 				 $env{'request.filename'});
1.315     albertel 10482:     }
                   10483:     if (     exists($env{'internal.start_page'})
                   10484: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 10485: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   10486: 				 $env{'request.filename'});
1.315     albertel 10487:     }
                   10488:     if (   ! exists($env{'internal.start_page'})
                   10489: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 10490: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   10491: 				 $env{'request.filename'});
1.315     albertel 10492:     }
1.306     albertel 10493: }
1.315     albertel 10494: 
1.996     www      10495: 
                   10496: sub start_scrollbox {
1.1140    raeburn  10497:     my ($outerwidth,$width,$height,$id,$bgcolor,$cursor,$needjsready) = @_;
1.998     raeburn  10498:     unless ($outerwidth) { $outerwidth='520px'; }
                   10499:     unless ($width) { $width='500px'; }
                   10500:     unless ($height) { $height='200px'; }
1.1075    raeburn  10501:     my ($table_id,$div_id,$tdcol);
1.1018    raeburn  10502:     if ($id ne '') {
1.1140    raeburn  10503:         $table_id = ' id="table_'.$id.'"';
1.1137    raeburn  10504:         $div_id = ' id="div_'.$id.'"';
1.1018    raeburn  10505:     }
1.1075    raeburn  10506:     if ($bgcolor ne '') {
                   10507:         $tdcol = "background-color: $bgcolor;";
                   10508:     }
1.1137    raeburn  10509:     my $nicescroll_js;
                   10510:     if ($env{'browser.mobile'}) {
1.1140    raeburn  10511:         $nicescroll_js = &nicescroll_javascript('div_'.$id,$cursor,$needjsready);
                   10512:     }
                   10513:     return <<"END";
                   10514: $nicescroll_js
                   10515: 
                   10516: <table style="width: $outerwidth; border: 1px solid none;"$table_id><tr><td style="width: $width;$tdcol">
                   10517: <div style="overflow:auto; width:$width; height:$height;"$div_id>
                   10518: END
                   10519: }
                   10520: 
                   10521: sub end_scrollbox {
                   10522:     return '</div></td></tr></table>';
                   10523: }
                   10524: 
                   10525: sub nicescroll_javascript {
                   10526:     my ($id,$cursor,$needjsready,$framecheck,$location) = @_;
                   10527:     my %options;
                   10528:     if (ref($cursor) eq 'HASH') {
                   10529:         %options = %{$cursor};
                   10530:     }
                   10531:     unless ($options{'railalign'} =~ /^left|right$/) {
                   10532:         $options{'railalign'} = 'left';
                   10533:     }
                   10534:     unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
                   10535:         my $function  = &get_users_function();
                   10536:         $options{'cursorcolor'} = &designparm($function.'.sidebg',$env{'request.role.domain'});
1.1138    raeburn  10537:         unless ($options{'cursorcolor'} =~ /^\#\w+$/) {
1.1140    raeburn  10538:             $options{'cursorcolor'} = '#00F';
1.1138    raeburn  10539:         }
1.1140    raeburn  10540:     }
                   10541:     if ($options{'cursoropacity'} =~ /^[\d.]+$/) {
                   10542:         unless ($options{'cursoropacity'} >= 0.0 && $options{'cursoropacity'} <=1.0) {
1.1138    raeburn  10543:             $options{'cursoropacity'}='1.0';
                   10544:         }
1.1140    raeburn  10545:     } else {
                   10546:         $options{'cursoropacity'}='1.0';
                   10547:     }
                   10548:     if ($options{'cursorfixedheight'} eq 'none') {
                   10549:         delete($options{'cursorfixedheight'});
                   10550:     } else {
                   10551:         unless ($options{'cursorfixedheight'} =~ /^\d+$/) { $options{'cursorfixedheight'}='50'; }
                   10552:     }
                   10553:     unless ($options{'railoffset'} =~ /^{[\w\:\d\-,]+}$/) {
                   10554:         delete($options{'railoffset'});
                   10555:     }
                   10556:     my @niceoptions;
                   10557:     while (my($key,$value) = each(%options)) {
                   10558:         if ($value =~ /^\{.+\}$/) {
                   10559:             push(@niceoptions,$key.':'.$value);
1.1138    raeburn  10560:         } else {
1.1140    raeburn  10561:             push(@niceoptions,$key.':"'.$value.'"');
1.1138    raeburn  10562:         }
1.1140    raeburn  10563:     }
                   10564:     my $nicescroll_js = '
1.1137    raeburn  10565: $(document).ready(
1.1140    raeburn  10566:       function() {
                   10567:           $("#'.$id.'").niceScroll({'.join(',',@niceoptions).'});
                   10568:       }
1.1137    raeburn  10569: );
                   10570: ';
1.1140    raeburn  10571:     if ($framecheck) {
                   10572:         $nicescroll_js .= '
                   10573: function expand_div(caller) {
                   10574:     if (top === self) {
                   10575:         document.getElementById("'.$id.'").style.width = "auto";
                   10576:         document.getElementById("'.$id.'").style.height = "auto";
                   10577:     } else {
                   10578:         try {
                   10579:             if (parent.frames) {
                   10580:                 if (parent.frames.length > 1) {
                   10581:                     var framesrc = parent.frames[1].location.href;
                   10582:                     var currsrc = framesrc.replace(/\#.*$/,"");
                   10583:                     if ((caller == "search") || (currsrc == "'.$location.'")) {
                   10584:                         document.getElementById("'.$id.'").style.width = "auto";
                   10585:                         document.getElementById("'.$id.'").style.height = "auto";
                   10586:                     }
                   10587:                 }
                   10588:             }
                   10589:         } catch (e) {
                   10590:             return;
                   10591:         }
1.1137    raeburn  10592:     }
1.1140    raeburn  10593:     return;
1.996     www      10594: }
1.1140    raeburn  10595: ';
                   10596:     }
                   10597:     if ($needjsready) {
                   10598:         $nicescroll_js = '
                   10599: <script type="text/javascript">'."\n".$nicescroll_js."\n</script>\n";
                   10600:     } else {
                   10601:         $nicescroll_js = &Apache::lonhtmlcommon::scripttag($nicescroll_js);
                   10602:     }
                   10603:     return $nicescroll_js;
1.996     www      10604: }
                   10605: 
1.318     albertel 10606: sub simple_error_page {
1.1150    bisitz   10607:     my ($r,$title,$msg,$args) = @_;
1.1304    raeburn  10608:     my %displayargs;
1.1151    raeburn  10609:     if (ref($args) eq 'HASH') {
                   10610:         if (!$args->{'no_auto_mt_msg'}) { $msg = &mt($msg); }
1.1304    raeburn  10611:         if ($args->{'only_body'}) {
                   10612:             $displayargs{'only_body'} = 1;
                   10613:         }
                   10614:         if ($args->{'no_nav_bar'}) {
                   10615:             $displayargs{'no_nav_bar'} = 1;
                   10616:         }
1.1151    raeburn  10617:     } else {
                   10618:         $msg = &mt($msg);
                   10619:     }
1.1150    bisitz   10620: 
1.318     albertel 10621:     my $page =
1.1304    raeburn  10622: 	&Apache::loncommon::start_page($title,'',\%displayargs).
1.1150    bisitz   10623: 	'<p class="LC_error">'.$msg.'</p>'.
1.318     albertel 10624: 	&Apache::loncommon::end_page();
                   10625:     if (ref($r)) {
                   10626: 	$r->print($page);
1.327     albertel 10627: 	return;
1.318     albertel 10628:     }
                   10629:     return $page;
                   10630: }
1.347     albertel 10631: 
                   10632: {
1.610     albertel 10633:     my @row_count;
1.961     onken    10634: 
                   10635:     sub start_data_table_count {
                   10636:         unshift(@row_count, 0);
                   10637:         return;
                   10638:     }
                   10639: 
                   10640:     sub end_data_table_count {
                   10641:         shift(@row_count);
                   10642:         return;
                   10643:     }
                   10644: 
1.347     albertel 10645:     sub start_data_table {
1.1018    raeburn  10646: 	my ($add_class,$id) = @_;
1.422     albertel 10647: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.1018    raeburn  10648:         my $table_id;
                   10649:         if (defined($id)) {
                   10650:             $table_id = ' id="'.$id.'"';
                   10651:         }
1.961     onken    10652: 	&start_data_table_count();
1.1018    raeburn  10653: 	return '<table class="'.$css_class.'"'.$table_id.'>'."\n";
1.347     albertel 10654:     }
                   10655: 
                   10656:     sub end_data_table {
1.961     onken    10657: 	&end_data_table_count();
1.389     albertel 10658: 	return '</table>'."\n";;
1.347     albertel 10659:     }
                   10660: 
                   10661:     sub start_data_table_row {
1.974     wenzelju 10662: 	my ($add_class, $id) = @_;
1.610     albertel 10663: 	$row_count[0]++;
                   10664: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   10665: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.974     wenzelju 10666:         $id = (' id="'.$id.'"') unless ($id eq '');
                   10667:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.347     albertel 10668:     }
1.471     banghart 10669:     
                   10670:     sub continue_data_table_row {
1.974     wenzelju 10671: 	my ($add_class, $id) = @_;
1.610     albertel 10672: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.974     wenzelju 10673: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
                   10674:         $id = (' id="'.$id.'"') unless ($id eq '');
                   10675:         return  '<tr class="'.$css_class.'"'.$id.'>'."\n";
1.471     banghart 10676:     }
1.347     albertel 10677: 
                   10678:     sub end_data_table_row {
1.389     albertel 10679: 	return '</tr>'."\n";;
1.347     albertel 10680:     }
1.367     www      10681: 
1.421     albertel 10682:     sub start_data_table_empty_row {
1.707     bisitz   10683: #	$row_count[0]++;
1.421     albertel 10684: 	return  '<tr class="LC_empty_row" >'."\n";;
                   10685:     }
                   10686: 
                   10687:     sub end_data_table_empty_row {
                   10688: 	return '</tr>'."\n";;
                   10689:     }
                   10690: 
1.367     www      10691:     sub start_data_table_header_row {
1.389     albertel 10692: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      10693:     }
                   10694: 
                   10695:     sub end_data_table_header_row {
1.389     albertel 10696: 	return '</tr>'."\n";;
1.367     www      10697:     }
1.890     droeschl 10698: 
                   10699:     sub data_table_caption {
                   10700:         my $caption = shift;
                   10701:         return "<caption class=\"LC_caption\">$caption</caption>";
                   10702:     }
1.347     albertel 10703: }
                   10704: 
1.548     albertel 10705: =pod
                   10706: 
                   10707: =item * &inhibit_menu_check($arg)
                   10708: 
                   10709: Checks for a inhibitmenu state and generates output to preserve it
                   10710: 
                   10711: Inputs:         $arg - can be any of
                   10712:                      - undef - in which case the return value is a string 
                   10713:                                to add  into arguments list of a uri
                   10714:                      - 'input' - in which case the return value is a HTML
                   10715:                                  <form> <input> field of type hidden to
                   10716:                                  preserve the value
                   10717:                      - a url - in which case the return value is the url with
                   10718:                                the neccesary cgi args added to preserve the
                   10719:                                inhibitmenu state
                   10720:                      - a ref to a url - no return value, but the string is
                   10721:                                         updated to include the neccessary cgi
                   10722:                                         args to preserve the inhibitmenu state
                   10723: 
                   10724: =cut
                   10725: 
                   10726: sub inhibit_menu_check {
                   10727:     my ($arg) = @_;
                   10728:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   10729:     if ($arg eq 'input') {
                   10730: 	if ($env{'form.inhibitmenu'}) {
                   10731: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   10732: 	} else {
                   10733: 	    return
                   10734: 	}
                   10735:     }
                   10736:     if ($env{'form.inhibitmenu'}) {
                   10737: 	if (ref($arg)) {
                   10738: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   10739: 	} elsif ($arg eq '') {
                   10740: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   10741: 	} else {
                   10742: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   10743: 	}
                   10744:     }
                   10745:     if (!ref($arg)) {
                   10746: 	return $arg;
                   10747:     }
                   10748: }
                   10749: 
1.251     albertel 10750: ###############################################
1.182     matthew  10751: 
                   10752: =pod
                   10753: 
1.549     albertel 10754: =back
                   10755: 
                   10756: =head1 User Information Routines
                   10757: 
                   10758: =over 4
                   10759: 
1.405     albertel 10760: =item * &get_users_function()
1.182     matthew  10761: 
                   10762: Used by &bodytag to determine the current users primary role.
                   10763: Returns either 'student','coordinator','admin', or 'author'.
                   10764: 
                   10765: =cut
                   10766: 
                   10767: ###############################################
                   10768: sub get_users_function {
1.815     tempelho 10769:     my $function = 'norole';
1.818     tempelho 10770:     if ($env{'request.role'}=~/^(st)/) {
                   10771:         $function='student';
                   10772:     }
1.907     raeburn  10773:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  10774:         $function='coordinator';
                   10775:     }
1.258     albertel 10776:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  10777:         $function='admin';
                   10778:     }
1.826     bisitz   10779:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.1025    raeburn  10780:         ($ENV{'REQUEST_URI'}=~ m{/^(/priv)})) {
1.182     matthew  10781:         $function='author';
                   10782:     }
                   10783:     return $function;
1.54      www      10784: }
1.99      www      10785: 
                   10786: ###############################################
                   10787: 
1.233     raeburn  10788: =pod
                   10789: 
1.821     raeburn  10790: =item * &show_course()
                   10791: 
                   10792: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   10793: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   10794: 
                   10795: Inputs:
                   10796: None
                   10797: 
                   10798: Outputs:
                   10799: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   10800: 
                   10801: =cut
                   10802: 
                   10803: ###############################################
                   10804: sub show_course {
1.1408    raeburn  10805:     my ($udom,$uname) = @_;
                   10806:     if (($udom ne '') && ($uname ne '')) {
                   10807:         if (($udom ne $env{'user.domain'}) || ($uname ne $env{'user.name'})) {
1.1410    raeburn  10808:             if (&Apache::lonnet::is_advanced_user($udom,$uname)) {
1.1408    raeburn  10809:                 return 0;
                   10810:             } else {
                   10811:                 return 1;
                   10812:             }
                   10813:         }
                   10814:     }
1.821     raeburn  10815:     my $course = !$env{'user.adv'};
                   10816:     if (!$env{'user.adv'}) {
                   10817:         foreach my $env (keys(%env)) {
                   10818:             next if ($env !~ m/^user\.priv\./);
                   10819:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   10820:                 $course = 0;
                   10821:                 last;
                   10822:             }
                   10823:         }
                   10824:     }
                   10825:     return $course;
                   10826: }
                   10827: 
                   10828: ###############################################
                   10829: 
                   10830: =pod
                   10831: 
1.542     raeburn  10832: =item * &check_user_status()
1.274     raeburn  10833: 
                   10834: Determines current status of supplied role for a
                   10835: specific user. Roles can be active, previous or future.
                   10836: 
                   10837: Inputs: 
                   10838: user's domain, user's username, course's domain,
1.375     raeburn  10839: course's number, optional section ID.
1.274     raeburn  10840: 
                   10841: Outputs:
                   10842: role status: active, previous or future. 
                   10843: 
                   10844: =cut
                   10845: 
                   10846: sub check_user_status {
1.412     raeburn  10847:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.1073    raeburn  10848:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
1.1202    raeburn  10849:     my @uroles = keys(%userinfo);
1.274     raeburn  10850:     my $srchstr;
                   10851:     my $active_chk = 'none';
1.412     raeburn  10852:     my $now = time;
1.274     raeburn  10853:     if (@uroles > 0) {
1.908     raeburn  10854:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  10855:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   10856:         } else {
1.412     raeburn  10857:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   10858:         }
                   10859:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  10860:             my $role_end = 0;
                   10861:             my $role_start = 0;
                   10862:             $active_chk = 'active';
1.412     raeburn  10863:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   10864:                 $role_end = $1;
                   10865:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   10866:                     $role_start = $1;
1.274     raeburn  10867:                 }
                   10868:             }
                   10869:             if ($role_start > 0) {
1.412     raeburn  10870:                 if ($now < $role_start) {
1.274     raeburn  10871:                     $active_chk = 'future';
                   10872:                 }
                   10873:             }
                   10874:             if ($role_end > 0) {
1.412     raeburn  10875:                 if ($now > $role_end) {
1.274     raeburn  10876:                     $active_chk = 'previous';
                   10877:                 }
                   10878:             }
                   10879:         }
                   10880:     }
                   10881:     return $active_chk;
                   10882: }
                   10883: 
                   10884: ###############################################
                   10885: 
                   10886: =pod
                   10887: 
1.405     albertel 10888: =item * &get_sections()
1.233     raeburn  10889: 
                   10890: Determines all the sections for a course including
                   10891: sections with students and sections containing other roles.
1.419     raeburn  10892: Incoming parameters: 
                   10893: 
                   10894: 1. domain
                   10895: 2. course number 
                   10896: 3. reference to array containing roles for which sections should 
                   10897: be gathered (optional).
                   10898: 4. reference to array containing status types for which sections 
                   10899: should be gathered (optional).
                   10900: 
                   10901: If the third argument is undefined, sections are gathered for any role. 
                   10902: If the fourth argument is undefined, sections are gathered for any status.
                   10903: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  10904:  
1.374     raeburn  10905: Returns section hash (keys are section IDs, values are
                   10906: number of users in each section), subject to the
1.419     raeburn  10907: optional roles filter, optional status filter 
1.233     raeburn  10908: 
                   10909: =cut
                   10910: 
                   10911: ###############################################
                   10912: sub get_sections {
1.419     raeburn  10913:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 10914:     if (!defined($cdom) || !defined($cnum)) {
                   10915:         my $cid =  $env{'request.course.id'};
                   10916: 
                   10917: 	return if (!defined($cid));
                   10918: 
                   10919:         $cdom = $env{'course.'.$cid.'.domain'};
                   10920:         $cnum = $env{'course.'.$cid.'.num'};
                   10921:     }
                   10922: 
                   10923:     my %sectioncount;
1.419     raeburn  10924:     my $now = time;
1.240     albertel 10925: 
1.1118    raeburn  10926:     my $check_students = 1;
                   10927:     my $only_students = 0;
                   10928:     if (ref($possible_roles) eq 'ARRAY') {
                   10929:         if (grep(/^st$/,@{$possible_roles})) {
                   10930:             if (@{$possible_roles} == 1) {
                   10931:                 $only_students = 1;
                   10932:             }
                   10933:         } else {
                   10934:             $check_students = 0;
                   10935:         }
                   10936:     }
                   10937: 
                   10938:     if ($check_students) { 
1.276     albertel 10939: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 10940: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   10941: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  10942:         my $start_index = &Apache::loncoursedata::CL_START();
                   10943:         my $end_index = &Apache::loncoursedata::CL_END();
                   10944:         my $status;
1.366     albertel 10945: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  10946: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   10947: 				                     $data->[$status_index],
                   10948:                                                      $data->[$start_index],
                   10949:                                                      $data->[$end_index]);
                   10950:             if ($stu_status eq 'Active') {
                   10951:                 $status = 'active';
                   10952:             } elsif ($end < $now) {
                   10953:                 $status = 'previous';
                   10954:             } elsif ($start > $now) {
                   10955:                 $status = 'future';
                   10956:             } 
                   10957: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   10958:                 if ((!defined($possible_status)) || (($status ne '') && 
                   10959:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   10960: 		    $sectioncount{$section}++;
                   10961:                 }
1.240     albertel 10962: 	    }
                   10963: 	}
                   10964:     }
1.1118    raeburn  10965:     if ($only_students) {
                   10966:         return %sectioncount;
                   10967:     }
1.240     albertel 10968:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   10969:     foreach my $user (sort(keys(%courseroles))) {
                   10970: 	if ($user !~ /^(\w{2})/) { next; }
                   10971: 	my ($role) = ($user =~ /^(\w{2})/);
                   10972: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  10973: 	my ($section,$status);
1.240     albertel 10974: 	if ($role eq 'cr' &&
                   10975: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   10976: 	    $section=$1;
                   10977: 	}
                   10978: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   10979: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  10980:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   10981:         if ($end == -1 && $start == -1) {
                   10982:             next; #deleted role
                   10983:         }
                   10984:         if (!defined($possible_status)) { 
                   10985:             $sectioncount{$section}++;
                   10986:         } else {
                   10987:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   10988:                 $status = 'active';
                   10989:             } elsif ($end < $now) {
                   10990:                 $status = 'future';
                   10991:             } elsif ($start > $now) {
                   10992:                 $status = 'previous';
                   10993:             }
                   10994:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   10995:                 $sectioncount{$section}++;
                   10996:             }
                   10997:         }
1.233     raeburn  10998:     }
1.366     albertel 10999:     return %sectioncount;
1.233     raeburn  11000: }
                   11001: 
1.274     raeburn  11002: ###############################################
1.294     raeburn  11003: 
                   11004: =pod
1.405     albertel 11005: 
                   11006: =item * &get_course_users()
                   11007: 
1.275     raeburn  11008: Retrieves usernames:domains for users in the specified course
                   11009: with specific role(s), and access status. 
                   11010: 
                   11011: Incoming parameters:
1.277     albertel 11012: 1. course domain
                   11013: 2. course number
                   11014: 3. access status: users must have - either active, 
1.275     raeburn  11015: previous, future, or all.
1.277     albertel 11016: 4. reference to array of permissible roles
1.288     raeburn  11017: 5. reference to array of section restrictions (optional)
                   11018: 6. reference to results object (hash of hashes).
                   11019: 7. reference to optional userdata hash
1.609     raeburn  11020: 8. reference to optional statushash
1.630     raeburn  11021: 9. flag if privileged users (except those set to unhide in
                   11022:    course settings) should be excluded    
1.609     raeburn  11023: Keys of top level results hash are roles.
1.275     raeburn  11024: Keys of inner hashes are username:domain, with 
                   11025: values set to access type.
1.288     raeburn  11026: Optional userdata hash returns an array with arguments in the 
                   11027: same order as loncoursedata::get_classlist() for student data.
                   11028: 
1.609     raeburn  11029: Optional statushash returns
                   11030: 
1.288     raeburn  11031: Entries for end, start, section and status are blank because
                   11032: of the possibility of multiple values for non-student roles.
                   11033: 
1.275     raeburn  11034: =cut
1.405     albertel 11035: 
1.275     raeburn  11036: ###############################################
1.405     albertel 11037: 
1.275     raeburn  11038: sub get_course_users {
1.630     raeburn  11039:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  11040:     my %idx = ();
1.419     raeburn  11041:     my %seclists;
1.288     raeburn  11042: 
                   11043:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   11044:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   11045:     $idx{end} = &Apache::loncoursedata::CL_END();
                   11046:     $idx{start} = &Apache::loncoursedata::CL_START();
                   11047:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   11048:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   11049:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   11050:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   11051: 
1.290     albertel 11052:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 11053:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  11054:         my $now = time;
1.277     albertel 11055:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  11056:             my $match = 0;
1.412     raeburn  11057:             my $secmatch = 0;
1.419     raeburn  11058:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  11059:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  11060:             if ($section eq '') {
                   11061:                 $section = 'none';
                   11062:             }
1.291     albertel 11063:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 11064:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  11065:                     $secmatch = 1;
                   11066:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 11067:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  11068:                         $secmatch = 1;
                   11069:                     }
                   11070:                 } else {  
1.419     raeburn  11071: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  11072: 		        $secmatch = 1;
                   11073:                     }
1.290     albertel 11074: 		}
1.412     raeburn  11075:                 if (!$secmatch) {
                   11076:                     next;
                   11077:                 }
1.419     raeburn  11078:             }
1.275     raeburn  11079:             if (defined($$types{'active'})) {
1.288     raeburn  11080:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  11081:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  11082:                     $match = 1;
1.275     raeburn  11083:                 }
                   11084:             }
                   11085:             if (defined($$types{'previous'})) {
1.609     raeburn  11086:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  11087:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  11088:                     $match = 1;
1.275     raeburn  11089:                 }
                   11090:             }
                   11091:             if (defined($$types{'future'})) {
1.609     raeburn  11092:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  11093:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  11094:                     $match = 1;
1.275     raeburn  11095:                 }
                   11096:             }
1.609     raeburn  11097:             if ($match) {
                   11098:                 push(@{$seclists{$student}},$section);
                   11099:                 if (ref($userdata) eq 'HASH') {
                   11100:                     $$userdata{$student} = $$classlist{$student};
                   11101:                 }
                   11102:                 if (ref($statushash) eq 'HASH') {
                   11103:                     $statushash->{$student}{'st'}{$section} = $status;
                   11104:                 }
1.288     raeburn  11105:             }
1.275     raeburn  11106:         }
                   11107:     }
1.412     raeburn  11108:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  11109:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   11110:         my $now = time;
1.609     raeburn  11111:         my %displaystatus = ( previous => 'Expired',
                   11112:                               active   => 'Active',
                   11113:                               future   => 'Future',
                   11114:                             );
1.1121    raeburn  11115:         my (%nothide,@possdoms);
1.630     raeburn  11116:         if ($hidepriv) {
                   11117:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   11118:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   11119:                 if ($user !~ /:/) {
                   11120:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   11121:                 } else {
                   11122:                     $nothide{$user} = 1;
                   11123:                 }
                   11124:             }
1.1121    raeburn  11125:             my @possdoms = ($cdom);
                   11126:             if ($coursehash{'checkforpriv'}) {
                   11127:                 push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
                   11128:             }
1.630     raeburn  11129:         }
1.439     raeburn  11130:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  11131:             my $match = 0;
1.412     raeburn  11132:             my $secmatch = 0;
1.439     raeburn  11133:             my $status;
1.412     raeburn  11134:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  11135:             $user =~ s/:$//;
1.439     raeburn  11136:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   11137:             if ($end == -1 || $start == -1) {
                   11138:                 next;
                   11139:             }
                   11140:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   11141:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  11142:                 my ($uname,$udom) = split(/:/,$user);
                   11143:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 11144:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  11145:                         $secmatch = 1;
                   11146:                     } elsif ($usec eq '') {
1.420     albertel 11147:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  11148:                             $secmatch = 1;
                   11149:                         }
                   11150:                     } else {
                   11151:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   11152:                             $secmatch = 1;
                   11153:                         }
                   11154:                     }
                   11155:                     if (!$secmatch) {
                   11156:                         next;
                   11157:                     }
1.288     raeburn  11158:                 }
1.419     raeburn  11159:                 if ($usec eq '') {
                   11160:                     $usec = 'none';
                   11161:                 }
1.275     raeburn  11162:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  11163:                     if ($hidepriv) {
1.1121    raeburn  11164:                         if ((&Apache::lonnet::privileged($uname,$udom,\@possdoms)) &&
1.630     raeburn  11165:                             (!$nothide{$uname.':'.$udom})) {
                   11166:                             next;
                   11167:                         }
                   11168:                     }
1.503     raeburn  11169:                     if ($end > 0 && $end < $now) {
1.439     raeburn  11170:                         $status = 'previous';
                   11171:                     } elsif ($start > $now) {
                   11172:                         $status = 'future';
                   11173:                     } else {
                   11174:                         $status = 'active';
                   11175:                     }
1.277     albertel 11176:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  11177:                         if ($status eq $type) {
1.420     albertel 11178:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  11179:                                 push(@{$$users{$role}{$user}},$type);
                   11180:                             }
1.288     raeburn  11181:                             $match = 1;
                   11182:                         }
                   11183:                     }
1.419     raeburn  11184:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   11185:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   11186: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   11187:                         }
1.420     albertel 11188:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  11189:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   11190:                         }
1.609     raeburn  11191:                         if (ref($statushash) eq 'HASH') {
                   11192:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   11193:                         }
1.275     raeburn  11194:                     }
                   11195:                 }
                   11196:             }
                   11197:         }
1.290     albertel 11198:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  11199:             if ((defined($cdom)) && (defined($cnum))) {
                   11200:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   11201:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   11202:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  11203:                     next if ($owner eq '');
                   11204:                     my ($ownername,$ownerdom);
                   11205:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   11206:                         $ownername = $1;
                   11207:                         $ownerdom = $2;
                   11208:                     } else {
                   11209:                         $ownername = $owner;
                   11210:                         $ownerdom = $cdom;
                   11211:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  11212:                     }
                   11213:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 11214:                     if (defined($userdata) && 
1.609     raeburn  11215: 			!exists($$userdata{$owner})) {
                   11216: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   11217:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   11218:                             push(@{$seclists{$owner}},'none');
                   11219:                         }
                   11220:                         if (ref($statushash) eq 'HASH') {
                   11221:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  11222:                         }
1.290     albertel 11223: 		    }
1.279     raeburn  11224:                 }
                   11225:             }
                   11226:         }
1.419     raeburn  11227:         foreach my $user (keys(%seclists)) {
                   11228:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   11229:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   11230:         }
1.275     raeburn  11231:     }
                   11232:     return;
                   11233: }
                   11234: 
1.288     raeburn  11235: sub get_user_info {
                   11236:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 11237:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   11238: 	&plainname($uname,$udom,'lastname');
1.291     albertel 11239:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  11240:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  11241:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   11242:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  11243:     return;
                   11244: }
1.275     raeburn  11245: 
1.472     raeburn  11246: ###############################################
                   11247: 
                   11248: =pod
                   11249: 
                   11250: =item * &get_user_quota()
                   11251: 
1.1134    raeburn  11252: Retrieves quota assigned for storage of user files.
                   11253: Default is to report quota for portfolio files.
1.472     raeburn  11254: 
                   11255: Incoming parameters:
                   11256: 1. user's username
                   11257: 2. user's domain
1.1134    raeburn  11258: 3. quota name - portfolio, author, or course
1.1136    raeburn  11259:    (if no quota name provided, defaults to portfolio).
1.1237    raeburn  11260: 4. crstype - official, unofficial, textbook, placement or community, 
                   11261:    if quota name is course
1.472     raeburn  11262: 
                   11263: Returns:
1.1163    raeburn  11264: 1. Disk quota (in MB) assigned to student.
1.536     raeburn  11265: 2. (Optional) Type of setting: custom or default
                   11266:    (individually assigned or default for user's 
                   11267:    institutional status).
                   11268: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   11269:    or student - types as defined in localenroll::inst_usertypes 
                   11270:    for user's domain, which determines default quota for user.
                   11271: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  11272: 
                   11273: If a value has been stored in the user's environment, 
1.536     raeburn  11274: it will return that, otherwise it returns the maximal default
1.1134    raeburn  11275: defined for the user's institutional status(es) in the domain.
1.472     raeburn  11276: 
                   11277: =cut
                   11278: 
                   11279: ###############################################
                   11280: 
                   11281: 
                   11282: sub get_user_quota {
1.1136    raeburn  11283:     my ($uname,$udom,$quotaname,$crstype) = @_;
1.536     raeburn  11284:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  11285:     if (!defined($udom)) {
                   11286:         $udom = $env{'user.domain'};
                   11287:     }
                   11288:     if (!defined($uname)) {
                   11289:         $uname = $env{'user.name'};
                   11290:     }
                   11291:     if (($udom eq '' || $uname eq '') ||
                   11292:         ($udom eq 'public') && ($uname eq 'public')) {
                   11293:         $quota = 0;
1.536     raeburn  11294:         $quotatype = 'default';
                   11295:         $defquota = 0; 
1.472     raeburn  11296:     } else {
1.536     raeburn  11297:         my $inststatus;
1.1134    raeburn  11298:         if ($quotaname eq 'course') {
                   11299:             if (($env{'course.'.$udom.'_'.$uname.'.num'} eq $uname) &&
                   11300:                 ($env{'course.'.$udom.'_'.$uname.'.domain'} eq $udom)) {
                   11301:                 $quota = $env{'course.'.$udom.'_'.$uname.'.internal.uploadquota'};
                   11302:             } else {
                   11303:                 my %cenv = &Apache::lonnet::coursedescription("$udom/$uname");
                   11304:                 $quota = $cenv{'internal.uploadquota'};
                   11305:             }
1.536     raeburn  11306:         } else {
1.1134    raeburn  11307:             if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   11308:                 if ($quotaname eq 'author') {
                   11309:                     $quota = $env{'environment.authorquota'};
                   11310:                 } else {
                   11311:                     $quota = $env{'environment.portfolioquota'};
                   11312:                 }
                   11313:                 $inststatus = $env{'environment.inststatus'};
                   11314:             } else {
                   11315:                 my %userenv = 
                   11316:                     &Apache::lonnet::get('environment',['portfolioquota',
                   11317:                                          'authorquota','inststatus'],$udom,$uname);
                   11318:                 my ($tmp) = keys(%userenv);
                   11319:                 if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   11320:                     if ($quotaname eq 'author') {
                   11321:                         $quota = $userenv{'authorquota'};
                   11322:                     } else {
                   11323:                         $quota = $userenv{'portfolioquota'};
                   11324:                     }
                   11325:                     $inststatus = $userenv{'inststatus'};
                   11326:                 } else {
                   11327:                     undef(%userenv);
                   11328:                 }
                   11329:             }
                   11330:         }
                   11331:         if ($quota eq '' || wantarray) {
                   11332:             if ($quotaname eq 'course') {
                   11333:                 my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
1.1165    raeburn  11334:                 if (($crstype eq 'official') || ($crstype eq 'unofficial') || 
1.1237    raeburn  11335:                     ($crstype eq 'community') || ($crstype eq 'textbook') ||
                   11336:                     ($crstype eq 'placement')) { 
1.1136    raeburn  11337:                     $defquota = $domdefs{$crstype.'quota'};
                   11338:                 }
                   11339:                 if ($defquota eq '') {
                   11340:                     $defquota = 500;
                   11341:                 }
1.1134    raeburn  11342:             } else {
                   11343:                 ($defquota,$settingstatus) = &default_quota($udom,$inststatus,$quotaname);
                   11344:             }
                   11345:             if ($quota eq '') {
                   11346:                 $quota = $defquota;
                   11347:                 $quotatype = 'default';
                   11348:             } else {
                   11349:                 $quotatype = 'custom';
                   11350:             }
1.472     raeburn  11351:         }
                   11352:     }
1.536     raeburn  11353:     if (wantarray) {
                   11354:         return ($quota,$quotatype,$settingstatus,$defquota);
                   11355:     } else {
                   11356:         return $quota;
                   11357:     }
1.472     raeburn  11358: }
                   11359: 
                   11360: ###############################################
                   11361: 
                   11362: =pod
                   11363: 
                   11364: =item * &default_quota()
                   11365: 
1.536     raeburn  11366: Retrieves default quota assigned for storage of user portfolio files,
                   11367: given an (optional) user's institutional status.
1.472     raeburn  11368: 
                   11369: Incoming parameters:
1.1142    raeburn  11370: 
1.472     raeburn  11371: 1. domain
1.536     raeburn  11372: 2. (Optional) institutional status(es).  This is a : separated list of 
                   11373:    status types (e.g., faculty, staff, student etc.)
                   11374:    which apply to the user for whom the default is being retrieved.
                   11375:    If the institutional status string in undefined, the domain
1.1134    raeburn  11376:    default quota will be returned.
                   11377: 3.  quota name - portfolio, author, or course
                   11378:    (if no quota name provided, defaults to portfolio).
1.472     raeburn  11379: 
                   11380: Returns:
1.1142    raeburn  11381: 
1.1163    raeburn  11382: 1. Default disk quota (in MB) for user portfolios in the domain.
1.536     raeburn  11383: 2. (Optional) institutional type which determined the value of the
                   11384:    default quota.
1.472     raeburn  11385: 
                   11386: If a value has been stored in the domain's configuration db,
                   11387: it will return that, otherwise it returns 20 (for backwards 
                   11388: compatibility with domains which have not set up a configuration
1.1163    raeburn  11389: db file; the original statically defined portfolio quota was 20 MB). 
1.472     raeburn  11390: 
1.536     raeburn  11391: If the user's status includes multiple types (e.g., staff and student),
                   11392: the largest default quota which applies to the user determines the
                   11393: default quota returned.
                   11394: 
1.472     raeburn  11395: =cut
                   11396: 
                   11397: ###############################################
                   11398: 
                   11399: 
                   11400: sub default_quota {
1.1134    raeburn  11401:     my ($udom,$inststatus,$quotaname) = @_;
1.536     raeburn  11402:     my ($defquota,$settingstatus);
                   11403:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  11404:                                             ['quotas'],$udom);
1.1134    raeburn  11405:     my $key = 'defaultquota';
                   11406:     if ($quotaname eq 'author') {
                   11407:         $key = 'authorquota';
                   11408:     }
1.622     raeburn  11409:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  11410:         if ($inststatus ne '') {
1.765     raeburn  11411:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  11412:             foreach my $item (@statuses) {
1.1134    raeburn  11413:                 if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   11414:                     if ($quotahash{'quotas'}{$key}{$item} ne '') {
1.711     raeburn  11415:                         if ($defquota eq '') {
1.1134    raeburn  11416:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  11417:                             $settingstatus = $item;
1.1134    raeburn  11418:                         } elsif ($quotahash{'quotas'}{$key}{$item} > $defquota) {
                   11419:                             $defquota = $quotahash{'quotas'}{$key}{$item};
1.711     raeburn  11420:                             $settingstatus = $item;
                   11421:                         }
                   11422:                     }
1.1134    raeburn  11423:                 } elsif ($key eq 'defaultquota') {
1.711     raeburn  11424:                     if ($quotahash{'quotas'}{$item} ne '') {
                   11425:                         if ($defquota eq '') {
                   11426:                             $defquota = $quotahash{'quotas'}{$item};
                   11427:                             $settingstatus = $item;
                   11428:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   11429:                             $defquota = $quotahash{'quotas'}{$item};
                   11430:                             $settingstatus = $item;
                   11431:                         }
1.536     raeburn  11432:                     }
                   11433:                 }
                   11434:             }
                   11435:         }
                   11436:         if ($defquota eq '') {
1.1134    raeburn  11437:             if (ref($quotahash{'quotas'}{$key}) eq 'HASH') {
                   11438:                 $defquota = $quotahash{'quotas'}{$key}{'default'};
                   11439:             } elsif ($key eq 'defaultquota') {
1.711     raeburn  11440:                 $defquota = $quotahash{'quotas'}{'default'};
                   11441:             }
1.536     raeburn  11442:             $settingstatus = 'default';
1.1139    raeburn  11443:             if ($defquota eq '') {
                   11444:                 if ($quotaname eq 'author') {
                   11445:                     $defquota = 500;
                   11446:                 }
                   11447:             }
1.536     raeburn  11448:         }
                   11449:     } else {
                   11450:         $settingstatus = 'default';
1.1134    raeburn  11451:         if ($quotaname eq 'author') {
                   11452:             $defquota = 500;
                   11453:         } else {
                   11454:             $defquota = 20;
                   11455:         }
1.536     raeburn  11456:     }
                   11457:     if (wantarray) {
                   11458:         return ($defquota,$settingstatus);
1.472     raeburn  11459:     } else {
1.536     raeburn  11460:         return $defquota;
1.472     raeburn  11461:     }
                   11462: }
                   11463: 
1.1135    raeburn  11464: ###############################################
                   11465: 
                   11466: =pod
                   11467: 
1.1136    raeburn  11468: =item * &excess_filesize_warning()
1.1135    raeburn  11469: 
                   11470: Returns warning message if upload of file to authoring space, or copying
1.1136    raeburn  11471: of existing file within authoring space will cause quota for the authoring
1.1146    raeburn  11472: space to be exceeded.
1.1136    raeburn  11473: 
                   11474: Same, if upload of a file directly to a course/community via Course Editor
1.1137    raeburn  11475: will cause quota for uploaded content for the course to be exceeded.
1.1135    raeburn  11476: 
1.1165    raeburn  11477: Inputs: 7 
1.1136    raeburn  11478: 1. username or coursenum
1.1135    raeburn  11479: 2. domain
1.1136    raeburn  11480: 3. context ('author' or 'course')
1.1135    raeburn  11481: 4. filename of file for which action is being requested
                   11482: 5. filesize (kB) of file
                   11483: 6. action being taken: copy or upload.
1.1237    raeburn  11484: 7. quotatype (in course context -- official, unofficial, textbook, placement or community).
1.1135    raeburn  11485: 
                   11486: Returns: 1 scalar: HTML to display containing warning if quota would be exceeded,
1.1142    raeburn  11487:          otherwise return null.
                   11488: 
                   11489: =back
1.1135    raeburn  11490: 
                   11491: =cut
                   11492: 
1.1136    raeburn  11493: sub excess_filesize_warning {
1.1165    raeburn  11494:     my ($uname,$udom,$context,$filename,$filesize,$action,$quotatype) = @_;
1.1136    raeburn  11495:     my $current_disk_usage = 0;
1.1165    raeburn  11496:     my $disk_quota = &get_user_quota($uname,$udom,$context,$quotatype); #expressed in MB
1.1136    raeburn  11497:     if ($context eq 'author') {
                   11498:         my $authorspace = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname";
                   11499:         $current_disk_usage = &Apache::lonnet::diskusage($udom,$uname,$authorspace);
                   11500:     } else {
                   11501:         foreach my $subdir ('docs','supplemental') {
                   11502:             $current_disk_usage += &Apache::lonnet::diskusage($udom,$uname,"userfiles/$subdir",1);
                   11503:         }
                   11504:     }
1.1135    raeburn  11505:     $disk_quota = int($disk_quota * 1000);
                   11506:     if (($current_disk_usage + $filesize) > $disk_quota) {
1.1179    bisitz   11507:         return '<p class="LC_warning">'.
1.1135    raeburn  11508:                 &mt("Unable to $action [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.",
1.1179    bisitz   11509:                     '<span class="LC_filename">'.$filename.'</span>',$filesize).'</p>'.
                   11510:                '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
1.1135    raeburn  11511:                             $disk_quota,$current_disk_usage).
                   11512:                '</p>';
                   11513:     }
                   11514:     return;
                   11515: }
                   11516: 
                   11517: ###############################################
                   11518: 
                   11519: 
1.1136    raeburn  11520: 
                   11521: 
1.384     raeburn  11522: sub get_secgrprole_info {
                   11523:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   11524:     my %sections_count = &get_sections($cdom,$cnum);
                   11525:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   11526:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   11527:     my @groups = sort(keys(%curr_groups));
                   11528:     my $allroles = [];
                   11529:     my $rolehash;
                   11530:     my $accesshash = {
                   11531:                      active => 'Currently has access',
                   11532:                      future => 'Will have future access',
                   11533:                      previous => 'Previously had access',
                   11534:                   };
                   11535:     if ($needroles) {
                   11536:         $rolehash = {'all' => 'all'};
1.385     albertel 11537:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   11538: 	if (&Apache::lonnet::error(%user_roles)) {
                   11539: 	    undef(%user_roles);
                   11540: 	}
                   11541:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  11542:             my ($role)=split(/\:/,$item,2);
                   11543:             if ($role eq 'cr') { next; }
                   11544:             if ($role =~ /^cr/) {
                   11545:                 $$rolehash{$role} = (split('/',$role))[3];
                   11546:             } else {
                   11547:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   11548:             }
                   11549:         }
                   11550:         foreach my $key (sort(keys(%{$rolehash}))) {
                   11551:             push(@{$allroles},$key);
                   11552:         }
                   11553:         push (@{$allroles},'st');
                   11554:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   11555:     }
                   11556:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   11557: }
                   11558: 
1.555     raeburn  11559: sub user_picker {
1.1279    raeburn  11560:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context,$fixeddom,$noinstd) = @_;
1.555     raeburn  11561:     my $currdom = $dom;
1.1253    raeburn  11562:     my @alldoms = &Apache::lonnet::all_domains();
                   11563:     if (@alldoms == 1) {
                   11564:         my %domsrch = &Apache::lonnet::get_dom('configuration',
                   11565:                                                ['directorysrch'],$alldoms[0]);
                   11566:         my $domdesc = &Apache::lonnet::domain($alldoms[0],'description');
                   11567:         my $showdom = $domdesc;
                   11568:         if ($showdom eq '') {
                   11569:             $showdom = $dom;
                   11570:         }
                   11571:         if (ref($domsrch{'directorysrch'}) eq 'HASH') {
                   11572:             if ((!$domsrch{'directorysrch'}{'available'}) &&
                   11573:                 ($domsrch{'directorysrch'}{'lcavailable'} eq '0')) {
                   11574:                 return (&mt('LON-CAPA directory search is not available in domain: [_1]',$showdom),0);
                   11575:             }
                   11576:         }
                   11577:     }
1.555     raeburn  11578:     my %curr_selected = (
                   11579:                         srchin => 'dom',
1.580     raeburn  11580:                         srchby => 'lastname',
1.555     raeburn  11581:                       );
                   11582:     my $srchterm;
1.625     raeburn  11583:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  11584:         if ($srch->{'srchby'} ne '') {
                   11585:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   11586:         }
                   11587:         if ($srch->{'srchin'} ne '') {
                   11588:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   11589:         }
                   11590:         if ($srch->{'srchtype'} ne '') {
                   11591:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   11592:         }
                   11593:         if ($srch->{'srchdomain'} ne '') {
                   11594:             $currdom = $srch->{'srchdomain'};
                   11595:         }
                   11596:         $srchterm = $srch->{'srchterm'};
                   11597:     }
1.1222    damieng  11598:     my %html_lt=&Apache::lonlocal::texthash(
1.573     raeburn  11599:                     'usr'       => 'Search criteria',
1.563     raeburn  11600:                     'doma'      => 'Domain/institution to search',
1.558     albertel 11601:                     'uname'     => 'username',
                   11602:                     'lastname'  => 'last name',
1.555     raeburn  11603:                     'lastfirst' => 'last name, first name',
1.558     albertel 11604:                     'crs'       => 'in this course',
1.576     raeburn  11605:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 11606:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  11607:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 11608:                     'exact'     => 'is',
                   11609:                     'contains'  => 'contains',
1.569     raeburn  11610:                     'begins'    => 'begins with',
1.1222    damieng  11611:                                        );
                   11612:     my %js_lt=&Apache::lonlocal::texthash(
1.571     raeburn  11613:                     'youm'      => "You must include some text to search for.",
                   11614:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   11615:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   11616:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   11617:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   11618:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   11619:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   11620:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  11621:                                        );
1.1222    damieng  11622:     &html_escape(\%html_lt);
                   11623:     &js_escape(\%js_lt);
1.1255    raeburn  11624:     my $domform;
1.1277    raeburn  11625:     my $allow_blank = 1;
1.1255    raeburn  11626:     if ($fixeddom) {
1.1277    raeburn  11627:         $allow_blank = 0;
                   11628:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,[$currdom]);
1.1255    raeburn  11629:     } else {
1.1287    raeburn  11630:         my $defdom = $env{'request.role.domain'};
1.1288    raeburn  11631:         my ($trusted,$untrusted);
1.1287    raeburn  11632:         if (($context eq 'requestcrs') || ($context eq 'course')) {
1.1288    raeburn  11633:             ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('enroll',$defdom);
1.1287    raeburn  11634:         } elsif ($context eq 'author') {
1.1288    raeburn  11635:             ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('othcoau',$defdom);
1.1287    raeburn  11636:         } elsif ($context eq 'domain') {
1.1288    raeburn  11637:             ($trusted,$untrusted) = &Apache::lonnet::trusted_domains('domroles',$defdom);
1.1287    raeburn  11638:         }
1.1288    raeburn  11639:         $domform = &select_dom_form($currdom,'srchdomain',$allow_blank,1,undef,$trusted,$untrusted);
1.1255    raeburn  11640:     }
1.563     raeburn  11641:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  11642: 
                   11643:     my @srchins = ('crs','dom','alc','instd');
                   11644: 
                   11645:     foreach my $option (@srchins) {
                   11646:         # FIXME 'alc' option unavailable until 
                   11647:         #       loncreateuser::print_user_query_page()
                   11648:         #       has been completed.
                   11649:         next if ($option eq 'alc');
1.880     raeburn  11650:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  11651:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.1279    raeburn  11652:         next if (($option eq 'instd') && ($noinstd));
1.563     raeburn  11653:         if ($curr_selected{'srchin'} eq $option) {
                   11654:             $srchinsel .= ' 
1.1222    damieng  11655:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.563     raeburn  11656:         } else {
                   11657:             $srchinsel .= '
1.1222    damieng  11658:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.563     raeburn  11659:         }
1.555     raeburn  11660:     }
1.563     raeburn  11661:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  11662: 
                   11663:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  11664:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  11665:         if ($curr_selected{'srchby'} eq $option) {
                   11666:             $srchbysel .= '
1.1222    damieng  11667:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  11668:         } else {
                   11669:             $srchbysel .= '
1.1222    damieng  11670:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  11671:          }
                   11672:     }
                   11673:     $srchbysel .= "\n  </select>\n";
                   11674: 
                   11675:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  11676:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  11677:         if ($curr_selected{'srchtype'} eq $option) {
                   11678:             $srchtypesel .= '
1.1222    damieng  11679:    <option value="'.$option.'" selected="selected">'.$html_lt{$option}.'</option>';
1.555     raeburn  11680:         } else {
                   11681:             $srchtypesel .= '
1.1222    damieng  11682:    <option value="'.$option.'">'.$html_lt{$option}.'</option>';
1.555     raeburn  11683:         }
                   11684:     }
                   11685:     $srchtypesel .= "\n  </select>\n";
                   11686: 
1.558     albertel 11687:     my ($newuserscript,$new_user_create);
1.994     raeburn  11688:     my $context_dom = $env{'request.role.domain'};
                   11689:     if ($context eq 'requestcrs') {
                   11690:         if ($env{'form.coursedom'} ne '') { 
                   11691:             $context_dom = $env{'form.coursedom'};
                   11692:         }
                   11693:     }
1.556     raeburn  11694:     if ($forcenewuser) {
1.576     raeburn  11695:         if (ref($srch) eq 'HASH') {
1.994     raeburn  11696:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) {
1.627     raeburn  11697:                 if ($cancreate) {
                   11698:                     $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>';
                   11699:                 } else {
1.799     bisitz   11700:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  11701:                     my %usertypetext = (
                   11702:                         official   => 'institutional',
                   11703:                         unofficial => 'non-institutional',
                   11704:                     );
1.799     bisitz   11705:                     $new_user_create = '<p class="LC_warning">'
                   11706:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   11707:                                       .' '
                   11708:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   11709:                                           ,'<a href="'.$helplink.'">','</a>')
                   11710:                                       .'</p><br />';
1.627     raeburn  11711:                 }
1.576     raeburn  11712:             }
                   11713:         }
                   11714: 
1.556     raeburn  11715:         $newuserscript = <<"ENDSCRIPT";
                   11716: 
1.570     raeburn  11717: function setSearch(createnew,callingForm) {
1.556     raeburn  11718:     if (createnew == 1) {
1.570     raeburn  11719:         for (var i=0; i<callingForm.srchby.length; i++) {
                   11720:             if (callingForm.srchby.options[i].value == 'uname') {
                   11721:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  11722:             }
                   11723:         }
1.570     raeburn  11724:         for (var i=0; i<callingForm.srchin.length; i++) {
                   11725:             if ( callingForm.srchin.options[i].value == 'dom') {
                   11726: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  11727:             }
                   11728:         }
1.570     raeburn  11729:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   11730:             if (callingForm.srchtype.options[i].value == 'exact') {
                   11731:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  11732:             }
                   11733:         }
1.570     raeburn  11734:         for (var i=0; i<callingForm.srchdomain.length; i++) {
1.994     raeburn  11735:             if (callingForm.srchdomain.options[i].value == '$context_dom') {
1.570     raeburn  11736:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  11737:             }
                   11738:         }
                   11739:     }
                   11740: }
                   11741: ENDSCRIPT
1.558     albertel 11742: 
1.556     raeburn  11743:     }
                   11744: 
1.555     raeburn  11745:     my $output = <<"END_BLOCK";
1.556     raeburn  11746: <script type="text/javascript">
1.824     bisitz   11747: // <![CDATA[
1.570     raeburn  11748: function validateEntry(callingForm) {
1.558     albertel 11749: 
1.556     raeburn  11750:     var checkok = 1;
1.558     albertel 11751:     var srchin;
1.570     raeburn  11752:     for (var i=0; i<callingForm.srchin.length; i++) {
                   11753: 	if ( callingForm.srchin[i].checked ) {
                   11754: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 11755: 	}
                   11756:     }
                   11757: 
1.570     raeburn  11758:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   11759:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   11760:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   11761:     var srchterm =  callingForm.srchterm.value;
                   11762:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  11763:     var msg = "";
                   11764: 
                   11765:     if (srchterm == "") {
                   11766:         checkok = 0;
1.1222    damieng  11767:         msg += "$js_lt{'youm'}\\n";
1.556     raeburn  11768:     }
                   11769: 
1.569     raeburn  11770:     if (srchtype== 'begins') {
                   11771:         if (srchterm.length < 2) {
                   11772:             checkok = 0;
1.1222    damieng  11773:             msg += "$js_lt{'thte'}\\n";
1.569     raeburn  11774:         }
                   11775:     }
                   11776: 
1.556     raeburn  11777:     if (srchtype== 'contains') {
                   11778:         if (srchterm.length < 3) {
                   11779:             checkok = 0;
1.1222    damieng  11780:             msg += "$js_lt{'thet'}\\n";
1.556     raeburn  11781:         }
                   11782:     }
                   11783:     if (srchin == 'instd') {
                   11784:         if (srchdomain == '') {
                   11785:             checkok = 0;
1.1222    damieng  11786:             msg += "$js_lt{'yomc'}\\n";
1.556     raeburn  11787:         }
                   11788:     }
                   11789:     if (srchin == 'dom') {
                   11790:         if (srchdomain == '') {
                   11791:             checkok = 0;
1.1222    damieng  11792:             msg += "$js_lt{'ymcd'}\\n";
1.556     raeburn  11793:         }
                   11794:     }
                   11795:     if (srchby == 'lastfirst') {
                   11796:         if (srchterm.indexOf(",") == -1) {
                   11797:             checkok = 0;
1.1222    damieng  11798:             msg += "$js_lt{'whus'}\\n";
1.556     raeburn  11799:         }
                   11800:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   11801:             checkok = 0;
1.1222    damieng  11802:             msg += "$js_lt{'whse'}\\n";
1.556     raeburn  11803:         }
                   11804:     }
                   11805:     if (checkok == 0) {
1.1222    damieng  11806:         alert("$js_lt{'thfo'}\\n"+msg);
1.556     raeburn  11807:         return;
                   11808:     }
                   11809:     if (checkok == 1) {
1.570     raeburn  11810:         callingForm.submit();
1.556     raeburn  11811:     }
                   11812: }
                   11813: 
                   11814: $newuserscript
                   11815: 
1.824     bisitz   11816: // ]]>
1.556     raeburn  11817: </script>
1.558     albertel 11818: 
                   11819: $new_user_create
                   11820: 
1.555     raeburn  11821: END_BLOCK
1.558     albertel 11822: 
1.876     raeburn  11823:     $output .= &Apache::lonhtmlcommon::start_pick_box().
1.1222    damieng  11824:                &Apache::lonhtmlcommon::row_title($html_lt{'doma'}).
1.876     raeburn  11825:                $domform.
                   11826:                &Apache::lonhtmlcommon::row_closure().
1.1222    damieng  11827:                &Apache::lonhtmlcommon::row_title($html_lt{'usr'}).
1.876     raeburn  11828:                $srchbysel.
                   11829:                $srchtypesel. 
                   11830:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   11831:                $srchinsel.
                   11832:                &Apache::lonhtmlcommon::row_closure(1). 
                   11833:                &Apache::lonhtmlcommon::end_pick_box().
                   11834:                '<br />';
1.1253    raeburn  11835:     return ($output,1);
1.555     raeburn  11836: }
                   11837: 
1.612     raeburn  11838: sub user_rule_check {
1.615     raeburn  11839:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.1226    raeburn  11840:     my ($response,%inst_response);
1.612     raeburn  11841:     if (ref($usershash) eq 'HASH') {
1.1226    raeburn  11842:         if (keys(%{$usershash}) > 1) {
                   11843:             my (%by_username,%by_id,%userdoms);
                   11844:             my $checkid; 
                   11845:             if (ref($checks) eq 'HASH') {
                   11846:                 if ((!defined($checks->{'username'})) && (defined($checks->{'id'}))) {
                   11847:                     $checkid = 1;
                   11848:                 }
                   11849:             }
                   11850:             foreach my $user (keys(%{$usershash})) {
                   11851:                 my ($uname,$udom) = split(/:/,$user);
                   11852:                 if ($checkid) {
                   11853:                     if (ref($usershash->{$user}) eq 'HASH') {
                   11854:                         if ($usershash->{$user}->{'id'} ne '') {
1.1227    raeburn  11855:                             $by_id{$udom}{$usershash->{$user}->{'id'}} = $uname; 
1.1226    raeburn  11856:                             $userdoms{$udom} = 1;
1.1227    raeburn  11857:                             if (ref($inst_results) eq 'HASH') {
                   11858:                                 $inst_results->{$uname.':'.$udom} = {};
                   11859:                             }
1.1226    raeburn  11860:                         }
                   11861:                     }
                   11862:                 } else {
                   11863:                     $by_username{$udom}{$uname} = 1;
                   11864:                     $userdoms{$udom} = 1;
1.1227    raeburn  11865:                     if (ref($inst_results) eq 'HASH') {
                   11866:                         $inst_results->{$uname.':'.$udom} = {};
                   11867:                     }
1.1226    raeburn  11868:                 }
                   11869:             }
                   11870:             foreach my $udom (keys(%userdoms)) {
                   11871:                 if (!$got_rules->{$udom}) {
                   11872:                     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   11873:                                                              ['usercreation'],$udom);
                   11874:                     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   11875:                         foreach my $item ('username','id') {
                   11876:                             if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
1.1227    raeburn  11877:                                 $$curr_rules{$udom}{$item} =
                   11878:                                     $domconfig{'usercreation'}{$item.'_rule'};
1.1226    raeburn  11879:                             }
                   11880:                         }
                   11881:                     }
                   11882:                     $got_rules->{$udom} = 1;
                   11883:                 }
1.612     raeburn  11884:             }
1.1226    raeburn  11885:             if ($checkid) {
                   11886:                 foreach my $udom (keys(%by_id)) {
                   11887:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_id{$udom},'id');
                   11888:                     if ($outcome eq 'ok') {
1.1227    raeburn  11889:                         foreach my $id (keys(%{$by_id{$udom}})) {
                   11890:                             my $uname = $by_id{$udom}{$id};
                   11891:                             $inst_response{$uname.':'.$udom} = $outcome;
                   11892:                         }
1.1226    raeburn  11893:                         if (ref($results) eq 'HASH') {
                   11894:                             foreach my $uname (keys(%{$results})) {
1.1227    raeburn  11895:                                 if (exists($inst_response{$uname.':'.$udom})) {
                   11896:                                     $inst_response{$uname.':'.$udom} = $outcome;
                   11897:                                     $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   11898:                                 }
1.1226    raeburn  11899:                             }
                   11900:                         }
                   11901:                     }
1.612     raeburn  11902:                 }
1.615     raeburn  11903:             } else {
1.1226    raeburn  11904:                 foreach my $udom (keys(%by_username)) {
                   11905:                     my ($outcome,$results) = &Apache::lonnet::get_multiple_instusers($udom,$by_username{$udom});
                   11906:                     if ($outcome eq 'ok') {
1.1227    raeburn  11907:                         foreach my $uname (keys(%{$by_username{$udom}})) {
                   11908:                             $inst_response{$uname.':'.$udom} = $outcome;
                   11909:                         }
1.1226    raeburn  11910:                         if (ref($results) eq 'HASH') {
                   11911:                             foreach my $uname (keys(%{$results})) {
                   11912:                                 $inst_results->{$uname.':'.$udom} = $results->{$uname};
                   11913:                             }
                   11914:                         }
                   11915:                     }
                   11916:                 }
1.612     raeburn  11917:             }
1.1226    raeburn  11918:         } elsif (keys(%{$usershash}) == 1) {
                   11919:             my $user = (keys(%{$usershash}))[0];
                   11920:             my ($uname,$udom) = split(/:/,$user);
                   11921:             if (($udom ne '') && ($uname ne '')) {
                   11922:                 if (ref($usershash->{$user}) eq 'HASH') {
                   11923:                     if (ref($checks) eq 'HASH') {
                   11924:                         if (defined($checks->{'username'})) {
                   11925:                             ($inst_response{$user},%{$inst_results->{$user}}) = 
                   11926:                                 &Apache::lonnet::get_instuser($udom,$uname);
                   11927:                         } elsif (defined($checks->{'id'})) {
                   11928:                             if ($usershash->{$user}->{'id'} ne '') {
                   11929:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   11930:                                     &Apache::lonnet::get_instuser($udom,undef,
                   11931:                                                                   $usershash->{$user}->{'id'});
                   11932:                             } else {
                   11933:                                 ($inst_response{$user},%{$inst_results->{$user}}) =
                   11934:                                     &Apache::lonnet::get_instuser($udom,$uname);
                   11935:                             }
1.585     raeburn  11936:                         }
1.1226    raeburn  11937:                     } else {
                   11938:                        ($inst_response{$user},%{$inst_results->{$user}}) =
                   11939:                             &Apache::lonnet::get_instuser($udom,$uname);
                   11940:                        return;
                   11941:                     }
                   11942:                     if (!$got_rules->{$udom}) {
                   11943:                         my %domconfig = &Apache::lonnet::get_dom('configuration',
                   11944:                                                                  ['usercreation'],$udom);
                   11945:                         if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   11946:                             foreach my $item ('username','id') {
                   11947:                                 if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   11948:                                    $$curr_rules{$udom}{$item} = 
                   11949:                                        $domconfig{'usercreation'}{$item.'_rule'};
                   11950:                                 }
                   11951:                             }
                   11952:                         }
                   11953:                         $got_rules->{$udom} = 1;
1.585     raeburn  11954:                     }
                   11955:                 }
1.1226    raeburn  11956:             } else {
                   11957:                 return;
                   11958:             }
                   11959:         } else {
                   11960:             return;
                   11961:         }
                   11962:         foreach my $user (keys(%{$usershash})) {
                   11963:             my ($uname,$udom) = split(/:/,$user);
                   11964:             next if (($udom eq '') || ($uname eq ''));
                   11965:             my $id;
1.1227    raeburn  11966:             if (ref($inst_results) eq 'HASH') {
                   11967:                 if (ref($inst_results->{$user}) eq 'HASH') {
                   11968:                     $id = $inst_results->{$user}->{'id'};
                   11969:                 }
                   11970:             }
                   11971:             if ($id eq '') { 
                   11972:                 if (ref($usershash->{$user})) {
                   11973:                     $id = $usershash->{$user}->{'id'};
                   11974:                 }
1.585     raeburn  11975:             }
1.612     raeburn  11976:             foreach my $item (keys(%{$checks})) {
                   11977:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   11978:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   11979:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
1.1226    raeburn  11980:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,
                   11981:                                                                              $$curr_rules{$udom}{$item});
1.612     raeburn  11982:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   11983:                                 if ($rule_check{$rule}) {
                   11984:                                     $$rulematch{$user}{$item} = $rule;
1.1226    raeburn  11985:                                     if ($inst_response{$user} eq 'ok') {
1.615     raeburn  11986:                                         if (ref($inst_results) eq 'HASH') {
                   11987:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   11988:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   11989:                                                     $$alerts{$item}{$udom}{$uname} = 1;
1.1227    raeburn  11990:                                                 } elsif ($item eq 'id') {
                   11991:                                                     if ($inst_results->{$user}->{'id'} eq '') {
                   11992:                                                         $$alerts{$item}{$udom}{$uname} = 1;
                   11993:                                                     }
1.615     raeburn  11994:                                                 }
1.612     raeburn  11995:                                             }
                   11996:                                         }
1.615     raeburn  11997:                                     }
                   11998:                                     last;
1.585     raeburn  11999:                                 }
                   12000:                             }
                   12001:                         }
                   12002:                     }
                   12003:                 }
                   12004:             }
                   12005:         }
                   12006:     }
1.612     raeburn  12007:     return;
                   12008: }
                   12009: 
                   12010: sub user_rule_formats {
                   12011:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   12012:     my %text = ( 
                   12013:                  'username' => 'Usernames',
                   12014:                  'id'       => 'IDs',
                   12015:                );
                   12016:     my $output;
                   12017:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   12018:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   12019:         if (@{$ruleorder} > 0) {
1.1102    raeburn  12020:             $output = '<br />'.
                   12021:                       &mt($text{$check}.' with the following format(s) may [_1]only[_2] be used for verified users at [_3]:',
                   12022:                           '<span class="LC_cusr_emph">','</span>',$domdesc).
                   12023:                       ' <ul>';
1.612     raeburn  12024:             foreach my $rule (@{$ruleorder}) {
                   12025:                 if (ref($curr_rules) eq 'ARRAY') {
                   12026:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   12027:                         if (ref($rules->{$rule}) eq 'HASH') {
                   12028:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   12029:                                         $rules->{$rule}{'desc'}.'</li>';
                   12030:                         }
                   12031:                     }
                   12032:                 }
                   12033:             }
                   12034:             $output .= '</ul>';
                   12035:         }
                   12036:     }
                   12037:     return $output;
                   12038: }
                   12039: 
                   12040: sub instrule_disallow_msg {
1.615     raeburn  12041:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  12042:     my $response;
                   12043:     my %text = (
                   12044:                   item   => 'username',
                   12045:                   items  => 'usernames',
                   12046:                   match  => 'matches',
                   12047:                   do     => 'does',
                   12048:                   action => 'a username',
                   12049:                   one    => 'one',
                   12050:                );
                   12051:     if ($count > 1) {
                   12052:         $text{'item'} = 'usernames';
                   12053:         $text{'match'} ='match';
                   12054:         $text{'do'} = 'do';
                   12055:         $text{'action'} = 'usernames',
                   12056:         $text{'one'} = 'ones';
                   12057:     }
                   12058:     if ($checkitem eq 'id') {
                   12059:         $text{'items'} = 'IDs';
                   12060:         $text{'item'} = 'ID';
                   12061:         $text{'action'} = 'an ID';
1.615     raeburn  12062:         if ($count > 1) {
                   12063:             $text{'item'} = 'IDs';
                   12064:             $text{'action'} = 'IDs';
                   12065:         }
1.612     raeburn  12066:     }
1.674     bisitz   12067:     $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  12068:     if ($mode eq 'upload') {
                   12069:         if ($checkitem eq 'username') {
                   12070:             $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'}.");
                   12071:         } elsif ($checkitem eq 'id') {
1.674     bisitz   12072:             $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  12073:         }
1.669     raeburn  12074:     } elsif ($mode eq 'selfcreate') {
                   12075:         if ($checkitem eq 'id') {
                   12076:             $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.");
                   12077:         }
1.615     raeburn  12078:     } else {
                   12079:         if ($checkitem eq 'username') {
                   12080:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   12081:         } elsif ($checkitem eq 'id') {
                   12082:             $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.");
                   12083:         }
1.612     raeburn  12084:     }
                   12085:     return $response;
1.585     raeburn  12086: }
                   12087: 
1.624     raeburn  12088: sub personal_data_fieldtitles {
                   12089:     my %fieldtitles = &Apache::lonlocal::texthash (
                   12090:                         id => 'Student/Employee ID',
                   12091:                         permanentemail => 'E-mail address',
                   12092:                         lastname => 'Last Name',
                   12093:                         firstname => 'First Name',
                   12094:                         middlename => 'Middle Name',
                   12095:                         generation => 'Generation',
                   12096:                         gen => 'Generation',
1.765     raeburn  12097:                         inststatus => 'Affiliation',
1.624     raeburn  12098:                    );
                   12099:     return %fieldtitles;
                   12100: }
                   12101: 
1.642     raeburn  12102: sub sorted_inst_types {
                   12103:     my ($dom) = @_;
1.1185    raeburn  12104:     my ($usertypes,$order);
                   12105:     my %domdefaults = &Apache::lonnet::get_domain_defaults($dom);
                   12106:     if (ref($domdefaults{'inststatus'}) eq 'HASH') {
                   12107:         $usertypes = $domdefaults{'inststatus'}{'inststatustypes'};
                   12108:         $order = $domdefaults{'inststatus'}{'inststatusorder'};
                   12109:     } else {
                   12110:         ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   12111:     }
1.642     raeburn  12112:     my $othertitle = &mt('All users');
                   12113:     if ($env{'request.course.id'}) {
1.668     raeburn  12114:         $othertitle  = &mt('Any users');
1.642     raeburn  12115:     }
                   12116:     my @types;
                   12117:     if (ref($order) eq 'ARRAY') {
                   12118:         @types = @{$order};
                   12119:     }
                   12120:     if (@types == 0) {
                   12121:         if (ref($usertypes) eq 'HASH') {
                   12122:             @types = sort(keys(%{$usertypes}));
                   12123:         }
                   12124:     }
                   12125:     if (keys(%{$usertypes}) > 0) {
                   12126:         $othertitle = &mt('Other users');
                   12127:     }
                   12128:     return ($othertitle,$usertypes,\@types);
                   12129: }
                   12130: 
1.645     raeburn  12131: sub get_institutional_codes {
1.1361    raeburn  12132:     my ($cdom,$crs,$settings,$allcourses,$LC_code) = @_;
1.645     raeburn  12133: # Get complete list of course sections to update
                   12134:     my @currsections = ();
                   12135:     my @currxlists = ();
1.1361    raeburn  12136:     my (%unclutteredsec,%unclutteredlcsec);
1.645     raeburn  12137:     my $coursecode = $$settings{'internal.coursecode'};
1.1361    raeburn  12138:     my $crskey = $crs.':'.$coursecode;
                   12139:     @{$unclutteredsec{$crskey}} = ();
                   12140:     @{$unclutteredlcsec{$crskey}} = ();
1.645     raeburn  12141: 
                   12142:     if ($$settings{'internal.sectionnums'} ne '') {
                   12143:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   12144:     }
                   12145: 
                   12146:     if ($$settings{'internal.crosslistings'} ne '') {
                   12147:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   12148:     }
                   12149: 
                   12150:     if (@currxlists > 0) {
1.1361    raeburn  12151:         foreach my $xl (@currxlists) {
                   12152:             if ($xl =~ /^([^:]+):(\w*)$/) {
1.645     raeburn  12153:                 unless (grep/^$1$/,@{$allcourses}) {
1.1263    raeburn  12154:                     push(@{$allcourses},$1);
1.645     raeburn  12155:                     $$LC_code{$1} = $2;
                   12156:                 }
                   12157:             }
                   12158:         }
                   12159:     }
1.1361    raeburn  12160: 
1.645     raeburn  12161:     if (@currsections > 0) {
1.1361    raeburn  12162:         foreach my $sec (@currsections) {
                   12163:             if ($sec =~ m/^(\w+):(\w*)$/ ) {
                   12164:                 my $instsec = $1;
1.645     raeburn  12165:                 my $lc_sec = $2;
1.1361    raeburn  12166:                 unless (grep/^\Q$instsec\E$/,@{$unclutteredsec{$crskey}}) {
                   12167:                     push(@{$unclutteredsec{$crskey}},$instsec);
                   12168:                     push(@{$unclutteredlcsec{$crskey}},$lc_sec);
                   12169:                 }
                   12170:             }
                   12171:         }
                   12172:     }
                   12173: 
                   12174:     if (@{$unclutteredsec{$crskey}} > 0) {
                   12175:         my %formattedsec = &Apache::lonnet::auto_instsec_reformat($cdom,'clutter',\%unclutteredsec);
                   12176:         if ((ref($formattedsec{$crskey}) eq 'ARRAY') && (ref($unclutteredlcsec{$crskey}) eq 'ARRAY')) {
                   12177:             for (my $i=0; $i<@{$formattedsec{$crskey}}; $i++) {
                   12178:                 my $sec = $coursecode.$formattedsec{$crskey}[$i];
                   12179:                 unless (grep/^\Q$sec\E$/,@{$allcourses}) {
1.1263    raeburn  12180:                     push(@{$allcourses},$sec);
1.1361    raeburn  12181:                     $$LC_code{$sec} = $unclutteredlcsec{$crskey}[$i];
1.645     raeburn  12182:                 }
                   12183:             }
                   12184:         }
                   12185:     }
                   12186:     return;
                   12187: }
                   12188: 
1.971     raeburn  12189: sub get_standard_codeitems {
                   12190:     return ('Year','Semester','Department','Number','Section');
                   12191: }
                   12192: 
1.112     bowersj2 12193: =pod
                   12194: 
1.780     raeburn  12195: =head1 Slot Helpers
                   12196: 
                   12197: =over 4
                   12198: 
                   12199: =item * sorted_slots()
                   12200: 
1.1040    raeburn  12201: Sorts an array of slot names in order of an optional sort key,
                   12202: default sort is by slot start time (earliest first). 
1.780     raeburn  12203: 
                   12204: Inputs:
                   12205: 
                   12206: =over 4
                   12207: 
                   12208: slotsarr  - Reference to array of unsorted slot names.
                   12209: 
                   12210: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   12211: 
1.1040    raeburn  12212: sortkey   - Name of key in inner hash to be sorted on (e.g., starttime).
                   12213: 
1.549     albertel 12214: =back
                   12215: 
1.780     raeburn  12216: Returns:
                   12217: 
                   12218: =over 4
                   12219: 
1.1040    raeburn  12220: sorted   - An array of slot names sorted by a specified sort key 
                   12221:            (default sort key is start time of the slot).
1.780     raeburn  12222: 
                   12223: =back
                   12224: 
                   12225: =cut
                   12226: 
                   12227: 
                   12228: sub sorted_slots {
1.1040    raeburn  12229:     my ($slotsarr,$slots,$sortkey) = @_;
                   12230:     if ($sortkey eq '') {
                   12231:         $sortkey = 'starttime';
                   12232:     }
1.780     raeburn  12233:     my @sorted;
                   12234:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   12235:         @sorted =
                   12236:             sort {
                   12237:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
1.1040    raeburn  12238:                          return $slots->{$a}{$sortkey} <=> $slots->{$b}{$sortkey}
1.780     raeburn  12239:                      }
                   12240:                      if (ref($slots->{$a})) { return -1;}
                   12241:                      if (ref($slots->{$b})) { return 1;}
                   12242:                      return 0;
                   12243:                  } @{$slotsarr};
                   12244:     }
                   12245:     return @sorted;
                   12246: }
                   12247: 
1.1040    raeburn  12248: =pod
                   12249: 
                   12250: =item * get_future_slots()
                   12251: 
                   12252: Inputs:
                   12253: 
                   12254: =over 4
                   12255: 
                   12256: cnum - course number
                   12257: 
                   12258: cdom - course domain
                   12259: 
                   12260: now - current UNIX time
                   12261: 
                   12262: symb - optional symb
                   12263: 
                   12264: =back
                   12265: 
                   12266: Returns:
                   12267: 
                   12268: =over 4
                   12269: 
                   12270: sorted_reservable - ref to array of student_schedulable slots currently 
                   12271:                     reservable, ordered by end date of reservation period.
                   12272: 
                   12273: reservable_now - ref to hash of student_schedulable slots currently
                   12274:                  reservable.
                   12275: 
                   12276:     Keys in inner hash are:
                   12277:     (a) symb: either blank or symb to which slot use is restricted.
1.1250    raeburn  12278:     (b) endreserve: end date of reservation period.
                   12279:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   12280:         selected.
1.1040    raeburn  12281: 
                   12282: sorted_future - ref to array of student_schedulable slots reservable in
                   12283:                 the future, ordered by start date of reservation period.
                   12284: 
                   12285: future_reservable - ref to hash of student_schedulable slots reservable
                   12286:                     in the future.
                   12287: 
                   12288:     Keys in inner hash are:
                   12289:     (a) symb: either blank or symb to which slot use is restricted.
1.1250    raeburn  12290:     (b) startreserve: start date of reservation period.
                   12291:     (c) uniqueperiod: start,end dates when slot is to be uniquely
                   12292:         selected.
1.1040    raeburn  12293: 
                   12294: =back
                   12295: 
                   12296: =cut
                   12297: 
                   12298: sub get_future_slots {
                   12299:     my ($cnum,$cdom,$now,$symb) = @_;
1.1229    raeburn  12300:     my $map;
                   12301:     if ($symb) {
                   12302:         ($map) = &Apache::lonnet::decode_symb($symb);
                   12303:     }
1.1040    raeburn  12304:     my (%reservable_now,%future_reservable,@sorted_reservable,@sorted_future);
                   12305:     my %slots = &Apache::lonnet::get_course_slots($cnum,$cdom);
                   12306:     foreach my $slot (keys(%slots)) {
                   12307:         next unless($slots{$slot}->{'type'} eq 'schedulable_student');
                   12308:         if ($symb) {
1.1229    raeburn  12309:             if ($slots{$slot}->{'symb'} ne '') {
                   12310:                 my $canuse;
                   12311:                 my %oksymbs;
                   12312:                 my @slotsymbs = split(/\s*,\s*/,$slots{$slot}->{'symb'});
                   12313:                 map { $oksymbs{$_} = 1; } @slotsymbs;
                   12314:                 if ($oksymbs{$symb}) {
                   12315:                     $canuse = 1;
                   12316:                 } else {
                   12317:                     foreach my $item (@slotsymbs) {
                   12318:                         if ($item =~ /\.(page|sequence)$/) {
                   12319:                             (undef,undef,my $sloturl) = &Apache::lonnet::decode_symb($item);
                   12320:                             if (($map ne '') && ($map eq $sloturl)) {
                   12321:                                 $canuse = 1;
                   12322:                                 last;
                   12323:                             }
                   12324:                         }
                   12325:                     }
                   12326:                 }
                   12327:                 next unless ($canuse);
                   12328:             }
1.1040    raeburn  12329:         }
                   12330:         if (($slots{$slot}->{'starttime'} > $now) &&
                   12331:             ($slots{$slot}->{'endtime'} > $now)) {
                   12332:             if (($slots{$slot}->{'allowedsections'}) || ($slots{$slot}->{'allowedusers'})) {
                   12333:                 my $userallowed = 0;
                   12334:                 if ($slots{$slot}->{'allowedsections'}) {
                   12335:                     my @allowed_sec = split(',',$slots{$slot}->{'allowedsections'});
                   12336:                     if (!defined($env{'request.role.sec'})
                   12337:                         && grep(/^No section assigned$/,@allowed_sec)) {
                   12338:                         $userallowed=1;
                   12339:                     } else {
                   12340:                         if (grep(/^\Q$env{'request.role.sec'}\E$/,@allowed_sec)) {
                   12341:                             $userallowed=1;
                   12342:                         }
                   12343:                     }
                   12344:                     unless ($userallowed) {
                   12345:                         if (defined($env{'request.course.groups'})) {
                   12346:                             my @groups = split(/:/,$env{'request.course.groups'});
                   12347:                             foreach my $group (@groups) {
                   12348:                                 if (grep(/^\Q$group\E$/,@allowed_sec)) {
                   12349:                                     $userallowed=1;
                   12350:                                     last;
                   12351:                                 }
                   12352:                             }
                   12353:                         }
                   12354:                     }
                   12355:                 }
                   12356:                 if ($slots{$slot}->{'allowedusers'}) {
                   12357:                     my @allowed_users = split(',',$slots{$slot}->{'allowedusers'});
                   12358:                     my $user = $env{'user.name'}.':'.$env{'user.domain'};
                   12359:                     if (grep(/^\Q$user\E$/,@allowed_users)) {
                   12360:                         $userallowed = 1;
                   12361:                     }
                   12362:                 }
                   12363:                 next unless($userallowed);
                   12364:             }
                   12365:             my $startreserve = $slots{$slot}->{'startreserve'};
                   12366:             my $endreserve = $slots{$slot}->{'endreserve'};
                   12367:             my $symb = $slots{$slot}->{'symb'};
1.1250    raeburn  12368:             my $uniqueperiod;
                   12369:             if (ref($slots{$slot}->{'uniqueperiod'}) eq 'ARRAY') {
                   12370:                 $uniqueperiod = join(',',@{$slots{$slot}->{'uniqueperiod'}});
                   12371:             }
1.1040    raeburn  12372:             if (($startreserve < $now) &&
                   12373:                 (!$endreserve || $endreserve > $now)) {
                   12374:                 my $lastres = $endreserve;
                   12375:                 if (!$lastres) {
                   12376:                     $lastres = $slots{$slot}->{'starttime'};
                   12377:                 }
                   12378:                 $reservable_now{$slot} = {
                   12379:                                            symb       => $symb,
1.1250    raeburn  12380:                                            endreserve => $lastres,
                   12381:                                            uniqueperiod => $uniqueperiod,
1.1040    raeburn  12382:                                          };
                   12383:             } elsif (($startreserve > $now) &&
                   12384:                      (!$endreserve || $endreserve > $startreserve)) {
                   12385:                 $future_reservable{$slot} = {
                   12386:                                               symb         => $symb,
1.1250    raeburn  12387:                                               startreserve => $startreserve,
                   12388:                                               uniqueperiod => $uniqueperiod,
1.1040    raeburn  12389:                                             };
                   12390:             }
                   12391:         }
                   12392:     }
                   12393:     my @unsorted_reservable = keys(%reservable_now);
                   12394:     if (@unsorted_reservable > 0) {
                   12395:         @sorted_reservable = 
                   12396:             &sorted_slots(\@unsorted_reservable,\%reservable_now,'endreserve');
                   12397:     }
                   12398:     my @unsorted_future = keys(%future_reservable);
                   12399:     if (@unsorted_future > 0) {
                   12400:         @sorted_future =
                   12401:             &sorted_slots(\@unsorted_future,\%future_reservable,'startreserve');
                   12402:     }
                   12403:     return (\@sorted_reservable,\%reservable_now,\@sorted_future,\%future_reservable);
                   12404: }
1.780     raeburn  12405: 
                   12406: =pod
                   12407: 
1.1057    foxr     12408: =back
                   12409: 
1.549     albertel 12410: =head1 HTTP Helpers
                   12411: 
                   12412: =over 4
                   12413: 
1.648     raeburn  12414: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 12415: 
1.258     albertel 12416: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 12417: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 12418: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 12419: 
                   12420: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   12421: $possible_names is an ref to an array of form element names.  As an example:
                   12422: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 12423: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 12424: 
                   12425: =cut
1.1       albertel 12426: 
1.6       albertel 12427: sub get_unprocessed_cgi {
1.25      albertel 12428:   my ($query,$possible_names)= @_;
1.26      matthew  12429:   # $Apache::lonxml::debug=1;
1.356     albertel 12430:   foreach my $pair (split(/&/,$query)) {
                   12431:     my ($name, $value) = split(/=/,$pair);
1.369     www      12432:     $name = &unescape($name);
1.25      albertel 12433:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   12434:       $value =~ tr/+/ /;
                   12435:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 12436:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 12437:     }
1.16      harris41 12438:   }
1.6       albertel 12439: }
                   12440: 
1.112     bowersj2 12441: =pod
                   12442: 
1.648     raeburn  12443: =item * &cacheheader() 
1.112     bowersj2 12444: 
                   12445: returns cache-controlling header code
                   12446: 
                   12447: =cut
                   12448: 
1.7       albertel 12449: sub cacheheader {
1.258     albertel 12450:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 12451:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   12452:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 12453:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   12454:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 12455:     return $output;
1.7       albertel 12456: }
                   12457: 
1.112     bowersj2 12458: =pod
                   12459: 
1.648     raeburn  12460: =item * &no_cache($r) 
1.112     bowersj2 12461: 
                   12462: specifies header code to not have cache
                   12463: 
                   12464: =cut
                   12465: 
1.9       albertel 12466: sub no_cache {
1.216     albertel 12467:     my ($r) = @_;
                   12468:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 12469: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 12470:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   12471:     $r->no_cache(1);
                   12472:     $r->header_out("Expires" => $date);
                   12473:     $r->header_out("Pragma" => "no-cache");
1.123     www      12474: }
                   12475: 
                   12476: sub content_type {
1.181     albertel 12477:     my ($r,$type,$charset) = @_;
1.299     foxr     12478:     if ($r) {
                   12479: 	#  Note that printout.pl calls this with undef for $r.
                   12480: 	&no_cache($r);
                   12481:     }
1.258     albertel 12482:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 12483:     unless ($charset) {
                   12484: 	$charset=&Apache::lonlocal::current_encoding;
                   12485:     }
                   12486:     if ($charset) { $type.='; charset='.$charset; }
                   12487:     if ($r) {
                   12488: 	$r->content_type($type);
                   12489:     } else {
                   12490: 	print("Content-type: $type\n\n");
                   12491:     }
1.9       albertel 12492: }
1.25      albertel 12493: 
1.112     bowersj2 12494: =pod
                   12495: 
1.648     raeburn  12496: =item * &add_to_env($name,$value) 
1.112     bowersj2 12497: 
1.258     albertel 12498: adds $name to the %env hash with value
1.112     bowersj2 12499: $value, if $name already exists, the entry is converted to an array
                   12500: reference and $value is added to the array.
                   12501: 
                   12502: =cut
                   12503: 
1.25      albertel 12504: sub add_to_env {
                   12505:   my ($name,$value)=@_;
1.258     albertel 12506:   if (defined($env{$name})) {
                   12507:     if (ref($env{$name})) {
1.25      albertel 12508:       #already have multiple values
1.258     albertel 12509:       push(@{ $env{$name} },$value);
1.25      albertel 12510:     } else {
                   12511:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 12512:       my $first=$env{$name};
                   12513:       undef($env{$name});
                   12514:       push(@{ $env{$name} },$first,$value);
1.25      albertel 12515:     }
                   12516:   } else {
1.258     albertel 12517:     $env{$name}=$value;
1.25      albertel 12518:   }
1.31      albertel 12519: }
1.149     albertel 12520: 
                   12521: =pod
                   12522: 
1.648     raeburn  12523: =item * &get_env_multiple($name) 
1.149     albertel 12524: 
1.258     albertel 12525: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 12526: values may be defined and end up as an array ref.
                   12527: 
                   12528: returns an array of values
                   12529: 
                   12530: =cut
                   12531: 
                   12532: sub get_env_multiple {
                   12533:     my ($name) = @_;
                   12534:     my @values;
1.258     albertel 12535:     if (defined($env{$name})) {
1.149     albertel 12536:         # exists is it an array
1.258     albertel 12537:         if (ref($env{$name})) {
                   12538:             @values=@{ $env{$name} };
1.149     albertel 12539:         } else {
1.258     albertel 12540:             $values[0]=$env{$name};
1.149     albertel 12541:         }
                   12542:     }
                   12543:     return(@values);
                   12544: }
                   12545: 
1.1249    damieng  12546: # Looks at given dependencies, and returns something depending on the context.
                   12547: # For coursedocs paste, returns (undef, $counter, $numpathchg, \%existing).
                   12548: # For syllabus rewrites, returns (undef, $counter, $numpathchg, \%existing, \%mapping).
                   12549: # For all other contexts, returns ($output, $counter, $numpathchg).
                   12550: # $output: string with the HTML output. Can contain missing dependencies with an upload form, existing dependencies, and dependencies no longer in use.
                   12551: # $counter: integer with the number of existing dependencies when no HTML output is returned, and the number of missing dependencies when an HTML output is returned.
                   12552: # $numpathchg: integer with the number of cleaned up dependency paths.
                   12553: # \%existing: hash reference clean path -> 1 only for existing dependencies.
                   12554: # \%mapping: hash reference clean path -> original path for all dependencies.
                   12555: # @param {string} actionurl - The path to the handler, indicative of the context.
                   12556: # @param {string} state - Can contain HTML with hidden inputs that will be added to the output form.
                   12557: # @param {hash reference} allfiles - List of file info from lonnet::extract_embedded_items
                   12558: # @param {hash reference} codebase - undef, not modified by lonnet::extract_embedded_items ?
                   12559: # @param {hash reference} args - More parameters ! Possible keys: error_on_invalid_names (boolean), ignore_remote_references (boolean), current_path (string), docs_url (string), docs_title (string), context (string)
                   12560: # @return {Array} - array depending on the context (not a reference)
1.660     raeburn  12561: sub ask_for_embedded_content {
1.1249    damieng  12562:     # NOTE: documentation was added afterwards, it could be wrong
1.660     raeburn  12563:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
1.1071    raeburn  12564:     my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges,
1.1085    raeburn  12565:         %currsubfile,%unused,$rem);
1.1071    raeburn  12566:     my $counter = 0;
                   12567:     my $numnew = 0;
1.987     raeburn  12568:     my $numremref = 0;
                   12569:     my $numinvalid = 0;
                   12570:     my $numpathchg = 0;
                   12571:     my $numexisting = 0;
1.1071    raeburn  12572:     my $numunused = 0;
                   12573:     my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath,$cdom,$cnum,
1.1156    raeburn  12574:         $fileloc,$filename,$delete_output,$modify_output,$title,$symb,$path,$navmap);
1.1071    raeburn  12575:     my $heading = &mt('Upload embedded files');
                   12576:     my $buttontext = &mt('Upload');
                   12577: 
1.1249    damieng  12578:     # fills these variables based on the context:
                   12579:     # $navmap, $cdom, $cnum, $udom, $uname, $url, $toplevel, $getpropath,
                   12580:     # $path, $fileloc, $title, $rem, $filename
1.1085    raeburn  12581:     if ($env{'request.course.id'}) {
1.1123    raeburn  12582:         if ($actionurl eq '/adm/dependencies') {
                   12583:             $navmap = Apache::lonnavmaps::navmap->new();
                   12584:         }
                   12585:         $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   12586:         $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1085    raeburn  12587:     }
1.1123    raeburn  12588:     if (($actionurl eq '/adm/portfolio') || 
                   12589:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.984     raeburn  12590:         my $current_path='/';
                   12591:         if ($env{'form.currentpath'}) {
                   12592:             $current_path = $env{'form.currentpath'};
                   12593:         }
                   12594:         if ($actionurl eq '/adm/coursegrp_portfolio') {
1.1123    raeburn  12595:             $udom = $cdom;
                   12596:             $uname = $cnum;
1.984     raeburn  12597:             $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio';
                   12598:         } else {
                   12599:             $udom = $env{'user.domain'};
                   12600:             $uname = $env{'user.name'};
                   12601:             $url = '/userfiles/portfolio';
                   12602:         }
1.987     raeburn  12603:         $toplevel = $url.'/';
1.984     raeburn  12604:         $url .= $current_path;
                   12605:         $getpropath = 1;
1.987     raeburn  12606:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') ||
                   12607:              ($actionurl eq '/adm/imsimport')) { 
1.1022    www      12608:         my ($udom,$uname,$rest) = ($args->{'current_path'} =~ m{/priv/($match_domain)/($match_username)/?(.*)$});
1.1026    raeburn  12609:         $url = $Apache::lonnet::perlvar{'lonDocRoot'}."/priv/$udom/$uname/";
1.987     raeburn  12610:         $toplevel = $url;
1.984     raeburn  12611:         if ($rest ne '') {
1.987     raeburn  12612:             $url .= $rest;
                   12613:         }
                   12614:     } elsif ($actionurl eq '/adm/coursedocs') {
                   12615:         if (ref($args) eq 'HASH') {
1.1071    raeburn  12616:             $url = $args->{'docs_url'};
                   12617:             $toplevel = $url;
1.1084    raeburn  12618:             if ($args->{'context'} eq 'paste') {
                   12619:                 ($cdom,$cnum) = ($url =~ m{^\Q/uploaded/\E($match_domain)/($match_courseid)/});
                   12620:                 ($path) = 
                   12621:                     ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   12622:                 $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   12623:                 $fileloc =~ s{^/}{};
                   12624:             }
1.1071    raeburn  12625:         }
1.1084    raeburn  12626:     } elsif ($actionurl eq '/adm/dependencies')  {
1.1071    raeburn  12627:         if ($env{'request.course.id'} ne '') {
                   12628:             if (ref($args) eq 'HASH') {
                   12629:                 $url = $args->{'docs_url'};
                   12630:                 $title = $args->{'docs_title'};
1.1126    raeburn  12631:                 $toplevel = $url; 
                   12632:                 unless ($toplevel =~ m{^/}) {
                   12633:                     $toplevel = "/$url";
                   12634:                 }
1.1085    raeburn  12635:                 ($rem) = ($toplevel =~ m{^(.+/)[^/]+$});
1.1126    raeburn  12636:                 if ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E)}) {
                   12637:                     $path = $1;
                   12638:                 } else {
                   12639:                     ($path) =
                   12640:                         ($toplevel =~ m{^(\Q/uploaded/$cdom/$cnum/\E(?:docs|supplemental)/(?:default|\d+)/\d+)/});
                   12641:                 }
1.1195    raeburn  12642:                 if ($toplevel=~/^\/*(uploaded|editupload)/) {
                   12643:                     $fileloc = $toplevel;
                   12644:                     $fileloc=~ s/^\s*(\S+)\s*$/$1/;
                   12645:                     my ($udom,$uname,$fname) =
                   12646:                         ($fileloc=~ m{^/+(?:uploaded|editupload)/+($match_domain)/+($match_name)/+(.*)$});
                   12647:                     $fileloc = propath($udom,$uname).'/userfiles/'.$fname;
                   12648:                 } else {
                   12649:                     $fileloc = &Apache::lonnet::filelocation('',$toplevel);
                   12650:                 }
1.1071    raeburn  12651:                 $fileloc =~ s{^/}{};
                   12652:                 ($filename) = ($fileloc =~ m{.+/([^/]+)$});
                   12653:                 $heading = &mt('Status of dependencies in [_1]',"$title ($filename)");
                   12654:             }
1.987     raeburn  12655:         }
1.1123    raeburn  12656:     } elsif ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   12657:         $udom = $cdom;
                   12658:         $uname = $cnum;
                   12659:         $url = "/uploaded/$cdom/$cnum/portfolio/syllabus";
                   12660:         $toplevel = $url;
                   12661:         $path = $url;
                   12662:         $fileloc = &Apache::lonnet::filelocation('',$toplevel).'/';
                   12663:         $fileloc =~ s{^/}{};
1.987     raeburn  12664:     }
1.1249    damieng  12665:     
                   12666:     # parses the dependency paths to get some info
                   12667:     # fills $newfiles, $mapping, $subdependencies, $dependencies
                   12668:     # $newfiles: hash URL -> 1 for new files or external URLs
                   12669:     # (will be completed later)
                   12670:     # $mapping:
                   12671:     #   for external URLs: external URL -> external URL
                   12672:     #   for relative paths: clean path -> original path
                   12673:     # $subdependencies: hash clean path -> clean file name -> 1 for relative paths in subdirectories
                   12674:     # $dependencies: hash clean or not file name -> 1 for relative paths not in subdirectories
1.1126    raeburn  12675:     foreach my $file (keys(%{$allfiles})) {
                   12676:         my $embed_file;
                   12677:         if (($path eq "/uploaded/$cdom/$cnum/portfolio/syllabus") && ($file =~ m{^\Q$path/\E(.+)$})) {
                   12678:             $embed_file = $1;
                   12679:         } else {
                   12680:             $embed_file = $file;
                   12681:         }
1.1158    raeburn  12682:         my ($absolutepath,$cleaned_file);
                   12683:         if ($embed_file =~ m{^\w+://}) {
                   12684:             $cleaned_file = $embed_file;
1.1147    raeburn  12685:             $newfiles{$cleaned_file} = 1;
                   12686:             $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  12687:         } else {
1.1158    raeburn  12688:             $cleaned_file = &clean_path($embed_file);
1.987     raeburn  12689:             if ($embed_file =~ m{^/}) {
                   12690:                 $absolutepath = $embed_file;
                   12691:             }
1.1147    raeburn  12692:             if ($cleaned_file =~ m{/}) {
                   12693:                 my ($path,$fname) = ($cleaned_file =~ m{^(.+)/([^/]*)$});
1.987     raeburn  12694:                 $path = &check_for_traversal($path,$url,$toplevel);
                   12695:                 my $item = $fname;
                   12696:                 if ($path ne '') {
                   12697:                     $item = $path.'/'.$fname;
                   12698:                     $subdependencies{$path}{$fname} = 1;
                   12699:                 } else {
                   12700:                     $dependencies{$item} = 1;
                   12701:                 }
                   12702:                 if ($absolutepath) {
                   12703:                     $mapping{$item} = $absolutepath;
                   12704:                 } else {
                   12705:                     $mapping{$item} = $embed_file;
                   12706:                 }
                   12707:             } else {
                   12708:                 $dependencies{$embed_file} = 1;
                   12709:                 if ($absolutepath) {
1.1147    raeburn  12710:                     $mapping{$cleaned_file} = $absolutepath;
1.987     raeburn  12711:                 } else {
1.1147    raeburn  12712:                     $mapping{$cleaned_file} = $embed_file;
1.987     raeburn  12713:                 }
                   12714:             }
1.984     raeburn  12715:         }
                   12716:     }
1.1249    damieng  12717:     
                   12718:     # looks for all existing files in dependency subdirectories (from $subdependencies filled above)
                   12719:     # and lists
                   12720:     # fills $currsubfile, $pathchanges, $existing, $numexisting, $newfiles, $unused
                   12721:     # $currsubfile: hash clean path -> file name -> 1 for all existing files in the path
                   12722:     # $pathchanges: hash clean path -> 1 if the file in subdirectory exists and
                   12723:     #                                    the path had to be cleaned up
                   12724:     # $existing: hash clean path -> 1 if the file exists
                   12725:     # $numexisting: number of keys in $existing
                   12726:     # $newfiles: updated with clean path -> 1 for files in subdirectories that do not exist
                   12727:     # $unused: only for /adm/dependencies, hash clean path -> 1 for existing files in
                   12728:     #                                      dependency subdirectories that are
                   12729:     #                                      not listed as dependencies, with some exceptions using $rem
1.1071    raeburn  12730:     my $dirptr = 16384;
1.984     raeburn  12731:     foreach my $path (keys(%subdependencies)) {
1.1071    raeburn  12732:         $currsubfile{$path} = {};
1.1123    raeburn  12733:         if (($actionurl eq '/adm/portfolio') || 
                   12734:             ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  12735:             my ($sublistref,$listerror) =
                   12736:                 &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath);
                   12737:             if (ref($sublistref) eq 'ARRAY') {
                   12738:                 foreach my $line (@{$sublistref}) {
                   12739:                     my ($file_name,$rest) = split(/\&/,$line,2);
1.1071    raeburn  12740:                     $currsubfile{$path}{$file_name} = 1;
1.1021    raeburn  12741:                 }
1.984     raeburn  12742:             }
1.987     raeburn  12743:         } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  12744:             if (opendir(my $dir,$url.'/'.$path)) {
                   12745:                 my @subdir_list = grep(!/^\./,readdir($dir));
1.1071    raeburn  12746:                 map {$currsubfile{$path}{$_} = 1;} @subdir_list;
                   12747:             }
1.1084    raeburn  12748:         } elsif (($actionurl eq '/adm/dependencies') ||
                   12749:                  (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123    raeburn  12750:                   ($args->{'context'} eq 'paste')) ||
                   12751:                  ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  12752:             if ($env{'request.course.id'} ne '') {
1.1123    raeburn  12753:                 my $dir;
                   12754:                 if ($actionurl eq "/public/$cdom/$cnum/syllabus") {
                   12755:                     $dir = $fileloc;
                   12756:                 } else {
                   12757:                     ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   12758:                 }
1.1071    raeburn  12759:                 if ($dir ne '') {
                   12760:                     my ($sublistref,$listerror) =
                   12761:                         &Apache::lonnet::dirlist($dir.$path,$cdom,$cnum,$getpropath,undef,'/');
                   12762:                     if (ref($sublistref) eq 'ARRAY') {
                   12763:                         foreach my $line (@{$sublistref}) {
                   12764:                             my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,$size,
                   12765:                                 undef,$mtime)=split(/\&/,$line,12);
                   12766:                             unless (($testdir&$dirptr) ||
                   12767:                                     ($file_name =~ /^\.\.?$/)) {
                   12768:                                 $currsubfile{$path}{$file_name} = [$size,$mtime];
                   12769:                             }
                   12770:                         }
                   12771:                     }
                   12772:                 }
1.984     raeburn  12773:             }
                   12774:         }
                   12775:         foreach my $file (keys(%{$subdependencies{$path}})) {
1.1071    raeburn  12776:             if (exists($currsubfile{$path}{$file})) {
1.987     raeburn  12777:                 my $item = $path.'/'.$file;
                   12778:                 unless ($mapping{$item} eq $item) {
                   12779:                     $pathchanges{$item} = 1;
                   12780:                 }
                   12781:                 $existing{$item} = 1;
                   12782:                 $numexisting ++;
                   12783:             } else {
                   12784:                 $newfiles{$path.'/'.$file} = 1;
1.984     raeburn  12785:             }
                   12786:         }
1.1071    raeburn  12787:         if ($actionurl eq '/adm/dependencies') {
                   12788:             foreach my $path (keys(%currsubfile)) {
                   12789:                 if (ref($currsubfile{$path}) eq 'HASH') {
                   12790:                     foreach my $file (keys(%{$currsubfile{$path}})) {
                   12791:                          unless ($subdependencies{$path}{$file}) {
1.1085    raeburn  12792:                              next if (($rem ne '') &&
                   12793:                                       (($env{"httpref.$rem"."$path/$file"} ne '') ||
                   12794:                                        (ref($navmap) &&
                   12795:                                        (($navmap->getResourceByUrl($rem."$path/$file") ne '') ||
                   12796:                                         (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   12797:                                          ($navmap->getResourceByUrl($rem."$path/$1")))))));
1.1071    raeburn  12798:                              $unused{$path.'/'.$file} = 1; 
                   12799:                          }
                   12800:                     }
                   12801:                 }
                   12802:             }
                   12803:         }
1.984     raeburn  12804:     }
1.1249    damieng  12805:     
                   12806:     # fills $currfile, hash file name -> 1 or [$size,$mtime]
                   12807:     # for files in $url or $fileloc (target directory) in some contexts
1.987     raeburn  12808:     my %currfile;
1.1123    raeburn  12809:     if (($actionurl eq '/adm/portfolio') ||
                   12810:         ($actionurl eq '/adm/coursegrp_portfolio')) {
1.1021    raeburn  12811:         my ($dirlistref,$listerror) =
                   12812:             &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath);
                   12813:         if (ref($dirlistref) eq 'ARRAY') {
                   12814:             foreach my $line (@{$dirlistref}) {
                   12815:                 my ($file_name,$rest) = split(/\&/,$line,2);
                   12816:                 $currfile{$file_name} = 1;
                   12817:             }
1.984     raeburn  12818:         }
1.987     raeburn  12819:     } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
1.984     raeburn  12820:         if (opendir(my $dir,$url)) {
1.987     raeburn  12821:             my @dir_list = grep(!/^\./,readdir($dir));
1.984     raeburn  12822:             map {$currfile{$_} = 1;} @dir_list;
                   12823:         }
1.1084    raeburn  12824:     } elsif (($actionurl eq '/adm/dependencies') ||
                   12825:              (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
1.1123    raeburn  12826:               ($args->{'context'} eq 'paste')) ||
                   12827:              ($actionurl eq "/public/$cdom/$cnum/syllabus")) {
1.1071    raeburn  12828:         if ($env{'request.course.id'} ne '') {
                   12829:             my ($dir) = ($fileloc =~ m{^(.+/)[^/]+$});
                   12830:             if ($dir ne '') {
                   12831:                 my ($dirlistref,$listerror) =
                   12832:                     &Apache::lonnet::dirlist($dir,$cdom,$cnum,$getpropath,undef,'/');
                   12833:                 if (ref($dirlistref) eq 'ARRAY') {
                   12834:                     foreach my $line (@{$dirlistref}) {
                   12835:                         my ($file_name,$dom,undef,$testdir,undef,undef,undef,undef,
                   12836:                             $size,undef,$mtime)=split(/\&/,$line,12);
                   12837:                         unless (($testdir&$dirptr) ||
                   12838:                                 ($file_name =~ /^\.\.?$/)) {
                   12839:                             $currfile{$file_name} = [$size,$mtime];
                   12840:                         }
                   12841:                     }
                   12842:                 }
                   12843:             }
                   12844:         }
1.984     raeburn  12845:     }
1.1249    damieng  12846:     # updates $pathchanges, $existing, $numexisting, $newfiles and $unused for files that
                   12847:     # are not in subdirectories, using $currfile
1.984     raeburn  12848:     foreach my $file (keys(%dependencies)) {
1.1071    raeburn  12849:         if (exists($currfile{$file})) {
1.987     raeburn  12850:             unless ($mapping{$file} eq $file) {
                   12851:                 $pathchanges{$file} = 1;
                   12852:             }
                   12853:             $existing{$file} = 1;
                   12854:             $numexisting ++;
                   12855:         } else {
1.984     raeburn  12856:             $newfiles{$file} = 1;
                   12857:         }
                   12858:     }
1.1071    raeburn  12859:     foreach my $file (keys(%currfile)) {
                   12860:         unless (($file eq $filename) ||
                   12861:                 ($file eq $filename.'.bak') ||
                   12862:                 ($dependencies{$file})) {
1.1085    raeburn  12863:             if ($actionurl eq '/adm/dependencies') {
1.1126    raeburn  12864:                 unless ($toplevel =~ m{^\Q/uploaded/$cdom/$cnum/portfolio/syllabus\E}) {
                   12865:                     next if (($rem ne '') &&
                   12866:                              (($env{"httpref.$rem".$file} ne '') ||
                   12867:                               (ref($navmap) &&
                   12868:                               (($navmap->getResourceByUrl($rem.$file) ne '') ||
                   12869:                                (($file =~ /^(.*\.s?html?)\.bak$/i) &&
                   12870:                                 ($navmap->getResourceByUrl($rem.$1)))))));
                   12871:                 }
1.1085    raeburn  12872:             }
1.1071    raeburn  12873:             $unused{$file} = 1;
                   12874:         }
                   12875:     }
1.1249    damieng  12876:     
                   12877:     # returns some results for coursedocs paste and syllabus rewrites ($output is undef)
1.1084    raeburn  12878:     if (($actionurl eq '/adm/coursedocs') && (ref($args) eq 'HASH') &&
                   12879:         ($args->{'context'} eq 'paste')) {
                   12880:         $counter = scalar(keys(%existing));
                   12881:         $numpathchg = scalar(keys(%pathchanges));
1.1123    raeburn  12882:         return ($output,$counter,$numpathchg,\%existing);
                   12883:     } elsif (($actionurl eq "/public/$cdom/$cnum/syllabus") && 
                   12884:              (ref($args) eq 'HASH') && ($args->{'context'} eq 'rewrites')) {
                   12885:         $counter = scalar(keys(%existing));
                   12886:         $numpathchg = scalar(keys(%pathchanges));
                   12887:         return ($output,$counter,$numpathchg,\%existing,\%mapping);
1.1084    raeburn  12888:     }
1.1249    damieng  12889:     
                   12890:     # returns HTML otherwise, with dependency results and to ask for more uploads
                   12891:     
                   12892:     # $upload_output: missing dependencies (with upload form)
                   12893:     # $modify_output: uploaded dependencies (in use)
                   12894:     # $delete_output: files no longer in use (unused files are not listed for londocs, bug?)
1.984     raeburn  12895:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) {
1.1071    raeburn  12896:         if ($actionurl eq '/adm/dependencies') {
                   12897:             next if ($embed_file =~ m{^\w+://});
                   12898:         }
1.660     raeburn  12899:         $upload_output .= &start_data_table_row().
1.1123    raeburn  12900:                           '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
1.1071    raeburn  12901:                           '<span class="LC_filename">'.$embed_file.'</span>';
1.987     raeburn  12902:         unless ($mapping{$embed_file} eq $embed_file) {
1.1123    raeburn  12903:             $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.
                   12904:                               &mt('changed from: [_1]',$mapping{$embed_file}).'</span>';
1.987     raeburn  12905:         }
1.1123    raeburn  12906:         $upload_output .= '</td>';
1.1071    raeburn  12907:         if ($args->{'ignore_remote_references'} && $embed_file =~ m{^\w+://}) { 
1.1123    raeburn  12908:             $upload_output.='<td align="right">'.
                   12909:                             '<span class="LC_info LC_fontsize_medium">'.
                   12910:                             &mt("URL points to web address").'</span>';
1.987     raeburn  12911:             $numremref++;
1.660     raeburn  12912:         } elsif ($args->{'error_on_invalid_names'}
                   12913:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
1.1123    raeburn  12914:             $upload_output.='<td align="right"><span class="LC_warning">'.
                   12915:                             &mt('Invalid characters').'</span>';
1.987     raeburn  12916:             $numinvalid++;
1.660     raeburn  12917:         } else {
1.1123    raeburn  12918:             $upload_output .= '<td>'.
                   12919:                               &embedded_file_element('upload_embedded',$counter,
1.987     raeburn  12920:                                                      $embed_file,\%mapping,
1.1071    raeburn  12921:                                                      $allfiles,$codebase,'upload');
                   12922:             $counter ++;
                   12923:             $numnew ++;
1.987     raeburn  12924:         }
                   12925:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n";
                   12926:     }
                   12927:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) {
1.1071    raeburn  12928:         if ($actionurl eq '/adm/dependencies') {
                   12929:             my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$embed_file);
                   12930:             $modify_output .= &start_data_table_row().
                   12931:                               '<td><a href="'.$path.'/'.$embed_file.'" style="text-decoration:none;">'.
                   12932:                               '<img src="'.&icon($embed_file).'" border="0" />'.
                   12933:                               '&nbsp;<span class="LC_filename">'.$embed_file.'</span></a></td>'.
                   12934:                               '<td>'.$size.'</td>'.
                   12935:                               '<td>'.$mtime.'</td>'.
                   12936:                               '<td><label><input type="checkbox" name="mod_upload_dep" '.
                   12937:                               'onclick="toggleBrowse('."'$counter'".')" id="mod_upload_dep_'.
                   12938:                               $counter.'" value="'.$counter.'" />'.&mt('Yes').'</label>'.
                   12939:                               '<div id="moduploaddep_'.$counter.'" style="display:none;">'.
                   12940:                               &embedded_file_element('upload_embedded',$counter,
                   12941:                                                      $embed_file,\%mapping,
                   12942:                                                      $allfiles,$codebase,'modify').
                   12943:                               '</div></td>'.
                   12944:                               &end_data_table_row()."\n";
                   12945:             $counter ++;
                   12946:         } else {
                   12947:             $upload_output .= &start_data_table_row().
1.1123    raeburn  12948:                               '<td valign="top"><img src="'.&icon($embed_file).'" />&nbsp;'.
                   12949:                               '<span class="LC_filename">'.$embed_file.'</span></td>'.
                   12950:                               '<td align="right"><span class="LC_info LC_fontsize_medium">'.&mt('Already exists').'</span></td>'.
1.1071    raeburn  12951:                               &Apache::loncommon::end_data_table_row()."\n";
                   12952:         }
                   12953:     }
                   12954:     my $delidx = $counter;
                   12955:     foreach my $oldfile (sort {lc($a) cmp lc($b)} keys(%unused)) {
                   12956:         my ($size,$mtime) = &get_dependency_details(\%currfile,\%currsubfile,$oldfile);
                   12957:         $delete_output .= &start_data_table_row().
                   12958:                           '<td><img src="'.&icon($oldfile).'" />'.
                   12959:                           '&nbsp;<span class="LC_filename">'.$oldfile.'</span></td>'.
                   12960:                           '<td>'.$size.'</td>'.
                   12961:                           '<td>'.$mtime.'</td>'.
                   12962:                           '<td><label><input type="checkbox" name="del_upload_dep" '.
                   12963:                           ' value="'.$delidx.'" />'.&mt('Yes').'</label>'.
                   12964:                           &embedded_file_element('upload_embedded',$delidx,
                   12965:                                                  $oldfile,\%mapping,$allfiles,
                   12966:                                                  $codebase,'delete').'</td>'.
                   12967:                           &end_data_table_row()."\n"; 
                   12968:         $numunused ++;
                   12969:         $delidx ++;
1.987     raeburn  12970:     }
                   12971:     if ($upload_output) {
                   12972:         $upload_output = &start_data_table().
                   12973:                          $upload_output.
                   12974:                          &end_data_table()."\n";
                   12975:     }
1.1071    raeburn  12976:     if ($modify_output) {
                   12977:         $modify_output = &start_data_table().
                   12978:                          &start_data_table_header_row().
                   12979:                          '<th>'.&mt('File').'</th>'.
                   12980:                          '<th>'.&mt('Size (KB)').'</th>'.
                   12981:                          '<th>'.&mt('Modified').'</th>'.
                   12982:                          '<th>'.&mt('Upload replacement?').'</th>'.
                   12983:                          &end_data_table_header_row().
                   12984:                          $modify_output.
                   12985:                          &end_data_table()."\n";
                   12986:     }
                   12987:     if ($delete_output) {
                   12988:         $delete_output = &start_data_table().
                   12989:                          &start_data_table_header_row().
                   12990:                          '<th>'.&mt('File').'</th>'.
                   12991:                          '<th>'.&mt('Size (KB)').'</th>'.
                   12992:                          '<th>'.&mt('Modified').'</th>'.
                   12993:                          '<th>'.&mt('Delete?').'</th>'.
                   12994:                          &end_data_table_header_row().
                   12995:                          $delete_output.
                   12996:                          &end_data_table()."\n";
                   12997:     }
1.987     raeburn  12998:     my $applies = 0;
                   12999:     if ($numremref) {
                   13000:         $applies ++;
                   13001:     }
                   13002:     if ($numinvalid) {
                   13003:         $applies ++;
                   13004:     }
                   13005:     if ($numexisting) {
                   13006:         $applies ++;
                   13007:     }
1.1071    raeburn  13008:     if ($counter || $numunused) {
1.987     raeburn  13009:         $output = '<form name="upload_embedded" action="'.$actionurl.'"'.
                   13010:                   ' method="post" enctype="multipart/form-data">'."\n".
1.1071    raeburn  13011:                   $state.'<h3>'.$heading.'</h3>'; 
                   13012:         if ($actionurl eq '/adm/dependencies') {
                   13013:             if ($numnew) {
                   13014:                 $output .= '<h4>'.&mt('Missing dependencies').'</h4>'.
                   13015:                            '<p>'.&mt('The following files need to be uploaded.').'</p>'."\n".
                   13016:                            $upload_output.'<br />'."\n";
                   13017:             }
                   13018:             if ($numexisting) {
                   13019:                 $output .= '<h4>'.&mt('Uploaded dependencies (in use)').'</h4>'.
                   13020:                            '<p>'.&mt('Upload a new file to replace the one currently in use.').'</p>'."\n".
                   13021:                            $modify_output.'<br />'."\n";
                   13022:                            $buttontext = &mt('Save changes');
                   13023:             }
                   13024:             if ($numunused) {
                   13025:                 $output .= '<h4>'.&mt('Unused files').'</h4>'.
                   13026:                            '<p>'.&mt('The following uploaded files are no longer used.').'</p>'."\n".
                   13027:                            $delete_output.'<br />'."\n";
                   13028:                            $buttontext = &mt('Save changes');
                   13029:             }
                   13030:         } else {
                   13031:             $output .= $upload_output.'<br />'."\n";
                   13032:         }
                   13033:         $output .= '<input type ="hidden" name="number_embedded_items" value="'.
                   13034:                    $counter.'" />'."\n";
                   13035:         if ($actionurl eq '/adm/dependencies') { 
                   13036:             $output .= '<input type ="hidden" name="number_newemb_items" value="'.
                   13037:                        $numnew.'" />'."\n";
                   13038:         } elsif ($actionurl eq '') {
1.987     raeburn  13039:             $output .=  '<input type="hidden" name="phase" value="three" />';
                   13040:         }
                   13041:     } elsif ($applies) {
                   13042:         $output = '<b>'.&mt('Referenced files').'</b>:<br />';
                   13043:         if ($applies > 1) {
                   13044:             $output .=  
1.1123    raeburn  13045:                 &mt('No dependencies need to be uploaded, as one of the following applies to each reference:').'<ul>';
1.987     raeburn  13046:             if ($numremref) {
                   13047:                 $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n";
                   13048:             }
                   13049:             if ($numinvalid) {
                   13050:                 $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n";
                   13051:             }
                   13052:             if ($numexisting) {
                   13053:                 $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n";
                   13054:             }
                   13055:             $output .= '</ul><br />';
                   13056:         } elsif ($numremref) {
                   13057:             $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>';
                   13058:         } elsif ($numinvalid) {
                   13059:             $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>';
                   13060:         } elsif ($numexisting) {
                   13061:             $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>';
                   13062:         }
                   13063:         $output .= $upload_output.'<br />';
                   13064:     }
                   13065:     my ($pathchange_output,$chgcount);
1.1071    raeburn  13066:     $chgcount = $counter;
1.987     raeburn  13067:     if (keys(%pathchanges) > 0) {
                   13068:         foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) {
1.1071    raeburn  13069:             if ($counter) {
1.987     raeburn  13070:                 $output .= &embedded_file_element('pathchange',$chgcount,
                   13071:                                                   $embed_file,\%mapping,
1.1071    raeburn  13072:                                                   $allfiles,$codebase,'change');
1.987     raeburn  13073:             } else {
                   13074:                 $pathchange_output .= 
                   13075:                     &start_data_table_row().
                   13076:                     '<td><input type ="checkbox" name="namechange" value="'.
                   13077:                     $chgcount.'" checked="checked" /></td>'.
                   13078:                     '<td>'.$mapping{$embed_file}.'</td>'.
                   13079:                     '<td>'.$embed_file.
                   13080:                     &embedded_file_element('pathchange',$numpathchg,$embed_file,
1.1071    raeburn  13081:                                            \%mapping,$allfiles,$codebase,'change').
1.987     raeburn  13082:                     '</td>'.&end_data_table_row();
1.660     raeburn  13083:             }
1.987     raeburn  13084:             $numpathchg ++;
                   13085:             $chgcount ++;
1.660     raeburn  13086:         }
                   13087:     }
1.1127    raeburn  13088:     if (($counter) || ($numunused)) {
1.987     raeburn  13089:         if ($numpathchg) {
                   13090:             $output .= '<input type ="hidden" name="number_pathchange_items" value="'.
                   13091:                        $numpathchg.'" />'."\n";
                   13092:         }
                   13093:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 
                   13094:             ($actionurl eq '/adm/imsimport')) {
                   13095:             $output .= '<input type="hidden" name="phase" value="three" />'."\n";
                   13096:         } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') {
                   13097:             $output .= '<input type="hidden" name="action" value="upload_embedded" />';
1.1071    raeburn  13098:         } elsif ($actionurl eq '/adm/dependencies') {
                   13099:             $output .= '<input type="hidden" name="action" value="process_changes" />';
1.987     raeburn  13100:         }
1.1123    raeburn  13101:         $output .= '<input type ="submit" value="'.$buttontext.'" />'."\n".'</form>'."\n";
1.987     raeburn  13102:     } elsif ($numpathchg) {
                   13103:         my %pathchange = ();
                   13104:         $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output);
                   13105:         if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   13106:             $output .= '<p>'.&mt('or').'</p>'; 
1.1123    raeburn  13107:         }
1.987     raeburn  13108:     }
1.1071    raeburn  13109:     return ($output,$counter,$numpathchg);
1.987     raeburn  13110: }
                   13111: 
1.1147    raeburn  13112: =pod
                   13113: 
                   13114: =item * clean_path($name)
                   13115: 
                   13116: Performs clean-up of directories, subdirectories and filename in an
                   13117: embedded object, referenced in an HTML file which is being uploaded
                   13118: to a course or portfolio, where 
                   13119: "Upload embedded images/multimedia files if HTML file" checkbox was
                   13120: checked.
                   13121: 
                   13122: Clean-up is similar to replacements in lonnet::clean_filename()
                   13123: except each / between sub-directory and next level is preserved.
                   13124: 
                   13125: =cut
                   13126: 
                   13127: sub clean_path {
                   13128:     my ($embed_file) = @_;
                   13129:     $embed_file =~s{^/+}{};
                   13130:     my @contents;
                   13131:     if ($embed_file =~ m{/}) {
                   13132:         @contents = split(/\//,$embed_file);
                   13133:     } else {
                   13134:         @contents = ($embed_file);
                   13135:     }
                   13136:     my $lastidx = scalar(@contents)-1;
                   13137:     for (my $i=0; $i<=$lastidx; $i++) { 
                   13138:         $contents[$i]=~s{\\}{/}g;
                   13139:         $contents[$i]=~s/\s+/\_/g;
                   13140:         $contents[$i]=~s{[^/\w\.\-]}{}g;
                   13141:         if ($i == $lastidx) {
                   13142:             $contents[$i]=~s/\.(\d+)(?=\.)/_$1/g;
                   13143:         }
                   13144:     }
                   13145:     if ($lastidx > 0) {
                   13146:         return join('/',@contents);
                   13147:     } else {
                   13148:         return $contents[0];
                   13149:     }
                   13150: }
                   13151: 
1.987     raeburn  13152: sub embedded_file_element {
1.1071    raeburn  13153:     my ($context,$num,$embed_file,$mapping,$allfiles,$codebase,$type) = @_;
1.987     raeburn  13154:     return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') &&
                   13155:                    (ref($codebase) eq 'HASH'));
                   13156:     my $output;
1.1071    raeburn  13157:     if (($context eq 'upload_embedded') && ($type ne 'delete')) {
1.987     raeburn  13158:        $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n";
                   13159:     }
                   13160:     $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'.
                   13161:                &escape($embed_file).'" />';
                   13162:     unless (($context eq 'upload_embedded') && 
                   13163:             ($mapping->{$embed_file} eq $embed_file)) {
                   13164:         $output .='
                   13165:         <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />';
                   13166:     }
                   13167:     my $attrib;
                   13168:     if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') {
                   13169:         $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}}));
                   13170:     }
                   13171:     $output .=
                   13172:         "\n\t\t".
                   13173:         '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   13174:         $attrib.'" />';
                   13175:     if (exists($codebase->{$mapping->{$embed_file}})) {
                   13176:         $output .=
                   13177:             "\n\t\t".
                   13178:             '<input name="codebase_'.$num.'" type="hidden" value="'.
                   13179:             &escape($codebase->{$mapping->{$embed_file}}).'" />';
1.984     raeburn  13180:     }
1.987     raeburn  13181:     return $output;
1.660     raeburn  13182: }
                   13183: 
1.1071    raeburn  13184: sub get_dependency_details {
                   13185:     my ($currfile,$currsubfile,$embed_file) = @_;
                   13186:     my ($size,$mtime,$showsize,$showmtime);
                   13187:     if ((ref($currfile) eq 'HASH') && (ref($currsubfile))) {
                   13188:         if ($embed_file =~ m{/}) {
                   13189:             my ($path,$fname) = split(/\//,$embed_file);
                   13190:             if (ref($currsubfile->{$path}{$fname}) eq 'ARRAY') {
                   13191:                 ($size,$mtime) = @{$currsubfile->{$path}{$fname}};
                   13192:             }
                   13193:         } else {
                   13194:             if (ref($currfile->{$embed_file}) eq 'ARRAY') {
                   13195:                 ($size,$mtime) = @{$currfile->{$embed_file}};
                   13196:             }
                   13197:         }
                   13198:         $showsize = $size/1024.0;
                   13199:         $showsize = sprintf("%.1f",$showsize);
                   13200:         if ($mtime > 0) {
                   13201:             $showmtime = &Apache::lonlocal::locallocaltime($mtime);
                   13202:         }
                   13203:     }
                   13204:     return ($showsize,$showmtime);
                   13205: }
                   13206: 
                   13207: sub ask_embedded_js {
                   13208:     return <<"END";
                   13209: <script type="text/javascript"">
                   13210: // <![CDATA[
                   13211: function toggleBrowse(counter) {
                   13212:     var chkboxid = document.getElementById('mod_upload_dep_'+counter);
                   13213:     var fileid = document.getElementById('embedded_item_'+counter);
                   13214:     var uploaddivid = document.getElementById('moduploaddep_'+counter);
                   13215:     if (chkboxid.checked == true) {
                   13216:         uploaddivid.style.display='block';
                   13217:     } else {
                   13218:         uploaddivid.style.display='none';
                   13219:         fileid.value = '';
                   13220:     }
                   13221: }
                   13222: // ]]>
                   13223: </script>
                   13224: 
                   13225: END
                   13226: }
                   13227: 
1.661     raeburn  13228: sub upload_embedded {
                   13229:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
1.987     raeburn  13230:         $current_disk_usage,$hiddenstate,$actionurl) = @_;
                   13231:     my (%pathchange,$output,$modifyform,$footer,$returnflag);
1.661     raeburn  13232:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   13233:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   13234:         my $orig_uploaded_filename =
                   13235:             $env{'form.embedded_item_'.$i.'.filename'};
1.987     raeburn  13236:         foreach my $type ('orig','ref','attrib','codebase') {
                   13237:             if ($env{'form.embedded_'.$type.'_'.$i} ne '') {
                   13238:                 $env{'form.embedded_'.$type.'_'.$i} =
                   13239:                     &unescape($env{'form.embedded_'.$type.'_'.$i});
                   13240:             }
                   13241:         }
1.661     raeburn  13242:         my ($path,$fname) =
                   13243:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   13244:         # no path, whole string is fname
                   13245:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   13246:         $fname = &Apache::lonnet::clean_filename($fname);
                   13247:         # See if there is anything left
                   13248:         next if ($fname eq '');
                   13249: 
                   13250:         # Check if file already exists as a file or directory.
                   13251:         my ($state,$msg);
                   13252:         if ($context eq 'portfolio') {
                   13253:             my $port_path = $dirpath;
                   13254:             if ($group ne '') {
                   13255:                 $port_path = "groups/$group/$port_path";
                   13256:             }
1.987     raeburn  13257:             ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path,
                   13258:                                               $fname,$group,'embedded_item_'.$i,
1.661     raeburn  13259:                                               $dir_root,$port_path,$disk_quota,
                   13260:                                               $current_disk_usage,$uname,$udom);
                   13261:             if ($state eq 'will_exceed_quota'
1.984     raeburn  13262:                 || $state eq 'file_locked') {
1.661     raeburn  13263:                 $output .= $msg;
                   13264:                 next;
                   13265:             }
                   13266:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   13267:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   13268:             if ($state eq 'exists') {
                   13269:                 $output .= $msg;
                   13270:                 next;
                   13271:             }
                   13272:         }
                   13273:         # Check if extension is valid
                   13274:         if (($fname =~ /\.(\w+)$/) &&
                   13275:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
1.1155    bisitz   13276:             $output .= &mt('Invalid file extension ([_1]) - reserved for internal use.',$1)
                   13277:                       .' '.&mt('Rename the file with a different extension and re-upload.').'<br />';
1.661     raeburn  13278:             next;
                   13279:         } elsif (($fname =~ /\.(\w+)$/) &&
                   13280:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
1.987     raeburn  13281:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />';
1.661     raeburn  13282:             next;
                   13283:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
1.1120    bisitz   13284:             $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  13285:             next;
                   13286:         }
                   13287:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
1.1123    raeburn  13288:         my $subdir = $path;
                   13289:         $subdir =~ s{/+$}{};
1.661     raeburn  13290:         if ($context eq 'portfolio') {
1.984     raeburn  13291:             my $result;
                   13292:             if ($state eq 'existingfile') {
                   13293:                 $result=
                   13294:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile',
1.1123    raeburn  13295:                                                     $dirpath.$env{'form.currentpath'}.$subdir);
1.661     raeburn  13296:             } else {
1.984     raeburn  13297:                 $result=
                   13298:                     &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
1.987     raeburn  13299:                                                     $dirpath.
1.1123    raeburn  13300:                                                     $env{'form.currentpath'}.$subdir);
1.984     raeburn  13301:                 if ($result !~ m|^/uploaded/|) {
                   13302:                     $output .= '<span class="LC_error">'
                   13303:                                .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   13304:                                ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   13305:                                .'</span><br />';
                   13306:                     next;
                   13307:                 } else {
1.987     raeburn  13308:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   13309:                                $path.$fname.'</span>').'<br />';     
1.984     raeburn  13310:                 }
1.661     raeburn  13311:             }
1.1123    raeburn  13312:         } elsif (($context eq 'coursedoc') || ($context eq 'syllabus')) {
1.1126    raeburn  13313:             my $extendedsubdir = $dirpath.'/'.$subdir;
                   13314:             $extendedsubdir =~ s{/+$}{};
1.987     raeburn  13315:             my $result =
1.1126    raeburn  13316:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,$context,$extendedsubdir);
1.987     raeburn  13317:             if ($result !~ m|^/uploaded/|) {
                   13318:                 $output .= '<span class="LC_error">'
                   13319:                            .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   13320:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   13321:                            .'</span><br />';
                   13322:                     next;
                   13323:             } else {
                   13324:                 $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   13325:                            $path.$fname.'</span>').'<br />';
1.1125    raeburn  13326:                 if ($context eq 'syllabus') {
                   13327:                     &Apache::lonnet::make_public_indefinitely($result);
                   13328:                 }
1.987     raeburn  13329:             }
1.661     raeburn  13330:         } else {
                   13331: # Save the file
                   13332:             my $target = $env{'form.embedded_item_'.$i};
                   13333:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   13334:             my $dest = $fullpath.$fname;
                   13335:             my $url = $url_root.$dirpath.'/'.$path.$fname;
1.1027    raeburn  13336:             my @parts=split(/\//,"$dirpath/$path");
1.661     raeburn  13337:             my $count;
                   13338:             my $filepath = $dir_root;
1.1027    raeburn  13339:             foreach my $subdir (@parts) {
                   13340:                 $filepath .= "/$subdir";
                   13341:                 if (!-e $filepath) {
1.661     raeburn  13342:                     mkdir($filepath,0770);
                   13343:                 }
                   13344:             }
                   13345:             my $fh;
                   13346:             if (!open($fh,'>'.$dest)) {
                   13347:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   13348:                 $output .= '<span class="LC_error">'.
1.1071    raeburn  13349:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',
                   13350:                                $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  13351:                            '</span><br />';
                   13352:             } else {
                   13353:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   13354:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   13355:                     $output .= '<span class="LC_error">'.
1.1071    raeburn  13356:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',
                   13357:                                   $orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
1.661     raeburn  13358:                               '</span><br />';
                   13359:                 } else {
1.987     raeburn  13360:                     $output .= &mt('Uploaded [_1]','<span class="LC_filename">'.
                   13361:                                $url.'</span>').'<br />';
                   13362:                     unless ($context eq 'testbank') {
                   13363:                         $footer .= &mt('View embedded file: [_1]',
                   13364:                                        '<a href="'.$url.'">'.$fname.'</a>').'<br />';
                   13365:                     }
                   13366:                 }
                   13367:                 close($fh);
                   13368:             }
                   13369:         }
                   13370:         if ($env{'form.embedded_ref_'.$i}) {
                   13371:             $pathchange{$i} = 1;
                   13372:         }
                   13373:     }
                   13374:     if ($output) {
                   13375:         $output = '<p>'.$output.'</p>';
                   13376:     }
                   13377:     $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange);
                   13378:     $returnflag = 'ok';
1.1071    raeburn  13379:     my $numpathchgs = scalar(keys(%pathchange));
                   13380:     if ($numpathchgs > 0) {
1.987     raeburn  13381:         if ($context eq 'portfolio') {
                   13382:             $output .= '<p>'.&mt('or').'</p>';
                   13383:         } elsif ($context eq 'testbank') {
1.1071    raeburn  13384:             $output .=  '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).',
                   13385:                                   '<a href="javascript:document.testbankForm.submit();">','</a>').'</p>';
1.987     raeburn  13386:             $returnflag = 'modify_orightml';
                   13387:         }
                   13388:     }
1.1071    raeburn  13389:     return ($output.$footer,$returnflag,$numpathchgs);
1.987     raeburn  13390: }
                   13391: 
                   13392: sub modify_html_form {
                   13393:     my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_;
                   13394:     my $end = 0;
                   13395:     my $modifyform;
                   13396:     if ($context eq 'upload_embedded') {
                   13397:         return unless (ref($pathchange) eq 'HASH');
                   13398:         if ($env{'form.number_embedded_items'}) {
                   13399:             $end += $env{'form.number_embedded_items'};
                   13400:         }
                   13401:         if ($env{'form.number_pathchange_items'}) {
                   13402:             $end += $env{'form.number_pathchange_items'};
                   13403:         }
                   13404:         if ($end) {
                   13405:             for (my $i=0; $i<$end; $i++) {
                   13406:                 if ($i < $env{'form.number_embedded_items'}) {
                   13407:                     next unless($pathchange->{$i});
                   13408:                 }
                   13409:                 $modifyform .=
                   13410:                     &start_data_table_row().
                   13411:                     '<td><input type ="checkbox" name="namechange" value="'.$i.'" '.
                   13412:                     'checked="checked" /></td>'.
                   13413:                     '<td>'.$env{'form.embedded_ref_'.$i}.
                   13414:                     '<input type="hidden" name="embedded_ref_'.$i.'" value="'.
                   13415:                     &escape($env{'form.embedded_ref_'.$i}).'" />'.
                   13416:                     '<input type="hidden" name="embedded_codebase_'.$i.'" value="'.
                   13417:                     &escape($env{'form.embedded_codebase_'.$i}).'" />'.
                   13418:                     '<input type="hidden" name="embedded_attrib_'.$i.'" value="'.
                   13419:                     &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'.
                   13420:                     '<td>'.$env{'form.embedded_orig_'.$i}.
                   13421:                     '<input type="hidden" name="embedded_orig_'.$i.'" value="'.
                   13422:                     &escape($env{'form.embedded_orig_'.$i}).'" /></td>'.
                   13423:                     &end_data_table_row();
1.1071    raeburn  13424:             }
1.987     raeburn  13425:         }
                   13426:     } else {
                   13427:         $modifyform = $pathchgtable;
                   13428:         if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) {
                   13429:             $hiddenstate .= '<input type="hidden" name="phase" value="four" />';
                   13430:         } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) {
                   13431:             $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />';
                   13432:         }
                   13433:     }
                   13434:     if ($modifyform) {
1.1071    raeburn  13435:         if ($actionurl eq '/adm/dependencies') {
                   13436:             $hiddenstate .= '<input type="hidden" name="action" value="modifyhrefs" />';
                   13437:         }
1.987     raeburn  13438:         return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n".
                   13439:                '<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".
                   13440:                '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n".
                   13441:                '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n".
                   13442:                '</ol></p>'."\n".'<p>'.
                   13443:                &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n".
                   13444:                '<form method="post" name="refchanger" action="'.$actionurl.'">'.
                   13445:                &start_data_table()."\n".
                   13446:                &start_data_table_header_row().
                   13447:                '<th>'.&mt('Change?').'</th>'.
                   13448:                '<th>'.&mt('Current reference').'</th>'.
                   13449:                '<th>'.&mt('Required reference').'</th>'.
                   13450:                &end_data_table_header_row()."\n".
                   13451:                $modifyform.
                   13452:                &end_data_table().'<br />'."\n".$hiddenstate.
                   13453:                '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'.
                   13454:                '</form>'."\n";
                   13455:     }
                   13456:     return;
                   13457: }
                   13458: 
                   13459: sub modify_html_refs {
1.1123    raeburn  13460:     my ($context,$dirpath,$uname,$udom,$dir_root,$url) = @_;
1.987     raeburn  13461:     my $container;
                   13462:     if ($context eq 'portfolio') {
                   13463:         $container = $env{'form.container'};
                   13464:     } elsif ($context eq 'coursedoc') {
                   13465:         $container = $env{'form.primaryurl'};
1.1071    raeburn  13466:     } elsif ($context eq 'manage_dependencies') {
                   13467:         (undef,undef,$container) = &Apache::lonnet::decode_symb($env{'form.symb'});
                   13468:         $container = "/$container";
1.1123    raeburn  13469:     } elsif ($context eq 'syllabus') {
                   13470:         $container = $url;
1.987     raeburn  13471:     } else {
1.1027    raeburn  13472:         $container = $Apache::lonnet::perlvar{'lonDocRoot'}.$env{'form.filename'};
1.987     raeburn  13473:     }
                   13474:     my (%allfiles,%codebase,$output,$content);
                   13475:     my @changes = &get_env_multiple('form.namechange');
1.1126    raeburn  13476:     unless ((@changes > 0) || ($context eq 'syllabus')) {
1.1071    raeburn  13477:         if (wantarray) {
                   13478:             return ('',0,0); 
                   13479:         } else {
                   13480:             return;
                   13481:         }
                   13482:     }
                   13483:     if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1123    raeburn  13484:         ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.1071    raeburn  13485:         unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}) {
                   13486:             if (wantarray) {
                   13487:                 return ('',0,0);
                   13488:             } else {
                   13489:                 return;
                   13490:             }
                   13491:         } 
1.987     raeburn  13492:         $content = &Apache::lonnet::getfile($container);
1.1071    raeburn  13493:         if ($content eq '-1') {
                   13494:             if (wantarray) {
                   13495:                 return ('',0,0);
                   13496:             } else {
                   13497:                 return;
                   13498:             }
                   13499:         }
1.987     raeburn  13500:     } else {
1.1071    raeburn  13501:         unless ($container =~ /^\Q$dir_root\E/) {
                   13502:             if (wantarray) {
                   13503:                 return ('',0,0);
                   13504:             } else {
                   13505:                 return;
                   13506:             }
                   13507:         } 
1.1317    raeburn  13508:         if (open(my $fh,'<',$container)) {
1.987     raeburn  13509:             $content = join('', <$fh>);
                   13510:             close($fh);
                   13511:         } else {
1.1071    raeburn  13512:             if (wantarray) {
                   13513:                 return ('',0,0);
                   13514:             } else {
                   13515:                 return;
                   13516:             }
1.987     raeburn  13517:         }
                   13518:     }
                   13519:     my ($count,$codebasecount) = (0,0);
                   13520:     my $mm = new File::MMagic;
                   13521:     my $mime_type = $mm->checktype_contents($content);
                   13522:     if ($mime_type eq 'text/html') {
                   13523:         my $parse_result = 
                   13524:             &Apache::lonnet::extract_embedded_items($container,\%allfiles,
                   13525:                                                     \%codebase,\$content);
                   13526:         if ($parse_result eq 'ok') {
                   13527:             foreach my $i (@changes) {
                   13528:                 my $orig = &unescape($env{'form.embedded_orig_'.$i});
                   13529:                 my $ref = &unescape($env{'form.embedded_ref_'.$i});
                   13530:                 if ($allfiles{$ref}) {
                   13531:                     my $newname =  $orig;
                   13532:                     my ($attrib_regexp,$codebase);
1.1006    raeburn  13533:                     $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i});
1.987     raeburn  13534:                     if ($attrib_regexp =~ /:/) {
                   13535:                         $attrib_regexp =~ s/\:/|/g;
                   13536:                     }
                   13537:                     if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   13538:                         my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   13539:                         $count += $numchg;
1.1123    raeburn  13540:                         $allfiles{$newname} = $allfiles{$ref};
1.1148    raeburn  13541:                         delete($allfiles{$ref});
1.987     raeburn  13542:                     }
                   13543:                     if ($env{'form.embedded_codebase_'.$i} ne '') {
1.1006    raeburn  13544:                         $codebase = &unescape($env{'form.embedded_codebase_'.$i});
1.987     raeburn  13545:                         my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs
                   13546:                         $codebasecount ++;
                   13547:                     }
                   13548:                 }
                   13549:             }
1.1123    raeburn  13550:             my $skiprewrites;
1.987     raeburn  13551:             if ($count || $codebasecount) {
                   13552:                 my $saveresult;
1.1071    raeburn  13553:                 if (($context eq 'portfolio') || ($context eq 'coursedoc') || 
1.1123    raeburn  13554:                     ($context eq 'manage_dependencies') || ($context eq 'syllabus')) {
1.987     raeburn  13555:                     my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   13556:                     if ($url eq $container) {
                   13557:                         my ($fname) = ($container =~ m{/([^/]+)$});
                   13558:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   13559:                                             $count,'<span class="LC_filename">'.
1.1071    raeburn  13560:                                             $fname.'</span>').'</p>';
1.987     raeburn  13561:                     } else {
                   13562:                          $output = '<p class="LC_error">'.
                   13563:                                    &mt('Error: update failed for: [_1].',
                   13564:                                    '<span class="LC_filename">'.
                   13565:                                    $container.'</span>').'</p>';
                   13566:                     }
1.1123    raeburn  13567:                     if ($context eq 'syllabus') {
                   13568:                         unless ($saveresult eq 'ok') {
                   13569:                             $skiprewrites = 1;
                   13570:                         }
                   13571:                     }
1.987     raeburn  13572:                 } else {
1.1317    raeburn  13573:                     if (open(my $fh,'>',$container)) {
1.987     raeburn  13574:                         print $fh $content;
                   13575:                         close($fh);
                   13576:                         $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].',
                   13577:                                   $count,'<span class="LC_filename">'.
                   13578:                                   $container.'</span>').'</p>';
1.661     raeburn  13579:                     } else {
1.987     raeburn  13580:                          $output = '<p class="LC_error">'.
                   13581:                                    &mt('Error: could not update [_1].',
                   13582:                                    '<span class="LC_filename">'.
                   13583:                                    $container.'</span>').'</p>';
1.661     raeburn  13584:                     }
                   13585:                 }
                   13586:             }
1.1123    raeburn  13587:             if (($context eq 'syllabus') && (!$skiprewrites)) {
                   13588:                 my ($actionurl,$state);
                   13589:                 $actionurl = "/public/$udom/$uname/syllabus";
                   13590:                 my ($ignore,$num,$numpathchanges,$existing,$mapping) =
                   13591:                     &ask_for_embedded_content($actionurl,$state,\%allfiles,
                   13592:                                               \%codebase,
                   13593:                                               {'context' => 'rewrites',
                   13594:                                                'ignore_remote_references' => 1,});
                   13595:                 if (ref($mapping) eq 'HASH') {
                   13596:                     my $rewrites = 0;
                   13597:                     foreach my $key (keys(%{$mapping})) {
                   13598:                         next if ($key =~ m{^https?://});
                   13599:                         my $ref = $mapping->{$key};
                   13600:                         my $newname = "/uploaded/$udom/$uname/portfolio/syllabus/$key";
                   13601:                         my $attrib;
                   13602:                         if (ref($allfiles{$mapping->{$key}}) eq 'ARRAY') {
                   13603:                             $attrib = join('|',@{$allfiles{$mapping->{$key}}});
                   13604:                         }
                   13605:                         if ($content =~ m{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}) {
                   13606:                             my $numchg = ($content =~ s{($attrib\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi);
                   13607:                             $rewrites += $numchg;
                   13608:                         }
                   13609:                     }
                   13610:                     if ($rewrites) {
                   13611:                         my $saveresult; 
                   13612:                         my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult);
                   13613:                         if ($url eq $container) {
                   13614:                             my ($fname) = ($container =~ m{/([^/]+)$});
                   13615:                             $output .= '<p>'.&mt('Rewrote [quant,_1,link] as [quant,_1,absolute link] in [_2].',
                   13616:                                             $count,'<span class="LC_filename">'.
                   13617:                                             $fname.'</span>').'</p>';
                   13618:                         } else {
                   13619:                             $output .= '<p class="LC_error">'.
                   13620:                                        &mt('Error: could not update links in [_1].',
                   13621:                                        '<span class="LC_filename">'.
                   13622:                                        $container.'</span>').'</p>';
                   13623: 
                   13624:                         }
                   13625:                     }
                   13626:                 }
                   13627:             }
1.987     raeburn  13628:         } else {
                   13629:             &logthis('Failed to parse '.$container.
                   13630:                      ' to modify references: '.$parse_result);
1.661     raeburn  13631:         }
                   13632:     }
1.1071    raeburn  13633:     if (wantarray) {
                   13634:         return ($output,$count,$codebasecount);
                   13635:     } else {
                   13636:         return $output;
                   13637:     }
1.661     raeburn  13638: }
                   13639: 
                   13640: sub check_for_existing {
                   13641:     my ($path,$fname,$element) = @_;
                   13642:     my ($state,$msg);
                   13643:     if (-d $path.'/'.$fname) {
                   13644:         $state = 'exists';
                   13645:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   13646:     } elsif (-e $path.'/'.$fname) {
                   13647:         $state = 'exists';
                   13648:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   13649:     }
                   13650:     if ($state eq 'exists') {
                   13651:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   13652:     }
                   13653:     return ($state,$msg);
                   13654: }
                   13655: 
                   13656: sub check_for_upload {
                   13657:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   13658:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
1.985     raeburn  13659:     my $filesize = length($env{'form.'.$element});
                   13660:     if (!$filesize) {
                   13661:         my $msg = '<span class="LC_error">'.
                   13662:                   &mt('Unable to upload [_1]. (size = [_2] bytes)', 
                   13663:                       '<span class="LC_filename">'.$fname.'</span>',
                   13664:                       $filesize).'<br />'.
1.1007    raeburn  13665:                   &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'.
1.985     raeburn  13666:                   '</span>';
                   13667:         return ('zero_bytes',$msg);
                   13668:     }
                   13669:     $filesize =  $filesize/1000; #express in k (1024?)
1.661     raeburn  13670:     my $getpropath = 1;
1.1021    raeburn  13671:     my ($dirlistref,$listerror) =
                   13672:          &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,$getpropath);
1.661     raeburn  13673:     my $found_file = 0;
                   13674:     my $locked_file = 0;
1.991     raeburn  13675:     my @lockers;
                   13676:     my $navmap;
                   13677:     if ($env{'request.course.id'}) {
                   13678:         $navmap = Apache::lonnavmaps::navmap->new();
                   13679:     }
1.1021    raeburn  13680:     if (ref($dirlistref) eq 'ARRAY') {
                   13681:         foreach my $line (@{$dirlistref}) {
                   13682:             my ($file_name,$rest)=split(/\&/,$line,2);
                   13683:             if ($file_name eq $fname){
                   13684:                 $file_name = $path.$file_name;
                   13685:                 if ($group ne '') {
                   13686:                     $file_name = $group.$file_name;
                   13687:                 }
                   13688:                 $found_file = 1;
                   13689:                 if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') {
                   13690:                     foreach my $lock (@lockers) {
                   13691:                         if (ref($lock) eq 'ARRAY') {
                   13692:                             my ($symb,$crsid) = @{$lock};
                   13693:                             if ($crsid eq $env{'request.course.id'}) {
                   13694:                                 if (ref($navmap)) {
                   13695:                                     my $res = $navmap->getBySymb($symb);
                   13696:                                     foreach my $part (@{$res->parts()}) { 
                   13697:                                         my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part);
                   13698:                                         unless (($slot_status == $res->RESERVED) ||
                   13699:                                                 ($slot_status == $res->RESERVED_LOCATION)) {
                   13700:                                             $locked_file = 1;
                   13701:                                         }
1.991     raeburn  13702:                                     }
1.1021    raeburn  13703:                                 } else {
                   13704:                                     $locked_file = 1;
1.991     raeburn  13705:                                 }
                   13706:                             } else {
                   13707:                                 $locked_file = 1;
                   13708:                             }
                   13709:                         }
1.1021    raeburn  13710:                    }
                   13711:                 } else {
                   13712:                     my @info = split(/\&/,$rest);
                   13713:                     my $currsize = $info[6]/1000;
                   13714:                     if ($currsize < $filesize) {
                   13715:                         my $extra = $filesize - $currsize;
                   13716:                         if (($current_disk_usage + $extra) > $disk_quota) {
1.1179    bisitz   13717:                             my $msg = '<p class="LC_warning">'.
1.1021    raeburn  13718:                                       &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.1179    bisitz   13719:                                           '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</p>'.
                   13720:                                       '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',
                   13721:                                                    $disk_quota,$current_disk_usage).'</p>';
1.1021    raeburn  13722:                             return ('will_exceed_quota',$msg);
                   13723:                         }
1.984     raeburn  13724:                     }
                   13725:                 }
1.661     raeburn  13726:             }
                   13727:         }
                   13728:     }
                   13729:     if (($current_disk_usage + $filesize) > $disk_quota){
1.1179    bisitz   13730:         my $msg = '<p class="LC_warning">'.
                   13731:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</p>'.
1.1184    raeburn  13732:                   '<p>'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage).'</p>';
1.661     raeburn  13733:         return ('will_exceed_quota',$msg);
                   13734:     } elsif ($found_file) {
                   13735:         if ($locked_file) {
1.1179    bisitz   13736:             my $msg = '<p class="LC_warning">';
1.661     raeburn  13737:             $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.1179    bisitz   13738:             $msg .= '</p>';
1.661     raeburn  13739:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   13740:             return ('file_locked',$msg);
                   13741:         } else {
1.1179    bisitz   13742:             my $msg = '<p class="LC_error">';
1.984     raeburn  13743:             $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
1.1179    bisitz   13744:             $msg .= '</p>';
1.984     raeburn  13745:             return ('existingfile',$msg);
1.661     raeburn  13746:         }
                   13747:     }
                   13748: }
                   13749: 
1.987     raeburn  13750: sub check_for_traversal {
                   13751:     my ($path,$url,$toplevel) = @_;
                   13752:     my @parts=split(/\//,$path);
                   13753:     my $cleanpath;
                   13754:     my $fullpath = $url;
                   13755:     for (my $i=0;$i<@parts;$i++) {
                   13756:         next if ($parts[$i] eq '.');
                   13757:         if ($parts[$i] eq '..') {
                   13758:             $fullpath =~ s{([^/]+/)$}{};
                   13759:         } else {
                   13760:             $fullpath .= $parts[$i].'/';
                   13761:         }
                   13762:     }
                   13763:     if ($fullpath =~ /^\Q$url\E(.*)$/) {
                   13764:         $cleanpath = $1;
                   13765:     } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) {
                   13766:         my $curr_toprel = $1;
                   13767:         my @parts = split(/\//,$curr_toprel);
                   13768:         my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/);
                   13769:         my @urlparts = split(/\//,$url_toprel);
                   13770:         my $doubledots;
                   13771:         my $startdiff = -1;
                   13772:         for (my $i=0; $i<@urlparts; $i++) {
                   13773:             if ($startdiff == -1) {
                   13774:                 unless ($urlparts[$i] eq $parts[$i]) {
                   13775:                     $startdiff = $i;
                   13776:                     $doubledots .= '../';
                   13777:                 }
                   13778:             } else {
                   13779:                 $doubledots .= '../';
                   13780:             }
                   13781:         }
                   13782:         if ($startdiff > -1) {
                   13783:             $cleanpath = $doubledots;
                   13784:             for (my $i=$startdiff; $i<@parts; $i++) {
                   13785:                 $cleanpath .= $parts[$i].'/';
                   13786:             }
                   13787:         }
                   13788:     }
                   13789:     $cleanpath =~ s{(/)$}{};
                   13790:     return $cleanpath;
                   13791: }
1.31      albertel 13792: 
1.1053    raeburn  13793: sub is_archive_file {
                   13794:     my ($mimetype) = @_;
                   13795:     if (($mimetype eq 'application/octet-stream') ||
                   13796:         ($mimetype eq 'application/x-stuffit') ||
                   13797:         ($mimetype =~ m{^application/(x\-)?(compressed|tar|zip|tgz|gz|gtar|gzip|gunzip|bz|bz2|bzip2)})) {
                   13798:         return 1;
                   13799:     }
                   13800:     return;
                   13801: }
                   13802: 
                   13803: sub decompress_form {
1.1065    raeburn  13804:     my ($mimetype,$archiveurl,$action,$noextract,$hiddenelements,$dirlist) = @_;
1.1053    raeburn  13805:     my %lt = &Apache::lonlocal::texthash (
                   13806:         this => 'This file is an archive file.',
1.1067    raeburn  13807:         camt => 'This file is a Camtasia archive file.',
1.1065    raeburn  13808:         itsc => 'Its contents are as follows:',
1.1053    raeburn  13809:         youm => 'You may wish to extract its contents.',
                   13810:         extr => 'Extract contents',
1.1067    raeburn  13811:         auto => 'LON-CAPA can process the files automatically, or you can decide how each should be handled.',
                   13812:         proa => 'Process automatically?',
1.1053    raeburn  13813:         yes  => 'Yes',
                   13814:         no   => 'No',
1.1067    raeburn  13815:         fold => 'Title for folder containing movie',
                   13816:         movi => 'Title for page containing embedded movie', 
1.1053    raeburn  13817:     );
1.1065    raeburn  13818:     my $fileloc = &Apache::lonnet::filelocation(undef,$archiveurl);
1.1067    raeburn  13819:     my ($is_camtasia,$topdir,%toplevel,@paths);
1.1065    raeburn  13820:     my $info = &list_archive_contents($fileloc,\@paths);
                   13821:     if (@paths) {
                   13822:         foreach my $path (@paths) {
                   13823:             $path =~ s{^/}{};
1.1067    raeburn  13824:             if ($path =~ m{^([^/]+)/$}) {
                   13825:                 $topdir = $1;
                   13826:             }
1.1065    raeburn  13827:             if ($path =~ m{^([^/]+)/}) {
                   13828:                 $toplevel{$1} = $path;
                   13829:             } else {
                   13830:                 $toplevel{$path} = $path;
                   13831:             }
                   13832:         }
                   13833:     }
1.1067    raeburn  13834:     if ($mimetype =~ m{^application/(x\-)?(compressed|zip)}) {
1.1164    raeburn  13835:         my @camtasia6 = ("$topdir/","$topdir/index.html",
1.1067    raeburn  13836:                         "$topdir/media/",
                   13837:                         "$topdir/media/$topdir.mp4",
                   13838:                         "$topdir/media/FirstFrame.png",
                   13839:                         "$topdir/media/player.swf",
                   13840:                         "$topdir/media/swfobject.js",
                   13841:                         "$topdir/media/expressInstall.swf");
1.1197    raeburn  13842:         my @camtasia8_1 = ("$topdir/","$topdir/$topdir.html",
1.1164    raeburn  13843:                          "$topdir/$topdir.mp4",
                   13844:                          "$topdir/$topdir\_config.xml",
                   13845:                          "$topdir/$topdir\_controller.swf",
                   13846:                          "$topdir/$topdir\_embed.css",
                   13847:                          "$topdir/$topdir\_First_Frame.png",
                   13848:                          "$topdir/$topdir\_player.html",
                   13849:                          "$topdir/$topdir\_Thumbnails.png",
                   13850:                          "$topdir/playerProductInstall.swf",
                   13851:                          "$topdir/scripts/",
                   13852:                          "$topdir/scripts/config_xml.js",
                   13853:                          "$topdir/scripts/handlebars.js",
                   13854:                          "$topdir/scripts/jquery-1.7.1.min.js",
                   13855:                          "$topdir/scripts/jquery-ui-1.8.15.custom.min.js",
                   13856:                          "$topdir/scripts/modernizr.js",
                   13857:                          "$topdir/scripts/player-min.js",
                   13858:                          "$topdir/scripts/swfobject.js",
                   13859:                          "$topdir/skins/",
                   13860:                          "$topdir/skins/configuration_express.xml",
                   13861:                          "$topdir/skins/express_show/",
                   13862:                          "$topdir/skins/express_show/player-min.css",
                   13863:                          "$topdir/skins/express_show/spritesheet.png");
1.1197    raeburn  13864:         my @camtasia8_4 = ("$topdir/","$topdir/$topdir.html",
                   13865:                          "$topdir/$topdir.mp4",
                   13866:                          "$topdir/$topdir\_config.xml",
                   13867:                          "$topdir/$topdir\_controller.swf",
                   13868:                          "$topdir/$topdir\_embed.css",
                   13869:                          "$topdir/$topdir\_First_Frame.png",
                   13870:                          "$topdir/$topdir\_player.html",
                   13871:                          "$topdir/$topdir\_Thumbnails.png",
                   13872:                          "$topdir/playerProductInstall.swf",
                   13873:                          "$topdir/scripts/",
                   13874:                          "$topdir/scripts/config_xml.js",
                   13875:                          "$topdir/scripts/techsmith-smart-player.min.js",
                   13876:                          "$topdir/skins/",
                   13877:                          "$topdir/skins/configuration_express.xml",
                   13878:                          "$topdir/skins/express_show/",
                   13879:                          "$topdir/skins/express_show/spritesheet.min.css",
                   13880:                          "$topdir/skins/express_show/spritesheet.png",
                   13881:                          "$topdir/skins/express_show/techsmith-smart-player.min.css");
1.1164    raeburn  13882:         my @diffs = &compare_arrays(\@paths,\@camtasia6);
1.1067    raeburn  13883:         if (@diffs == 0) {
1.1164    raeburn  13884:             $is_camtasia = 6;
                   13885:         } else {
1.1197    raeburn  13886:             @diffs = &compare_arrays(\@paths,\@camtasia8_1);
1.1164    raeburn  13887:             if (@diffs == 0) {
                   13888:                 $is_camtasia = 8;
1.1197    raeburn  13889:             } else {
                   13890:                 @diffs = &compare_arrays(\@paths,\@camtasia8_4);
                   13891:                 if (@diffs == 0) {
                   13892:                     $is_camtasia = 8;
                   13893:                 }
1.1164    raeburn  13894:             }
1.1067    raeburn  13895:         }
                   13896:     }
                   13897:     my $output;
                   13898:     if ($is_camtasia) {
                   13899:         $output = <<"ENDCAM";
                   13900: <script type="text/javascript" language="Javascript">
                   13901: // <![CDATA[
                   13902: 
                   13903: function camtasiaToggle() {
                   13904:     for (var i=0; i<document.uploaded_decompress.autoextract_camtasia.length; i++) {
                   13905:         if (document.uploaded_decompress.autoextract_camtasia[i].checked) {
1.1164    raeburn  13906:             if (document.uploaded_decompress.autoextract_camtasia[i].value == $is_camtasia) {
1.1067    raeburn  13907:                 document.getElementById('camtasia_titles').style.display='block';
                   13908:             } else {
                   13909:                 document.getElementById('camtasia_titles').style.display='none';
                   13910:             }
                   13911:         }
                   13912:     }
                   13913:     return;
                   13914: }
                   13915: 
                   13916: // ]]>
                   13917: </script>
                   13918: <p>$lt{'camt'}</p>
                   13919: ENDCAM
1.1065    raeburn  13920:     } else {
1.1067    raeburn  13921:         $output = '<p>'.$lt{'this'};
                   13922:         if ($info eq '') {
                   13923:             $output .= ' '.$lt{'youm'}.'</p>'."\n";
                   13924:         } else {
                   13925:             $output .= ' '.$lt{'itsc'}.'</p>'."\n".
                   13926:                        '<div><pre>'.$info.'</pre></div>';
                   13927:         }
1.1065    raeburn  13928:     }
1.1067    raeburn  13929:     $output .= '<form name="uploaded_decompress" action="'.$action.'" method="post">'."\n";
1.1065    raeburn  13930:     my $duplicates;
                   13931:     my $num = 0;
                   13932:     if (ref($dirlist) eq 'ARRAY') {
                   13933:         foreach my $item (@{$dirlist}) {
                   13934:             if (ref($item) eq 'ARRAY') {
                   13935:                 if (exists($toplevel{$item->[0]})) {
                   13936:                     $duplicates .= 
                   13937:                         &start_data_table_row().
                   13938:                         '<td><label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   13939:                         'value="0" checked="checked" />'.&mt('No').'</label>'.
                   13940:                         '&nbsp;<label><input type="radio" name="archive_overwrite_'.$num.'" '.
                   13941:                         'value="1" />'.&mt('Yes').'</label>'.
                   13942:                         '<input type="hidden" name="archive_overwrite_name_'.$num.'" value="'.$item->[0].'" /></td>'."\n".
                   13943:                         '<td>'.$item->[0].'</td>';
                   13944:                     if ($item->[2]) {
                   13945:                         $duplicates .= '<td>'.&mt('Directory').'</td>';
                   13946:                     } else {
                   13947:                         $duplicates .= '<td>'.&mt('File').'</td>';
                   13948:                     }
                   13949:                     $duplicates .= '<td>'.$item->[3].'</td>'.
                   13950:                                    '<td>'.
                   13951:                                    &Apache::lonlocal::locallocaltime($item->[4]).
                   13952:                                    '</td>'.
                   13953:                                    &end_data_table_row();
                   13954:                     $num ++;
                   13955:                 }
                   13956:             }
                   13957:         }
                   13958:     }
                   13959:     my $itemcount;
                   13960:     if (@paths > 0) {
                   13961:         $itemcount = scalar(@paths);
                   13962:     } else {
                   13963:         $itemcount = 1;
                   13964:     }
1.1067    raeburn  13965:     if ($is_camtasia) {
                   13966:         $output .= $lt{'auto'}.'<br />'.
                   13967:                    '<span class="LC_nobreak">'.$lt{'proa'}.'<label>'.
1.1164    raeburn  13968:                    '<input type="radio" name="autoextract_camtasia" value="'.$is_camtasia.'" onclick="javascript:camtasiaToggle();" checked="checked" />'.
1.1067    raeburn  13969:                    $lt{'yes'}.'</label>&nbsp;<label>'.
                   13970:                    '<input type="radio" name="autoextract_camtasia" value="0" onclick="javascript:camtasiaToggle();" />'.
                   13971:                    $lt{'no'}.'</label></span><br />'.
                   13972:                    '<div id="camtasia_titles" style="display:block">'.
                   13973:                    &Apache::lonhtmlcommon::start_pick_box().
                   13974:                    &Apache::lonhtmlcommon::row_title($lt{'fold'}).
                   13975:                    '<input type="textbox" name="camtasia_foldername" value="'.$env{'form.comment'}.'" />'."\n".
                   13976:                    &Apache::lonhtmlcommon::row_closure().
                   13977:                    &Apache::lonhtmlcommon::row_title($lt{'movi'}).
                   13978:                    '<input type="textbox" name="camtasia_moviename" value="" />'."\n".
                   13979:                    &Apache::lonhtmlcommon::row_closure(1).
                   13980:                    &Apache::lonhtmlcommon::end_pick_box().
                   13981:                    '</div>';
                   13982:     }
1.1065    raeburn  13983:     $output .= 
                   13984:         '<input type="hidden" name="archive_overwrite_total" value="'.$num.'" />'.
1.1067    raeburn  13985:         '<input type="hidden" name="archive_itemcount" value="'.$itemcount.'" />'.
                   13986:         "\n";
1.1065    raeburn  13987:     if ($duplicates ne '') {
                   13988:         $output .= '<p><span class="LC_warning">'.
                   13989:                    &mt('Warning: decompression of the archive will overwrite the following items which already exist:').'</span><br />'.  
                   13990:                    &start_data_table().
                   13991:                    &start_data_table_header_row().
                   13992:                    '<th>'.&mt('Overwrite?').'</th>'.
                   13993:                    '<th>'.&mt('Name').'</th>'.
                   13994:                    '<th>'.&mt('Type').'</th>'.
                   13995:                    '<th>'.&mt('Size').'</th>'.
                   13996:                    '<th>'.&mt('Last modified').'</th>'.
                   13997:                    &end_data_table_header_row().
                   13998:                    $duplicates.
                   13999:                    &end_data_table().
                   14000:                    '</p>';
                   14001:     }
1.1067    raeburn  14002:     $output .= '<input type="hidden" name="archiveurl" value="'.$archiveurl.'" />'."\n";
1.1053    raeburn  14003:     if (ref($hiddenelements) eq 'HASH') {
                   14004:         foreach my $hidden (sort(keys(%{$hiddenelements}))) {
                   14005:             $output .= '<input type="hidden" name="'.$hidden.'" value="'.$hiddenelements->{$hidden}.'" />'."\n";
                   14006:         }
                   14007:     }
                   14008:     $output .= <<"END";
1.1067    raeburn  14009: <br />
1.1053    raeburn  14010: <input type="submit" name="decompress" value="$lt{'extr'}" />
                   14011: </form>
                   14012: $noextract
                   14013: END
                   14014:     return $output;
                   14015: }
                   14016: 
1.1065    raeburn  14017: sub decompression_utility {
                   14018:     my ($program) = @_;
                   14019:     my @utilities = ('tar','gunzip','bunzip2','unzip'); 
                   14020:     my $location;
                   14021:     if (grep(/^\Q$program\E$/,@utilities)) { 
                   14022:         foreach my $dir ('/bin/','/usr/bin/','/usr/local/bin/','/sbin/',
                   14023:                          '/usr/sbin/') {
                   14024:             if (-x $dir.$program) {
                   14025:                 $location = $dir.$program;
                   14026:                 last;
                   14027:             }
                   14028:         }
                   14029:     }
                   14030:     return $location;
                   14031: }
                   14032: 
                   14033: sub list_archive_contents {
                   14034:     my ($file,$pathsref) = @_;
                   14035:     my (@cmd,$output);
                   14036:     my $needsregexp;
                   14037:     if ($file =~ /\.zip$/) {
                   14038:         @cmd = (&decompression_utility('unzip'),"-l");
                   14039:         $needsregexp = 1;
                   14040:     } elsif (($file =~ m/\.tar\.gz$/) ||
                   14041:              ($file =~ /\.tgz$/)) {
                   14042:         @cmd = (&decompression_utility('tar'),"-ztf");
                   14043:     } elsif ($file =~ /\.tar\.bz2$/) {
                   14044:         @cmd = (&decompression_utility('tar'),"-jtf");
                   14045:     } elsif ($file =~ m|\.tar$|) {
                   14046:         @cmd = (&decompression_utility('tar'),"-tf");
                   14047:     }
                   14048:     if (@cmd) {
                   14049:         undef($!);
                   14050:         undef($@);
                   14051:         if (open(my $fh,"-|", @cmd, $file)) {
                   14052:             while (my $line = <$fh>) {
                   14053:                 $output .= $line;
                   14054:                 chomp($line);
                   14055:                 my $item;
                   14056:                 if ($needsregexp) {
                   14057:                     ($item) = ($line =~ /^\s*\d+\s+[\d\-]+\s+[\d:]+\s*(.+)$/); 
                   14058:                 } else {
                   14059:                     $item = $line;
                   14060:                 }
                   14061:                 if ($item ne '') {
                   14062:                     unless (grep(/^\Q$item\E$/,@{$pathsref})) {
                   14063:                         push(@{$pathsref},$item);
                   14064:                     } 
                   14065:                 }
                   14066:             }
                   14067:             close($fh);
                   14068:         }
                   14069:     }
                   14070:     return $output;
                   14071: }
                   14072: 
1.1053    raeburn  14073: sub decompress_uploaded_file {
                   14074:     my ($file,$dir) = @_;
                   14075:     &Apache::lonnet::appenv({'cgi.file' => $file});
                   14076:     &Apache::lonnet::appenv({'cgi.dir' => $dir});
                   14077:     my $result = &Apache::lonnet::ssi_body('/cgi-bin/decompress.pl');
                   14078:     my ($handle) = ($env{'user.environment'} =~m{/([^/]+)\.id$});
                   14079:     my $lonidsdir = $Apache::lonnet::perlvar{'lonIDsDir'};
                   14080:     &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle,1);
                   14081:     my $decompressed = $env{'cgi.decompressed'};
                   14082:     &Apache::lonnet::delenv('cgi.file');
                   14083:     &Apache::lonnet::delenv('cgi.dir');
                   14084:     &Apache::lonnet::delenv('cgi.decompressed');
                   14085:     return ($decompressed,$result);
                   14086: }
                   14087: 
1.1055    raeburn  14088: sub process_decompression {
                   14089:     my ($docudom,$docuname,$file,$destination,$dir_root,$hiddenelem) = @_;
1.1292    raeburn  14090:     unless (($dir_root eq '/userfiles') && ($destination =~ m{^(docs|supplemental)/(default|\d+)/\d+$})) {
                   14091:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14092:                &mt('Unexpected file path.').'</p>'."\n";
                   14093:     }
                   14094:     unless (($docudom =~ /^$match_domain$/) && ($docuname =~ /^$match_courseid$/)) {
                   14095:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14096:                &mt('Unexpected course context.').'</p>'."\n";
                   14097:     }
1.1293    raeburn  14098:     unless ($file eq &Apache::lonnet::clean_filename($file)) {
1.1292    raeburn  14099:         return '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14100:                &mt('Filename contained unexpected characters.').'</p>'."\n";
                   14101:     }
1.1055    raeburn  14102:     my ($dir,$error,$warning,$output);
1.1180    raeburn  14103:     if ($file !~ /\.(zip|tar|bz2|gz|tar.gz|tar.bz2|tgz)$/i) {
1.1120    bisitz   14104:         $error = &mt('Filename not a supported archive file type.').
                   14105:                  '<br />'.&mt('Filename should end with one of: [_1].',
1.1055    raeburn  14106:                               '.zip, .tar, .bz2, .gz, .tar.gz, .tar.bz2, .tgz');
                   14107:     } else {
                   14108:         my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   14109:         if ($docuhome eq 'no_host') {
                   14110:             $error = &mt('Could not determine home server for course.');
                   14111:         } else {
                   14112:             my @ids=&Apache::lonnet::current_machine_ids();
                   14113:             my $currdir = "$dir_root/$destination";
                   14114:             if (grep(/^\Q$docuhome\E$/,@ids)) {
                   14115:                 $dir = &LONCAPA::propath($docudom,$docuname).
                   14116:                        "$dir_root/$destination";
                   14117:             } else {
                   14118:                 $dir = $Apache::lonnet::perlvar{'lonDocRoot'}.
                   14119:                        "$dir_root/$docudom/$docuname/$destination";
                   14120:                 unless (&Apache::lonnet::repcopy_userfile("$dir/$file") eq 'ok') {
                   14121:                     $error = &mt('Archive file not found.');
                   14122:                 }
                   14123:             }
1.1065    raeburn  14124:             my (@to_overwrite,@to_skip);
                   14125:             if ($env{'form.archive_overwrite_total'} > 0) {
                   14126:                 my $total = $env{'form.archive_overwrite_total'};
                   14127:                 for (my $i=0; $i<$total; $i++) {
                   14128:                     if ($env{'form.archive_overwrite_'.$i} == 1) {
                   14129:                         push(@to_overwrite,$env{'form.archive_overwrite_name_'.$i});
                   14130:                     } elsif ($env{'form.archive_overwrite_'.$i} == 0) {
                   14131:                         push(@to_skip,$env{'form.archive_overwrite_name_'.$i});
                   14132:                     }
                   14133:                 }
                   14134:             }
                   14135:             my $numskip = scalar(@to_skip);
1.1292    raeburn  14136:             my $numoverwrite = scalar(@to_overwrite);
                   14137:             if (($numskip) && (!$numoverwrite)) { 
1.1065    raeburn  14138:                 $warning = &mt('All items in the archive file already exist, and no overwriting of existing files has been requested.');         
                   14139:             } elsif ($dir eq '') {
1.1055    raeburn  14140:                 $error = &mt('Directory containing archive file unavailable.');
                   14141:             } elsif (!$error) {
1.1065    raeburn  14142:                 my ($decompressed,$display);
1.1292    raeburn  14143:                 if (($numskip) || ($numoverwrite)) {
1.1065    raeburn  14144:                     my $tempdir = time.'_'.$$.int(rand(10000));
                   14145:                     mkdir("$dir/$tempdir",0755);
1.1292    raeburn  14146:                     if (&File::Copy::move("$dir/$file","$dir/$tempdir/$file")) {
                   14147:                         ($decompressed,$display) = 
                   14148:                             &decompress_uploaded_file($file,"$dir/$tempdir");
                   14149:                         foreach my $item (@to_skip) {
                   14150:                             if (($item ne '') && ($item !~ /\.\./)) {
                   14151:                                 if (-f "$dir/$tempdir/$item") { 
                   14152:                                     unlink("$dir/$tempdir/$item");
                   14153:                                 } elsif (-d "$dir/$tempdir/$item") {
1.1300    raeburn  14154:                                     &File::Path::remove_tree("$dir/$tempdir/$item",{ safe => 1 });
1.1292    raeburn  14155:                                 }
                   14156:                             }
                   14157:                         }
                   14158:                         foreach my $item (@to_overwrite) {
                   14159:                             if ((-e "$dir/$tempdir/$item") && (-e "$dir/$item")) {
                   14160:                                 if (($item ne '') && ($item !~ /\.\./)) {
                   14161:                                     if (-f "$dir/$item") {
                   14162:                                         unlink("$dir/$item");
                   14163:                                     } elsif (-d "$dir/$item") {
1.1300    raeburn  14164:                                         &File::Path::remove_tree("$dir/$item",{ safe => 1 });
1.1292    raeburn  14165:                                     }
                   14166:                                     &File::Copy::move("$dir/$tempdir/$item","$dir/$item");
                   14167:                                 }
1.1065    raeburn  14168:                             }
                   14169:                         }
1.1292    raeburn  14170:                         if (&File::Copy::move("$dir/$tempdir/$file","$dir/$file")) {
1.1300    raeburn  14171:                             &File::Path::remove_tree("$dir/$tempdir",{ safe => 1 });
1.1292    raeburn  14172:                         }
1.1065    raeburn  14173:                     }
                   14174:                 } else {
                   14175:                     ($decompressed,$display) = 
                   14176:                         &decompress_uploaded_file($file,$dir);
                   14177:                 }
1.1055    raeburn  14178:                 if ($decompressed eq 'ok') {
1.1065    raeburn  14179:                     $output = '<p class="LC_info">'.
                   14180:                               &mt('Files extracted successfully from archive.').
                   14181:                               '</p>'."\n";
1.1055    raeburn  14182:                     my ($warning,$result,@contents);
                   14183:                     my ($newdirlistref,$newlisterror) =
                   14184:                         &Apache::lonnet::dirlist($currdir,$docudom,
                   14185:                                                  $docuname,1);
                   14186:                     my (%is_dir,%changes,@newitems);
                   14187:                     my $dirptr = 16384;
1.1065    raeburn  14188:                     if (ref($newdirlistref) eq 'ARRAY') {
1.1055    raeburn  14189:                         foreach my $dir_line (@{$newdirlistref}) {
                   14190:                             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
1.1292    raeburn  14191:                             unless (($item =~ /^\.+$/) || ($item eq $file)) {
1.1055    raeburn  14192:                                 push(@newitems,$item);
                   14193:                                 if ($dirptr&$testdir) {
                   14194:                                     $is_dir{$item} = 1;
                   14195:                                 }
                   14196:                                 $changes{$item} = 1;
                   14197:                             }
                   14198:                         }
                   14199:                     }
                   14200:                     if (keys(%changes) > 0) {
                   14201:                         foreach my $item (sort(@newitems)) {
                   14202:                             if ($changes{$item}) {
                   14203:                                 push(@contents,$item);
                   14204:                             }
                   14205:                         }
                   14206:                     }
                   14207:                     if (@contents > 0) {
1.1067    raeburn  14208:                         my $wantform;
                   14209:                         unless ($env{'form.autoextract_camtasia'}) {
                   14210:                             $wantform = 1;
                   14211:                         }
1.1056    raeburn  14212:                         my (%children,%parent,%dirorder,%titles);
1.1055    raeburn  14213:                         my ($count,$datatable) = &get_extracted($docudom,$docuname,
                   14214:                                                                 $currdir,\%is_dir,
                   14215:                                                                 \%children,\%parent,
1.1056    raeburn  14216:                                                                 \@contents,\%dirorder,
                   14217:                                                                 \%titles,$wantform);
1.1055    raeburn  14218:                         if ($datatable ne '') {
                   14219:                             $output .= &archive_options_form('decompressed',$datatable,
                   14220:                                                              $count,$hiddenelem);
1.1065    raeburn  14221:                             my $startcount = 6;
1.1055    raeburn  14222:                             $output .= &archive_javascript($startcount,$count,
1.1056    raeburn  14223:                                                            \%titles,\%children);
1.1055    raeburn  14224:                         }
1.1067    raeburn  14225:                         if ($env{'form.autoextract_camtasia'}) {
1.1164    raeburn  14226:                             my $version = $env{'form.autoextract_camtasia'};
1.1067    raeburn  14227:                             my %displayed;
                   14228:                             my $total = 1;
                   14229:                             $env{'form.archive_directory'} = [];
                   14230:                             foreach my $i (sort { $a <=> $b } keys(%dirorder)) {
                   14231:                                 my $path = join('/',map { $titles{$_}; } @{$dirorder{$i}});
                   14232:                                 $path =~ s{/$}{};
                   14233:                                 my $item;
                   14234:                                 if ($path ne '') {
                   14235:                                     $item = "$path/$titles{$i}";
                   14236:                                 } else {
                   14237:                                     $item = $titles{$i};
                   14238:                                 }
                   14239:                                 $env{'form.archive_content_'.$i} = "$dir_root/$destination/$item";
                   14240:                                 if ($item eq $contents[0]) {
                   14241:                                     push(@{$env{'form.archive_directory'}},$i);
                   14242:                                     $env{'form.archive_'.$i} = 'display';
                   14243:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_foldername'};
                   14244:                                     $displayed{'folder'} = $i;
1.1164    raeburn  14245:                                 } elsif ((($item eq "$contents[0]/index.html") && ($version == 6)) ||
                   14246:                                          (($item eq "$contents[0]/$contents[0]".'.html') && ($version == 8))) { 
1.1067    raeburn  14247:                                     $env{'form.archive_'.$i} = 'display';
                   14248:                                     $env{'form.archive_title_'.$i} = $env{'form.camtasia_moviename'};
                   14249:                                     $displayed{'web'} = $i;
                   14250:                                 } else {
1.1164    raeburn  14251:                                     if ((($item eq "$contents[0]/media") && ($version == 6)) ||
                   14252:                                         ((($item eq "$contents[0]/scripts") || ($item eq "$contents[0]/skins") ||
                   14253:                                              ($item eq "$contents[0]/skins/express_show")) && ($version == 8))) {
1.1067    raeburn  14254:                                         push(@{$env{'form.archive_directory'}},$i);
                   14255:                                     }
                   14256:                                     $env{'form.archive_'.$i} = 'dependency';
                   14257:                                 }
                   14258:                                 $total ++;
                   14259:                             }
                   14260:                             for (my $i=1; $i<$total; $i++) {
                   14261:                                 next if ($i == $displayed{'web'});
                   14262:                                 next if ($i == $displayed{'folder'});
                   14263:                                 $env{'form.archive_dependent_on_'.$i} = $displayed{'web'};
                   14264:                             }
                   14265:                             $env{'form.phase'} = 'decompress_cleanup';
                   14266:                             $env{'form.archivedelete'} = 1;
                   14267:                             $env{'form.archive_count'} = $total-1;
                   14268:                             $output .=
                   14269:                                 &process_extracted_files('coursedocs',$docudom,
                   14270:                                                          $docuname,$destination,
                   14271:                                                          $dir_root,$hiddenelem);
                   14272:                         }
1.1055    raeburn  14273:                     } else {
                   14274:                         $warning = &mt('No new items extracted from archive file.');
                   14275:                     }
                   14276:                 } else {
                   14277:                     $output = $display;
                   14278:                     $error = &mt('An error occurred during extraction from the archive file.');
                   14279:                 }
                   14280:             }
                   14281:         }
                   14282:     }
                   14283:     if ($error) {
                   14284:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14285:                    $error.'</p>'."\n";
                   14286:     }
                   14287:     if ($warning) {
                   14288:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   14289:     }
                   14290:     return $output;
                   14291: }
                   14292: 
                   14293: sub get_extracted {
1.1056    raeburn  14294:     my ($docudom,$docuname,$currdir,$is_dir,$children,$parent,$contents,$dirorder,
                   14295:         $titles,$wantform) = @_;
1.1055    raeburn  14296:     my $count = 0;
                   14297:     my $depth = 0;
                   14298:     my $datatable;
1.1056    raeburn  14299:     my @hierarchy;
1.1055    raeburn  14300:     return unless ((ref($is_dir) eq 'HASH') && (ref($children) eq 'HASH') &&
1.1056    raeburn  14301:                    (ref($parent) eq 'HASH') && (ref($contents) eq 'ARRAY') &&
                   14302:                    (ref($dirorder) eq 'HASH') && (ref($titles) eq 'HASH'));
1.1055    raeburn  14303:     foreach my $item (@{$contents}) {
                   14304:         $count ++;
1.1056    raeburn  14305:         @{$dirorder->{$count}} = @hierarchy;
                   14306:         $titles->{$count} = $item;
1.1055    raeburn  14307:         &archive_hierarchy($depth,$count,$parent,$children);
                   14308:         if ($wantform) {
                   14309:             $datatable .= &archive_row($is_dir->{$item},$item,
                   14310:                                        $currdir,$depth,$count);
                   14311:         }
                   14312:         if ($is_dir->{$item}) {
                   14313:             $depth ++;
1.1056    raeburn  14314:             push(@hierarchy,$count);
                   14315:             $parent->{$depth} = $count;
1.1055    raeburn  14316:             $datatable .=
                   14317:                 &recurse_extracted_archive("$currdir/$item",$docudom,$docuname,
1.1056    raeburn  14318:                                            \$depth,\$count,\@hierarchy,$dirorder,
                   14319:                                            $children,$parent,$titles,$wantform);
1.1055    raeburn  14320:             $depth --;
1.1056    raeburn  14321:             pop(@hierarchy);
1.1055    raeburn  14322:         }
                   14323:     }
                   14324:     return ($count,$datatable);
                   14325: }
                   14326: 
                   14327: sub recurse_extracted_archive {
1.1056    raeburn  14328:     my ($currdir,$docudom,$docuname,$depth,$count,$hierarchy,$dirorder,
                   14329:         $children,$parent,$titles,$wantform) = @_;
1.1055    raeburn  14330:     my $result='';
1.1056    raeburn  14331:     unless ((ref($depth)) && (ref($count)) && (ref($hierarchy) eq 'ARRAY') &&
                   14332:             (ref($children) eq 'HASH') && (ref($parent) eq 'HASH') &&
                   14333:             (ref($dirorder) eq 'HASH')) {
1.1055    raeburn  14334:         return $result;
                   14335:     }
                   14336:     my $dirptr = 16384;
                   14337:     my ($newdirlistref,$newlisterror) =
                   14338:         &Apache::lonnet::dirlist($currdir,$docudom,$docuname,1);
                   14339:     if (ref($newdirlistref) eq 'ARRAY') {
                   14340:         foreach my $dir_line (@{$newdirlistref}) {
                   14341:             my ($item,undef,undef,$testdir)=split(/\&/,$dir_line,5);
                   14342:             unless ($item =~ /^\.+$/) {
                   14343:                 $$count ++;
1.1056    raeburn  14344:                 @{$dirorder->{$$count}} = @{$hierarchy};
                   14345:                 $titles->{$$count} = $item;
1.1055    raeburn  14346:                 &archive_hierarchy($$depth,$$count,$parent,$children);
1.1056    raeburn  14347: 
1.1055    raeburn  14348:                 my $is_dir;
                   14349:                 if ($dirptr&$testdir) {
                   14350:                     $is_dir = 1;
                   14351:                 }
                   14352:                 if ($wantform) {
                   14353:                     $result .= &archive_row($is_dir,$item,$currdir,$$depth,$$count);
                   14354:                 }
                   14355:                 if ($is_dir) {
                   14356:                     $$depth ++;
1.1056    raeburn  14357:                     push(@{$hierarchy},$$count);
                   14358:                     $parent->{$$depth} = $$count;
1.1055    raeburn  14359:                     $result .=
                   14360:                         &recurse_extracted_archive("$currdir/$item",$docudom,
                   14361:                                                    $docuname,$depth,$count,
1.1056    raeburn  14362:                                                    $hierarchy,$dirorder,$children,
                   14363:                                                    $parent,$titles,$wantform);
1.1055    raeburn  14364:                     $$depth --;
1.1056    raeburn  14365:                     pop(@{$hierarchy});
1.1055    raeburn  14366:                 }
                   14367:             }
                   14368:         }
                   14369:     }
                   14370:     return $result;
                   14371: }
                   14372: 
                   14373: sub archive_hierarchy {
                   14374:     my ($depth,$count,$parent,$children) =@_;
                   14375:     if ((ref($parent) eq 'HASH') && (ref($children) eq 'HASH')) {
                   14376:         if (exists($parent->{$depth})) {
                   14377:              $children->{$parent->{$depth}} .= $count.':';
                   14378:         }
                   14379:     }
                   14380:     return;
                   14381: }
                   14382: 
                   14383: sub archive_row {
                   14384:     my ($is_dir,$item,$currdir,$depth,$count) = @_;
                   14385:     my ($name) = ($item =~ m{([^/]+)$});
                   14386:     my %choices = &Apache::lonlocal::texthash (
1.1059    raeburn  14387:                                        'display'    => 'Add as file',
1.1055    raeburn  14388:                                        'dependency' => 'Include as dependency',
                   14389:                                        'discard'    => 'Discard',
                   14390:                                       );
                   14391:     if ($is_dir) {
1.1059    raeburn  14392:         $choices{'display'} = &mt('Add as folder'); 
1.1055    raeburn  14393:     }
1.1056    raeburn  14394:     my $output = &start_data_table_row().'<td align="right">'.$count.'</td>'."\n";
                   14395:     my $offset = 0;
1.1055    raeburn  14396:     foreach my $action ('display','dependency','discard') {
1.1056    raeburn  14397:         $offset ++;
1.1065    raeburn  14398:         if ($action ne 'display') {
                   14399:             $offset ++;
                   14400:         }  
1.1055    raeburn  14401:         $output .= '<td><span class="LC_nobreak">'.
                   14402:                    '<label><input type="radio" name="archive_'.$count.
                   14403:                    '" id="archive_'.$action.'_'.$count.'" value="'.$action.'"';
                   14404:         my $text = $choices{$action};
                   14405:         if ($is_dir) {
                   14406:             $output .= ' onclick="javascript:propagateCheck(this.form,'."'$count'".');"';
                   14407:             if ($action eq 'display') {
1.1059    raeburn  14408:                 $text = &mt('Add as folder');
1.1055    raeburn  14409:             }
1.1056    raeburn  14410:         } else {
                   14411:             $output .= ' onclick="javascript:dependencyCheck(this.form,'."$count,$offset".');"';
                   14412: 
                   14413:         }
                   14414:         $output .= ' />&nbsp;'.$choices{$action}.'</label></span>';
                   14415:         if ($action eq 'dependency') {
                   14416:             $output .= '<div id="arc_depon_'.$count.'" style="display:none;">'."\n".
                   14417:                        &mt('Used by:').'&nbsp;<select name="archive_dependent_on_'.$count.'" '.
                   14418:                        'onchange="propagateSelect(this.form,'."$count,$offset".')">'."\n".
                   14419:                        '<option value=""></option>'."\n".
                   14420:                        '</select>'."\n".
                   14421:                        '</div>';
1.1059    raeburn  14422:         } elsif ($action eq 'display') {
                   14423:             $output .= '<div id="arc_title_'.$count.'" style="display:none;">'."\n".
                   14424:                        &mt('Title:').'&nbsp;<input type="text" name="archive_title_'.$count.'" id="archive_title_'.$count.'" />'."\n".
                   14425:                        '</div>';
1.1055    raeburn  14426:         }
1.1056    raeburn  14427:         $output .= '</td>';
1.1055    raeburn  14428:     }
                   14429:     $output .= '<td><input type="hidden" name="archive_content_'.$count.'" value="'.
                   14430:                &HTML::Entities::encode("$currdir/$item",'"<>&').'" />'.('&nbsp;' x 2);
                   14431:     for (my $i=0; $i<$depth; $i++) {
                   14432:         $output .= ('<img src="/adm/lonIcons/whitespace1.gif" class="LC_docs_spacer" alt="" />' x2)."\n";
                   14433:     }
                   14434:     if ($is_dir) {
                   14435:         $output .= '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" />&nbsp;'."\n".
                   14436:                    '<input type="hidden" name="archive_directory" value="'.$count.'" />'."\n";
                   14437:     } else {
                   14438:         $output .= '<input type="hidden" name="archive_file" value="'.$count.'" />'."\n";
                   14439:     }
                   14440:     $output .= '&nbsp;'.$name.'</td>'."\n".
                   14441:                &end_data_table_row();
                   14442:     return $output;
                   14443: }
                   14444: 
                   14445: sub archive_options_form {
1.1065    raeburn  14446:     my ($form,$display,$count,$hiddenelem) = @_;
                   14447:     my %lt = &Apache::lonlocal::texthash(
                   14448:                perm => 'Permanently remove archive file?',
                   14449:                hows => 'How should each extracted item be incorporated in the course?',
                   14450:                cont => 'Content actions for all',
                   14451:                addf => 'Add as folder/file',
                   14452:                incd => 'Include as dependency for a displayed file',
                   14453:                disc => 'Discard',
                   14454:                no   => 'No',
                   14455:                yes  => 'Yes',
                   14456:                save => 'Save',
                   14457:     );
                   14458:     my $output = <<"END";
                   14459: <form name="$form" method="post" action="">
                   14460: <p><span class="LC_nobreak">$lt{'perm'}&nbsp;
                   14461: <label>
                   14462:   <input type="radio" name="archivedelete" value="0" checked="checked" />$lt{'no'}
                   14463: </label>
                   14464: &nbsp;
                   14465: <label>
                   14466:   <input type="radio" name="archivedelete" value="1" />$lt{'yes'}</label>
                   14467: </span>
                   14468: </p>
                   14469: <input type="hidden" name="phase" value="decompress_cleanup" />
                   14470: <br />$lt{'hows'}
                   14471: <div class="LC_columnSection">
                   14472:   <fieldset>
                   14473:     <legend>$lt{'cont'}</legend>
                   14474:     <input type="button" value="$lt{'addf'}" onclick="javascript:checkAll(document.$form,'display');" /> 
                   14475:     &nbsp;&nbsp;<input type="button" value="$lt{'incd'}" onclick="javascript:checkAll(document.$form,'dependency');" />
                   14476:     &nbsp;&nbsp;<input type="button" value="$lt{'disc'}" onclick="javascript:checkAll(document.$form,'discard');" />
                   14477:   </fieldset>
                   14478: </div>
                   14479: END
                   14480:     return $output.
1.1055    raeburn  14481:            &start_data_table()."\n".
1.1065    raeburn  14482:            $display."\n".
1.1055    raeburn  14483:            &end_data_table()."\n".
                   14484:            '<input type="hidden" name="archive_count" value="'.$count.'" />'.
                   14485:            $hiddenelem.
1.1065    raeburn  14486:            '<br /><input type="submit" name="archive_submit" value="'.$lt{'save'}.'" />'.
1.1055    raeburn  14487:            '</form>';
                   14488: }
                   14489: 
                   14490: sub archive_javascript {
1.1056    raeburn  14491:     my ($startcount,$numitems,$titles,$children) = @_;
                   14492:     return unless ((ref($titles) eq 'HASH') && (ref($children) eq 'HASH'));
1.1059    raeburn  14493:     my $maintitle = $env{'form.comment'};
1.1055    raeburn  14494:     my $scripttag = <<START;
                   14495: <script type="text/javascript">
                   14496: // <![CDATA[
                   14497: 
                   14498: function checkAll(form,prefix) {
                   14499:     var idstr =  new RegExp("^archive_"+prefix+"_\\\\d+\$");
                   14500:     for (var i=0; i < form.elements.length; i++) {
                   14501:         var id = form.elements[i].id;
                   14502:         if ((id != '') && (id != undefined)) {
                   14503:             if (idstr.test(id)) {
                   14504:                 if (form.elements[i].type == 'radio') {
                   14505:                     form.elements[i].checked = true;
1.1056    raeburn  14506:                     var nostart = i-$startcount;
1.1059    raeburn  14507:                     var offset = nostart%7;
                   14508:                     var count = (nostart-offset)/7;    
1.1056    raeburn  14509:                     dependencyCheck(form,count,offset);
1.1055    raeburn  14510:                 }
                   14511:             }
                   14512:         }
                   14513:     }
                   14514: }
                   14515: 
                   14516: function propagateCheck(form,count) {
                   14517:     if (count > 0) {
1.1059    raeburn  14518:         var startelement = $startcount + ((count-1) * 7);
                   14519:         for (var j=1; j<6; j++) {
                   14520:             if ((j != 2) && (j != 4)) {
1.1056    raeburn  14521:                 var item = startelement + j; 
                   14522:                 if (form.elements[item].type == 'radio') {
                   14523:                     if (form.elements[item].checked) {
                   14524:                         containerCheck(form,count,j);
                   14525:                         break;
                   14526:                     }
1.1055    raeburn  14527:                 }
                   14528:             }
                   14529:         }
                   14530:     }
                   14531: }
                   14532: 
                   14533: numitems = $numitems
1.1056    raeburn  14534: var titles = new Array(numitems);
                   14535: var parents = new Array(numitems);
1.1055    raeburn  14536: for (var i=0; i<numitems; i++) {
1.1056    raeburn  14537:     parents[i] = new Array;
1.1055    raeburn  14538: }
1.1059    raeburn  14539: var maintitle = '$maintitle';
1.1055    raeburn  14540: 
                   14541: START
                   14542: 
1.1056    raeburn  14543:     foreach my $container (sort { $a <=> $b } (keys(%{$children}))) {
                   14544:         my @contents = split(/:/,$children->{$container});
1.1055    raeburn  14545:         for (my $i=0; $i<@contents; $i ++) {
                   14546:             $scripttag .= 'parents['.$container.']['.$i.'] = '.$contents[$i]."\n";
                   14547:         }
                   14548:     }
                   14549: 
1.1056    raeburn  14550:     foreach my $key (sort { $a <=> $b } (keys(%{$titles}))) {
                   14551:         $scripttag .= "titles[$key] = '".$titles->{$key}."';\n";
                   14552:     }
                   14553: 
1.1055    raeburn  14554:     $scripttag .= <<END;
                   14555: 
                   14556: function containerCheck(form,count,offset) {
                   14557:     if (count > 0) {
1.1056    raeburn  14558:         dependencyCheck(form,count,offset);
1.1059    raeburn  14559:         var item = (offset+$startcount)+7*(count-1);
1.1055    raeburn  14560:         form.elements[item].checked = true;
                   14561:         if(Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   14562:             if (parents[count].length > 0) {
                   14563:                 for (var j=0; j<parents[count].length; j++) {
1.1056    raeburn  14564:                     containerCheck(form,parents[count][j],offset);
                   14565:                 }
                   14566:             }
                   14567:         }
                   14568:     }
                   14569: }
                   14570: 
                   14571: function dependencyCheck(form,count,offset) {
                   14572:     if (count > 0) {
1.1059    raeburn  14573:         var chosen = (offset+$startcount)+7*(count-1);
                   14574:         var depitem = $startcount + ((count-1) * 7) + 4;
1.1056    raeburn  14575:         var currtype = form.elements[depitem].type;
                   14576:         if (form.elements[chosen].value == 'dependency') {
                   14577:             document.getElementById('arc_depon_'+count).style.display='block'; 
                   14578:             form.elements[depitem].options.length = 0;
                   14579:             form.elements[depitem].options[0] = new Option('Select','',true,true);
1.1085    raeburn  14580:             for (var i=1; i<=numitems; i++) {
                   14581:                 if (i == count) {
                   14582:                     continue;
                   14583:                 }
1.1059    raeburn  14584:                 var startelement = $startcount + (i-1) * 7;
                   14585:                 for (var j=1; j<6; j++) {
                   14586:                     if ((j != 2) && (j!= 4)) {
1.1056    raeburn  14587:                         var item = startelement + j;
                   14588:                         if (form.elements[item].type == 'radio') {
                   14589:                             if (form.elements[item].checked) {
                   14590:                                 if (form.elements[item].value == 'display') {
                   14591:                                     var n = form.elements[depitem].options.length;
                   14592:                                     form.elements[depitem].options[n] = new Option(titles[i],i,false,false);
                   14593:                                 }
                   14594:                             }
                   14595:                         }
                   14596:                     }
                   14597:                 }
                   14598:             }
                   14599:         } else {
                   14600:             document.getElementById('arc_depon_'+count).style.display='none';
                   14601:             form.elements[depitem].options.length = 0;
                   14602:             form.elements[depitem].options[0] = new Option('Select','',true,true);
                   14603:         }
1.1059    raeburn  14604:         titleCheck(form,count,offset);
1.1056    raeburn  14605:     }
                   14606: }
                   14607: 
                   14608: function propagateSelect(form,count,offset) {
                   14609:     if (count > 0) {
1.1065    raeburn  14610:         var item = (1+offset+$startcount)+7*(count-1);
1.1056    raeburn  14611:         var picked = form.elements[item].options[form.elements[item].selectedIndex].value; 
                   14612:         if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   14613:             if (parents[count].length > 0) {
                   14614:                 for (var j=0; j<parents[count].length; j++) {
                   14615:                     containerSelect(form,parents[count][j],offset,picked);
1.1055    raeburn  14616:                 }
                   14617:             }
                   14618:         }
                   14619:     }
                   14620: }
1.1056    raeburn  14621: 
                   14622: function containerSelect(form,count,offset,picked) {
                   14623:     if (count > 0) {
1.1065    raeburn  14624:         var item = (offset+$startcount)+7*(count-1);
1.1056    raeburn  14625:         if (form.elements[item].type == 'radio') {
                   14626:             if (form.elements[item].value == 'dependency') {
                   14627:                 if (form.elements[item+1].type == 'select-one') {
                   14628:                     for (var i=0; i<form.elements[item+1].options.length; i++) {
                   14629:                         if (form.elements[item+1].options[i].value == picked) {
                   14630:                             form.elements[item+1].selectedIndex = i;
                   14631:                             break;
                   14632:                         }
                   14633:                     }
                   14634:                 }
                   14635:                 if (Object.prototype.toString.call(parents[count]) === '[object Array]') {
                   14636:                     if (parents[count].length > 0) {
                   14637:                         for (var j=0; j<parents[count].length; j++) {
                   14638:                             containerSelect(form,parents[count][j],offset,picked);
                   14639:                         }
                   14640:                     }
                   14641:                 }
                   14642:             }
                   14643:         }
                   14644:     }
                   14645: }
                   14646: 
1.1059    raeburn  14647: function titleCheck(form,count,offset) {
                   14648:     if (count > 0) {
                   14649:         var chosen = (offset+$startcount)+7*(count-1);
                   14650:         var depitem = $startcount + ((count-1) * 7) + 2;
                   14651:         var currtype = form.elements[depitem].type;
                   14652:         if (form.elements[chosen].value == 'display') {
                   14653:             document.getElementById('arc_title_'+count).style.display='block';
                   14654:             if ((count==1) && ((parents[count].length > 0) || (numitems == 1))) {
                   14655:                 document.getElementById('archive_title_'+count).value=maintitle;
                   14656:             }
                   14657:         } else {
                   14658:             document.getElementById('arc_title_'+count).style.display='none';
                   14659:             if (currtype == 'text') { 
                   14660:                 document.getElementById('archive_title_'+count).value='';
                   14661:             }
                   14662:         }
                   14663:     }
                   14664:     return;
                   14665: }
                   14666: 
1.1055    raeburn  14667: // ]]>
                   14668: </script>
                   14669: END
                   14670:     return $scripttag;
                   14671: }
                   14672: 
                   14673: sub process_extracted_files {
1.1067    raeburn  14674:     my ($context,$docudom,$docuname,$destination,$dir_root,$hiddenelem) = @_;
1.1055    raeburn  14675:     my $numitems = $env{'form.archive_count'};
1.1294    raeburn  14676:     return if ((!$numitems) || ($numitems =~ /\D/));
1.1055    raeburn  14677:     my @ids=&Apache::lonnet::current_machine_ids();
                   14678:     my ($prefix,$pathtocheck,$dir,$ishome,$error,$warning,%toplevelitems,%is_dir,
1.1067    raeburn  14679:         %folders,%containers,%mapinner,%prompttofetch);
1.1055    raeburn  14680:     my $docuhome = &Apache::lonnet::homeserver($docuname,$docudom);
                   14681:     if (grep(/^\Q$docuhome\E$/,@ids)) {
                   14682:         $prefix = &LONCAPA::propath($docudom,$docuname);
                   14683:         $pathtocheck = "$dir_root/$destination";
                   14684:         $dir = $dir_root;
                   14685:         $ishome = 1;
                   14686:     } else {
                   14687:         $prefix = $Apache::lonnet::perlvar{'lonDocRoot'};
                   14688:         $pathtocheck = "$dir_root/$docudom/$docuname/$destination";
1.1294    raeburn  14689:         $dir = "$dir_root/$docudom/$docuname";
1.1055    raeburn  14690:     }
                   14691:     my $currdir = "$dir_root/$destination";
                   14692:     (my $docstype,$mapinner{'0'}) = ($destination =~ m{^(docs|supplemental)/(\w+)/});
                   14693:     if ($env{'form.folderpath'}) {
                   14694:         my @items = split('&',$env{'form.folderpath'});
                   14695:         $folders{'0'} = $items[-2];
1.1099    raeburn  14696:         if ($env{'form.folderpath'} =~ /\:1$/) {
                   14697:             $containers{'0'}='page';
                   14698:         } else {  
                   14699:             $containers{'0'}='sequence';
                   14700:         }
1.1055    raeburn  14701:     }
                   14702:     my @archdirs = &get_env_multiple('form.archive_directory');
                   14703:     if ($numitems) {
                   14704:         for (my $i=1; $i<=$numitems; $i++) {
                   14705:             my $path = $env{'form.archive_content_'.$i};
                   14706:             if ($path =~ m{^\Q$pathtocheck\E/([^/]+)$}) {
                   14707:                 my $item = $1;
                   14708:                 $toplevelitems{$item} = $i;
                   14709:                 if (grep(/^\Q$i\E$/,@archdirs)) {
                   14710:                     $is_dir{$item} = 1;
                   14711:                 }
                   14712:             }
                   14713:         }
                   14714:     }
1.1067    raeburn  14715:     my ($output,%children,%parent,%titles,%dirorder,$result);
1.1055    raeburn  14716:     if (keys(%toplevelitems) > 0) {
                   14717:         my @contents = sort(keys(%toplevelitems));
1.1056    raeburn  14718:         (my $count,undef) = &get_extracted($docudom,$docuname,$currdir,\%is_dir,\%children,
                   14719:                                            \%parent,\@contents,\%dirorder,\%titles);
1.1055    raeburn  14720:     }
1.1066    raeburn  14721:     my (%referrer,%orphaned,%todelete,%todeletedir,%newdest,%newseqid);
1.1055    raeburn  14722:     if ($numitems) {
                   14723:         for (my $i=1; $i<=$numitems; $i++) {
1.1086    raeburn  14724:             next if ($env{'form.archive_'.$i} eq 'dependency');
1.1055    raeburn  14725:             my $path = $env{'form.archive_content_'.$i};
                   14726:             if ($path =~ /^\Q$pathtocheck\E/) {
                   14727:                 if ($env{'form.archive_'.$i} eq 'discard') {
                   14728:                     if ($prefix ne '' && $path ne '') {
                   14729:                         if (-e $prefix.$path) {
1.1066    raeburn  14730:                             if ((@archdirs > 0) && 
                   14731:                                 (grep(/^\Q$i\E$/,@archdirs))) {
                   14732:                                 $todeletedir{$prefix.$path} = 1;
                   14733:                             } else {
                   14734:                                 $todelete{$prefix.$path} = 1;
                   14735:                             }
1.1055    raeburn  14736:                         }
                   14737:                     }
                   14738:                 } elsif ($env{'form.archive_'.$i} eq 'display') {
1.1059    raeburn  14739:                     my ($docstitle,$title,$url,$outer);
1.1055    raeburn  14740:                     ($title) = ($path =~ m{/([^/]+)$});
1.1059    raeburn  14741:                     $docstitle = $env{'form.archive_title_'.$i};
                   14742:                     if ($docstitle eq '') {
                   14743:                         $docstitle = $title;
                   14744:                     }
1.1055    raeburn  14745:                     $outer = 0;
1.1056    raeburn  14746:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   14747:                         if (@{$dirorder{$i}} > 0) {
                   14748:                             foreach my $item (reverse(@{$dirorder{$i}})) {
1.1055    raeburn  14749:                                 if ($env{'form.archive_'.$item} eq 'display') {
                   14750:                                     $outer = $item;
                   14751:                                     last;
                   14752:                                 }
                   14753:                             }
                   14754:                         }
                   14755:                     }
                   14756:                     my ($errtext,$fatal) = 
                   14757:                         &LONCAPA::map::mapread('/uploaded/'.$docudom.'/'.$docuname.
                   14758:                                                '/'.$folders{$outer}.'.'.
                   14759:                                                $containers{$outer});
                   14760:                     next if ($fatal);
                   14761:                     if ((@archdirs > 0) && (grep(/^\Q$i\E$/,@archdirs))) {
                   14762:                         if ($context eq 'coursedocs') {
1.1056    raeburn  14763:                             $mapinner{$i} = time;
1.1055    raeburn  14764:                             $folders{$i} = 'default_'.$mapinner{$i};
                   14765:                             $containers{$i} = 'sequence';
                   14766:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   14767:                                       $folders{$i}.'.'.$containers{$i};
                   14768:                             my $newidx = &LONCAPA::map::getresidx();
                   14769:                             $LONCAPA::map::resources[$newidx]=
1.1059    raeburn  14770:                                 $docstitle.':'.$url.':false:normal:res';
1.1055    raeburn  14771:                             push(@LONCAPA::map::order,$newidx);
                   14772:                             my ($outtext,$errtext) =
                   14773:                                 &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   14774:                                                         $docuname.'/'.$folders{$outer}.
1.1087    raeburn  14775:                                                         '.'.$containers{$outer},1,1);
1.1056    raeburn  14776:                             $newseqid{$i} = $newidx;
1.1067    raeburn  14777:                             unless ($errtext) {
1.1294    raeburn  14778:                                 $result .=  '<li>'.&mt('Folder: [_1] added to course',
                   14779:                                                        &HTML::Entities::encode($docstitle,'<>&"')).
                   14780:                                             '</li>'."\n";
1.1067    raeburn  14781:                             }
1.1055    raeburn  14782:                         }
                   14783:                     } else {
                   14784:                         if ($context eq 'coursedocs') {
                   14785:                             my $newidx=&LONCAPA::map::getresidx();
                   14786:                             my $url = '/uploaded/'.$docudom.'/'.$docuname.'/'.
                   14787:                                       $docstype.'/'.$mapinner{$outer}.'/'.$newidx.'/'.
                   14788:                                       $title;
1.1392    raeburn  14789:                             if (($outer !~ /\D/) &&
                   14790:                                 (($mapinner{$outer} eq 'default') || ($mapinner{$outer} !~ /\D/)) &&
                   14791:                                 ($newidx !~ /\D/)) {
1.1294    raeburn  14792:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}") {
                   14793:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}",0755);
                   14794:                                 }
                   14795:                                 if (!-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   14796:                                     mkdir("$prefix$dir/$docstype/$mapinner{$outer}/$newidx");
                   14797:                                 }
                   14798:                                 if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx") {
                   14799:                                     if (rename("$prefix$path","$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title")) {
                   14800:                                         $newdest{$i} = "$prefix$dir/$docstype/$mapinner{$outer}/$newidx";
                   14801:                                         unless ($ishome) {
                   14802:                                             my $fetch = "$newdest{$i}/$title";
                   14803:                                             $fetch =~ s/^\Q$prefix$dir\E//;
                   14804:                                             $prompttofetch{$fetch} = 1;
                   14805:                                         }
1.1292    raeburn  14806:                                     }
1.1067    raeburn  14807:                                 }
1.1294    raeburn  14808:                                 $LONCAPA::map::resources[$newidx]=
                   14809:                                     $docstitle.':'.$url.':false:normal:res';
                   14810:                                 push(@LONCAPA::map::order, $newidx);
                   14811:                                 my ($outtext,$errtext)=
                   14812:                                     &LONCAPA::map::storemap('/uploaded/'.$docudom.'/'.
                   14813:                                                             $docuname.'/'.$folders{$outer}.
                   14814:                                                             '.'.$containers{$outer},1,1);
                   14815:                                 unless ($errtext) {
                   14816:                                     if (-e "$prefix$dir/$docstype/$mapinner{$outer}/$newidx/$title") {
                   14817:                                         $result .= '<li>'.&mt('File: [_1] added to course',
                   14818:                                                               &HTML::Entities::encode($docstitle,'<>&"')).
                   14819:                                                    '</li>'."\n";
                   14820:                                     }
1.1067    raeburn  14821:                                 }
1.1294    raeburn  14822:                             } else {
                   14823:                                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   14824:                                                 &HTML::Entities::encode($path,'<>&"')).'<br />';
1.1296    raeburn  14825:                             }
1.1055    raeburn  14826:                         }
                   14827:                     }
1.1086    raeburn  14828:                 }
                   14829:             } else {
1.1294    raeburn  14830:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
                   14831:                                 &HTML::Entities::encode($path,'<>&"')).'<br />'; 
1.1086    raeburn  14832:             }
                   14833:         }
                   14834:         for (my $i=1; $i<=$numitems; $i++) {
                   14835:             next unless ($env{'form.archive_'.$i} eq 'dependency');
                   14836:             my $path = $env{'form.archive_content_'.$i};
                   14837:             if ($path =~ /^\Q$pathtocheck\E/) {
                   14838:                 my ($title) = ($path =~ m{/([^/]+)$});
                   14839:                 $referrer{$i} = $env{'form.archive_dependent_on_'.$i};
                   14840:                 if ($env{'form.archive_'.$referrer{$i}} eq 'display') {
                   14841:                     if (ref($dirorder{$i}) eq 'ARRAY') {
                   14842:                         my ($itemidx,$fullpath,$relpath);
                   14843:                         if (ref($dirorder{$referrer{$i}}) eq 'ARRAY') {
                   14844:                             my $container = $dirorder{$referrer{$i}}->[-1];
1.1056    raeburn  14845:                             for (my $j=0; $j<@{$dirorder{$i}}; $j++) {
1.1086    raeburn  14846:                                 if ($dirorder{$i}->[$j] eq $container) {
                   14847:                                     $itemidx = $j;
1.1056    raeburn  14848:                                 }
                   14849:                             }
1.1086    raeburn  14850:                         }
                   14851:                         if ($itemidx eq '') {
                   14852:                             $itemidx =  0;
                   14853:                         } 
                   14854:                         if (grep(/^\Q$referrer{$i}\E$/,@archdirs)) {
                   14855:                             if ($mapinner{$referrer{$i}}) {
                   14856:                                 $fullpath = "$prefix$dir/$docstype/$mapinner{$referrer{$i}}";
                   14857:                                 for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   14858:                                     if (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   14859:                                         unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   14860:                                             $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   14861:                                             $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   14862:                                             if (!-e $fullpath) {
                   14863:                                                 mkdir($fullpath,0755);
1.1056    raeburn  14864:                                             }
                   14865:                                         }
1.1086    raeburn  14866:                                     } else {
                   14867:                                         last;
1.1056    raeburn  14868:                                     }
1.1086    raeburn  14869:                                 }
                   14870:                             }
                   14871:                         } elsif ($newdest{$referrer{$i}}) {
                   14872:                             $fullpath = $newdest{$referrer{$i}};
                   14873:                             for (my $j=$itemidx; $j<@{$dirorder{$i}}; $j++) {
                   14874:                                 if ($env{'form.archive_'.$dirorder{$i}->[$j]} eq 'discard') {
                   14875:                                     $orphaned{$i} = $env{'form.archive_'.$dirorder{$i}->[$j]};
                   14876:                                     last;
                   14877:                                 } elsif (grep(/^\Q$dirorder{$i}->[$j]\E$/,@archdirs)) {
                   14878:                                     unless (defined($newseqid{$dirorder{$i}->[$j]})) {
                   14879:                                         $fullpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   14880:                                         $relpath .= '/'.$titles{$dirorder{$i}->[$j]};
                   14881:                                         if (!-e $fullpath) {
                   14882:                                             mkdir($fullpath,0755);
1.1056    raeburn  14883:                                         }
                   14884:                                     }
1.1086    raeburn  14885:                                 } else {
                   14886:                                     last;
1.1056    raeburn  14887:                                 }
1.1055    raeburn  14888:                             }
                   14889:                         }
1.1086    raeburn  14890:                         if ($fullpath ne '') {
                   14891:                             if (-e "$prefix$path") {
1.1292    raeburn  14892:                                 unless (rename("$prefix$path","$fullpath/$title")) {
                   14893:                                      $warning .= &mt('Failed to rename dependency').'<br />';
                   14894:                                 }
1.1086    raeburn  14895:                             }
                   14896:                             if (-e "$fullpath/$title") {
                   14897:                                 my $showpath;
                   14898:                                 if ($relpath ne '') {
                   14899:                                     $showpath = "$relpath/$title";
                   14900:                                 } else {
                   14901:                                     $showpath = "/$title";
                   14902:                                 } 
1.1294    raeburn  14903:                                 $result .= '<li>'.&mt('[_1] included as a dependency',
                   14904:                                                       &HTML::Entities::encode($showpath,'<>&"')).
                   14905:                                            '</li>'."\n";
1.1292    raeburn  14906:                                 unless ($ishome) {
                   14907:                                     my $fetch = "$fullpath/$title";
                   14908:                                     $fetch =~ s/^\Q$prefix$dir\E//; 
                   14909:                                     $prompttofetch{$fetch} = 1;
                   14910:                                 }
1.1086    raeburn  14911:                             }
                   14912:                         }
1.1055    raeburn  14913:                     }
1.1086    raeburn  14914:                 } elsif ($env{'form.archive_'.$referrer{$i}} eq 'discard') {
                   14915:                     $warning .= &mt('[_1] is a dependency of [_2], which was discarded.',
1.1294    raeburn  14916:                                     &HTML::Entities::encode($path,'<>&"'),
                   14917:                                     &HTML::Entities::encode($env{'form.archive_content_'.$referrer{$i}},'<>&"')).
                   14918:                                 '<br />';
1.1055    raeburn  14919:                 }
                   14920:             } else {
1.1294    raeburn  14921:                 $warning .= &mt('Item extracted from archive: [_1] has unexpected path.',
1.1296    raeburn  14922:                                 &HTML::Entities::encode($path)).'<br />';
1.1055    raeburn  14923:             }
                   14924:         }
                   14925:         if (keys(%todelete)) {
                   14926:             foreach my $key (keys(%todelete)) {
                   14927:                 unlink($key);
1.1066    raeburn  14928:             }
                   14929:         }
                   14930:         if (keys(%todeletedir)) {
                   14931:             foreach my $key (keys(%todeletedir)) {
                   14932:                 rmdir($key);
                   14933:             }
                   14934:         }
                   14935:         foreach my $dir (sort(keys(%is_dir))) {
                   14936:             if (($pathtocheck ne '') && ($dir ne ''))  {
                   14937:                 &cleanup_empty_dirs($prefix."$pathtocheck/$dir");
1.1055    raeburn  14938:             }
                   14939:         }
1.1067    raeburn  14940:         if ($result ne '') {
                   14941:             $output .= '<ul>'."\n".
                   14942:                        $result."\n".
                   14943:                        '</ul>';
                   14944:         }
                   14945:         unless ($ishome) {
                   14946:             my $replicationfail;
                   14947:             foreach my $item (keys(%prompttofetch)) {
                   14948:                 my $fetchresult= &Apache::lonnet::reply('fetchuserfile:'.$item,$docuhome);
                   14949:                 unless ($fetchresult eq 'ok') {
                   14950:                     $replicationfail .= '<li>'.$item.'</li>'."\n";
                   14951:                 }
                   14952:             }
                   14953:             if ($replicationfail) {
                   14954:                 $output .= '<p class="LC_error">'.
                   14955:                            &mt('Course home server failed to retrieve:').'<ul>'.
                   14956:                            $replicationfail.
                   14957:                            '</ul></p>';
                   14958:             }
                   14959:         }
1.1055    raeburn  14960:     } else {
                   14961:         $warning = &mt('No items found in archive.');
                   14962:     }
                   14963:     if ($error) {
                   14964:         $output .= '<p class="LC_error">'.&mt('Not extracted.').'<br />'.
                   14965:                    $error.'</p>'."\n";
                   14966:     }
                   14967:     if ($warning) {
                   14968:         $output .= '<p class="LC_warning">'.$warning.'</p>'."\n";
                   14969:     }
                   14970:     return $output;
                   14971: }
                   14972: 
1.1066    raeburn  14973: sub cleanup_empty_dirs {
                   14974:     my ($path) = @_;
                   14975:     if (($path ne '') && (-d $path)) {
                   14976:         if (opendir(my $dirh,$path)) {
                   14977:             my @dircontents = grep(!/^\./,readdir($dirh));
                   14978:             my $numitems = 0;
                   14979:             foreach my $item (@dircontents) {
                   14980:                 if (-d "$path/$item") {
1.1111    raeburn  14981:                     &cleanup_empty_dirs("$path/$item");
1.1066    raeburn  14982:                     if (-e "$path/$item") {
                   14983:                         $numitems ++;
                   14984:                     }
                   14985:                 } else {
                   14986:                     $numitems ++;
                   14987:                 }
                   14988:             }
                   14989:             if ($numitems == 0) {
                   14990:                 rmdir($path);
                   14991:             }
                   14992:             closedir($dirh);
                   14993:         }
                   14994:     }
                   14995:     return;
                   14996: }
                   14997: 
1.41      ng       14998: =pod
1.45      matthew  14999: 
1.1162    raeburn  15000: =item * &get_folder_hierarchy()
1.1068    raeburn  15001: 
                   15002: Provides hierarchy of names of folders/sub-folders containing the current
                   15003: item,
                   15004: 
                   15005: Inputs: 3
                   15006:      - $navmap - navmaps object
                   15007: 
                   15008:      - $map - url for map (either the trigger itself, or map containing
                   15009:                            the resource, which is the trigger).
                   15010: 
                   15011:      - $showitem - 1 => show title for map itself; 0 => do not show.
                   15012: 
                   15013: Outputs: 1 @pathitems - array of folder/subfolder names.
                   15014: 
                   15015: =cut
                   15016: 
                   15017: sub get_folder_hierarchy {
                   15018:     my ($navmap,$map,$showitem) = @_;
                   15019:     my @pathitems;
                   15020:     if (ref($navmap)) {
                   15021:         my $mapres = $navmap->getResourceByUrl($map);
                   15022:         if (ref($mapres)) {
                   15023:             my $pcslist = $mapres->map_hierarchy();
                   15024:             if ($pcslist ne '') {
                   15025:                 my @pcs = split(/,/,$pcslist);
                   15026:                 foreach my $pc (@pcs) {
                   15027:                     if ($pc == 1) {
1.1129    raeburn  15028:                         push(@pathitems,&mt('Main Content'));
1.1068    raeburn  15029:                     } else {
                   15030:                         my $res = $navmap->getByMapPc($pc);
                   15031:                         if (ref($res)) {
                   15032:                             my $title = $res->compTitle();
                   15033:                             $title =~ s/\W+/_/g;
                   15034:                             if ($title ne '') {
                   15035:                                 push(@pathitems,$title);
                   15036:                             }
                   15037:                         }
                   15038:                     }
                   15039:                 }
                   15040:             }
1.1071    raeburn  15041:             if ($showitem) {
                   15042:                 if ($mapres->{ID} eq '0.0') {
1.1129    raeburn  15043:                     push(@pathitems,&mt('Main Content'));
1.1071    raeburn  15044:                 } else {
                   15045:                     my $maptitle = $mapres->compTitle();
                   15046:                     $maptitle =~ s/\W+/_/g;
                   15047:                     if ($maptitle ne '') {
                   15048:                         push(@pathitems,$maptitle);
                   15049:                     }
1.1068    raeburn  15050:                 }
                   15051:             }
                   15052:         }
                   15053:     }
                   15054:     return @pathitems;
                   15055: }
                   15056: 
                   15057: =pod
                   15058: 
1.1015    raeburn  15059: =item * &get_turnedin_filepath()
                   15060: 
                   15061: Determines path in a user's portfolio file for storage of files uploaded
                   15062: to a specific essayresponse or dropbox item.
                   15063: 
                   15064: Inputs: 3 required + 1 optional.
                   15065: $symb is symb for resource, $uname and $udom are for current user (required).
                   15066: $caller is optional (can be "submission", if routine is called when storing
                   15067: an upoaded file when "Submit Answer" button was pressed).
                   15068: 
                   15069: Returns array containing $path and $multiresp. 
                   15070: $path is path in portfolio.  $multiresp is 1 if this resource contains more
                   15071: than one file upload item.  Callers of routine should append partid as a 
                   15072: subdirectory to $path in cases where $multiresp is 1.
                   15073: 
                   15074: Called by: homework/essayresponse.pm and homework/structuretags.pm
                   15075: 
                   15076: =cut
                   15077: 
                   15078: sub get_turnedin_filepath {
                   15079:     my ($symb,$uname,$udom,$caller) = @_;
                   15080:     my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
                   15081:     my $turnindir;
                   15082:     my %userhash = &Apache::lonnet::userenvironment($udom,$uname,'turnindir');
                   15083:     $turnindir = $userhash{'turnindir'};
                   15084:     my ($path,$multiresp);
                   15085:     if ($turnindir eq '') {
                   15086:         if ($caller eq 'submission') {
                   15087:             $turnindir = &mt('turned in');
                   15088:             $turnindir =~ s/\W+/_/g;
                   15089:             my %newhash = (
                   15090:                             'turnindir' => $turnindir,
                   15091:                           );
                   15092:             &Apache::lonnet::put('environment',\%newhash,$udom,$uname);
                   15093:         }
                   15094:     }
                   15095:     if ($turnindir ne '') {
                   15096:         $path = '/'.$turnindir.'/';
                   15097:         my ($multipart,$turnin,@pathitems);
                   15098:         my $navmap = Apache::lonnavmaps::navmap->new();
                   15099:         if (defined($navmap)) {
                   15100:             my $mapres = $navmap->getResourceByUrl($map);
                   15101:             if (ref($mapres)) {
                   15102:                 my $pcslist = $mapres->map_hierarchy();
                   15103:                 if ($pcslist ne '') {
                   15104:                     foreach my $pc (split(/,/,$pcslist)) {
                   15105:                         my $res = $navmap->getByMapPc($pc);
                   15106:                         if (ref($res)) {
                   15107:                             my $title = $res->compTitle();
                   15108:                             $title =~ s/\W+/_/g;
                   15109:                             if ($title ne '') {
1.1149    raeburn  15110:                                 if (($pc > 1) && (length($title) > 12)) {
                   15111:                                     $title = substr($title,0,12);
                   15112:                                 }
1.1015    raeburn  15113:                                 push(@pathitems,$title);
                   15114:                             }
                   15115:                         }
                   15116:                     }
                   15117:                 }
                   15118:                 my $maptitle = $mapres->compTitle();
                   15119:                 $maptitle =~ s/\W+/_/g;
                   15120:                 if ($maptitle ne '') {
1.1149    raeburn  15121:                     if (length($maptitle) > 12) {
                   15122:                         $maptitle = substr($maptitle,0,12);
                   15123:                     }
1.1015    raeburn  15124:                     push(@pathitems,$maptitle);
                   15125:                 }
                   15126:                 unless ($env{'request.state'} eq 'construct') {
                   15127:                     my $res = $navmap->getBySymb($symb);
                   15128:                     if (ref($res)) {
                   15129:                         my $partlist = $res->parts();
                   15130:                         my $totaluploads = 0;
                   15131:                         if (ref($partlist) eq 'ARRAY') {
                   15132:                             foreach my $part (@{$partlist}) {
                   15133:                                 my @types = $res->responseType($part);
                   15134:                                 my @ids = $res->responseIds($part);
                   15135:                                 for (my $i=0; $i < scalar(@ids); $i++) {
                   15136:                                     if ($types[$i] eq 'essay') {
                   15137:                                         my $partid = $part.'_'.$ids[$i];
                   15138:                                         if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                   15139:                                             $totaluploads ++;
                   15140:                                         }
                   15141:                                     }
                   15142:                                 }
                   15143:                             }
                   15144:                             if ($totaluploads > 1) {
                   15145:                                 $multiresp = 1;
                   15146:                             }
                   15147:                         }
                   15148:                     }
                   15149:                 }
                   15150:             } else {
                   15151:                 return;
                   15152:             }
                   15153:         } else {
                   15154:             return;
                   15155:         }
                   15156:         my $restitle=&Apache::lonnet::gettitle($symb);
                   15157:         $restitle =~ s/\W+/_/g;
                   15158:         if ($restitle eq '') {
                   15159:             $restitle = ($resurl =~ m{/[^/]+$});
                   15160:             if ($restitle eq '') {
                   15161:                 $restitle = time;
                   15162:             }
                   15163:         }
1.1149    raeburn  15164:         if (length($restitle) > 12) {
                   15165:             $restitle = substr($restitle,0,12);
                   15166:         }
1.1015    raeburn  15167:         push(@pathitems,$restitle);
                   15168:         $path .= join('/',@pathitems);
                   15169:     }
                   15170:     return ($path,$multiresp);
                   15171: }
                   15172: 
                   15173: =pod
                   15174: 
1.464     albertel 15175: =back
1.41      ng       15176: 
1.112     bowersj2 15177: =head1 CSV Upload/Handling functions
1.38      albertel 15178: 
1.41      ng       15179: =over 4
                   15180: 
1.648     raeburn  15181: =item * &upfile_store($r)
1.41      ng       15182: 
                   15183: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 15184: needs $env{'form.upfile'}
1.41      ng       15185: returns $datatoken to be put into hidden field
                   15186: 
                   15187: =cut
1.31      albertel 15188: 
                   15189: sub upfile_store {
                   15190:     my $r=shift;
1.258     albertel 15191:     $env{'form.upfile'}=~s/\r/\n/gs;
                   15192:     $env{'form.upfile'}=~s/\f/\n/gs;
                   15193:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   15194:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 15195: 
1.1299    raeburn  15196:     my $datatoken = &valid_datatoken($env{'user.name'}.'_'.$env{'user.domain'}.
                   15197:                                      '_enroll_'.$env{'request.course.id'}.'_'.
                   15198:                                      time.'_'.$$);
                   15199:     return if ($datatoken eq '');
                   15200: 
1.31      albertel 15201:     {
1.158     raeburn  15202:         my $datafile = $r->dir_config('lonDaemons').
                   15203:                            '/tmp/'.$datatoken.'.tmp';
1.1317    raeburn  15204:         if ( open(my $fh,'>',$datafile) ) {
1.258     albertel 15205:             print $fh $env{'form.upfile'};
1.158     raeburn  15206:             close($fh);
                   15207:         }
1.31      albertel 15208:     }
                   15209:     return $datatoken;
                   15210: }
                   15211: 
1.56      matthew  15212: =pod
                   15213: 
1.1290    raeburn  15214: =item * &load_tmp_file($r,$datatoken)
1.41      ng       15215: 
                   15216: Load uploaded file from tmp, $r should be the HTTP Request object,
1.1290    raeburn  15217: $datatoken is the name to assign to the temporary file.
1.258     albertel 15218: sets $env{'form.upfile'} to the contents of the file
1.41      ng       15219: 
                   15220: =cut
1.31      albertel 15221: 
                   15222: sub load_tmp_file {
1.1290    raeburn  15223:     my ($r,$datatoken) = @_;
                   15224:     return if ($datatoken eq '');
1.31      albertel 15225:     my @studentdata=();
                   15226:     {
1.158     raeburn  15227:         my $studentfile = $r->dir_config('lonDaemons').
1.1290    raeburn  15228:                               '/tmp/'.$datatoken.'.tmp';
1.1317    raeburn  15229:         if ( open(my $fh,'<',$studentfile) ) {
1.158     raeburn  15230:             @studentdata=<$fh>;
                   15231:             close($fh);
                   15232:         }
1.31      albertel 15233:     }
1.258     albertel 15234:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 15235: }
                   15236: 
1.1290    raeburn  15237: sub valid_datatoken {
                   15238:     my ($datatoken) = @_;
1.1325    raeburn  15239:     if ($datatoken =~ /^$match_username\_$match_domain\_enroll_(|$match_domain\_$match_courseid)\_\d+_\d+$/) {
1.1290    raeburn  15240:         return $datatoken;
                   15241:     }
                   15242:     return;
                   15243: }
                   15244: 
1.56      matthew  15245: =pod
                   15246: 
1.648     raeburn  15247: =item * &upfile_record_sep()
1.41      ng       15248: 
                   15249: Separate uploaded file into records
                   15250: returns array of records,
1.258     albertel 15251: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       15252: 
                   15253: =cut
1.31      albertel 15254: 
                   15255: sub upfile_record_sep {
1.258     albertel 15256:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 15257:     } else {
1.248     albertel 15258: 	my @records;
1.258     albertel 15259: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 15260: 	    if ($line=~/^\s*$/) { next; }
                   15261: 	    push(@records,$line);
                   15262: 	}
                   15263: 	return @records;
1.31      albertel 15264:     }
                   15265: }
                   15266: 
1.56      matthew  15267: =pod
                   15268: 
1.648     raeburn  15269: =item * &record_sep($record)
1.41      ng       15270: 
1.258     albertel 15271: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       15272: 
                   15273: =cut
                   15274: 
1.263     www      15275: sub takeleft {
                   15276:     my $index=shift;
                   15277:     return substr('0000'.$index,-4,4);
                   15278: }
                   15279: 
1.31      albertel 15280: sub record_sep {
                   15281:     my $record=shift;
                   15282:     my %components=();
1.258     albertel 15283:     if ($env{'form.upfiletype'} eq 'xml') {
                   15284:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 15285:         my $i=0;
1.356     albertel 15286:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 15287:             $field=~s/^(\"|\')//;
                   15288:             $field=~s/(\"|\')$//;
1.263     www      15289:             $components{&takeleft($i)}=$field;
1.31      albertel 15290:             $i++;
                   15291:         }
1.258     albertel 15292:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 15293:         my $i=0;
1.356     albertel 15294:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 15295:             $field=~s/^(\"|\')//;
                   15296:             $field=~s/(\"|\')$//;
1.263     www      15297:             $components{&takeleft($i)}=$field;
1.31      albertel 15298:             $i++;
                   15299:         }
                   15300:     } else {
1.561     www      15301:         my $separator=',';
1.480     banghart 15302:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      15303:             $separator=';';
1.480     banghart 15304:         }
1.31      albertel 15305:         my $i=0;
1.561     www      15306: # the character we are looking for to indicate the end of a quote or a record 
                   15307:         my $looking_for=$separator;
                   15308: # do not add the characters to the fields
                   15309:         my $ignore=0;
                   15310: # we just encountered a separator (or the beginning of the record)
                   15311:         my $just_found_separator=1;
                   15312: # store the field we are working on here
                   15313:         my $field='';
                   15314: # work our way through all characters in record
                   15315:         foreach my $character ($record=~/(.)/g) {
                   15316:             if ($character eq $looking_for) {
                   15317:                if ($character ne $separator) {
                   15318: # Found the end of a quote, again looking for separator
                   15319:                   $looking_for=$separator;
                   15320:                   $ignore=1;
                   15321:                } else {
                   15322: # Found a separator, store away what we got
                   15323:                   $components{&takeleft($i)}=$field;
                   15324: 	          $i++;
                   15325:                   $just_found_separator=1;
                   15326:                   $ignore=0;
                   15327:                   $field='';
                   15328:                }
                   15329:                next;
                   15330:             }
                   15331: # single or double quotation marks after a separator indicate beginning of a quote
                   15332: # we are now looking for the end of the quote and need to ignore separators
                   15333:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   15334:                $looking_for=$character;
                   15335:                next;
                   15336:             }
                   15337: # ignore would be true after we reached the end of a quote
                   15338:             if ($ignore) { next; }
                   15339:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   15340:             $field.=$character;
                   15341:             $just_found_separator=0; 
1.31      albertel 15342:         }
1.561     www      15343: # catch the very last entry, since we never encountered the separator
                   15344:         $components{&takeleft($i)}=$field;
1.31      albertel 15345:     }
                   15346:     return %components;
                   15347: }
                   15348: 
1.144     matthew  15349: ######################################################
                   15350: ######################################################
                   15351: 
1.56      matthew  15352: =pod
                   15353: 
1.648     raeburn  15354: =item * &upfile_select_html()
1.41      ng       15355: 
1.144     matthew  15356: Return HTML code to select a file from the users machine and specify 
                   15357: the file type.
1.41      ng       15358: 
                   15359: =cut
                   15360: 
1.144     matthew  15361: ######################################################
                   15362: ######################################################
1.31      albertel 15363: sub upfile_select_html {
1.144     matthew  15364:     my %Types = (
                   15365:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 15366:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  15367:                  space => &mt('Space separated'),
                   15368:                  tab   => &mt('Tabulator separated'),
                   15369: #                 xml   => &mt('HTML/XML'),
                   15370:                  );
                   15371:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  15372:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  15373:     foreach my $type (sort(keys(%Types))) {
                   15374:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   15375:     }
                   15376:     $Str .= "</select>\n";
                   15377:     return $Str;
1.31      albertel 15378: }
                   15379: 
1.301     albertel 15380: sub get_samples {
                   15381:     my ($records,$toget) = @_;
                   15382:     my @samples=({});
                   15383:     my $got=0;
                   15384:     foreach my $rec (@$records) {
                   15385: 	my %temp = &record_sep($rec);
                   15386: 	if (! grep(/\S/, values(%temp))) { next; }
                   15387: 	if (%temp) {
                   15388: 	    $samples[$got]=\%temp;
                   15389: 	    $got++;
                   15390: 	    if ($got == $toget) { last; }
                   15391: 	}
                   15392:     }
                   15393:     return \@samples;
                   15394: }
                   15395: 
1.144     matthew  15396: ######################################################
                   15397: ######################################################
                   15398: 
1.56      matthew  15399: =pod
                   15400: 
1.648     raeburn  15401: =item * &csv_print_samples($r,$records)
1.41      ng       15402: 
                   15403: Prints a table of sample values from each column uploaded $r is an
                   15404: Apache Request ref, $records is an arrayref from
                   15405: &Apache::loncommon::upfile_record_sep
                   15406: 
                   15407: =cut
                   15408: 
1.144     matthew  15409: ######################################################
                   15410: ######################################################
1.31      albertel 15411: sub csv_print_samples {
                   15412:     my ($r,$records) = @_;
1.662     bisitz   15413:     my $samples = &get_samples($records,5);
1.301     albertel 15414: 
1.594     raeburn  15415:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   15416:               &start_data_table_header_row());
1.356     albertel 15417:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   15418:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  15419:     $r->print(&end_data_table_header_row());
1.301     albertel 15420:     foreach my $hash (@$samples) {
1.594     raeburn  15421: 	$r->print(&start_data_table_row());
1.356     albertel 15422: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 15423: 	    $r->print('<td>');
1.356     albertel 15424: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 15425: 	    $r->print('</td>');
                   15426: 	}
1.594     raeburn  15427: 	$r->print(&end_data_table_row());
1.31      albertel 15428:     }
1.594     raeburn  15429:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 15430: }
                   15431: 
1.144     matthew  15432: ######################################################
                   15433: ######################################################
                   15434: 
1.56      matthew  15435: =pod
                   15436: 
1.648     raeburn  15437: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       15438: 
                   15439: Prints a table to create associations between values and table columns.
1.144     matthew  15440: 
1.41      ng       15441: $r is an Apache Request ref,
                   15442: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  15443: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       15444: 
                   15445: =cut
                   15446: 
1.144     matthew  15447: ######################################################
                   15448: ######################################################
1.31      albertel 15449: sub csv_print_select_table {
                   15450:     my ($r,$records,$d) = @_;
1.301     albertel 15451:     my $i=0;
                   15452:     my $samples = &get_samples($records,1);
1.144     matthew  15453:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  15454: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  15455:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  15456:               '<th>'.&mt('Column').'</th>'.
                   15457:               &end_data_table_header_row()."\n");
1.356     albertel 15458:     foreach my $array_ref (@$d) {
                   15459: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  15460: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 15461: 
1.875     bisitz   15462: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  15463: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 15464: 	$r->print('<option value="none"></option>');
1.356     albertel 15465: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   15466: 	    $r->print('<option value="'.$sample.'"'.
                   15467:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   15468:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 15469: 	}
1.594     raeburn  15470: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 15471: 	$i++;
                   15472:     }
1.594     raeburn  15473:     $r->print(&end_data_table());
1.31      albertel 15474:     $i--;
                   15475:     return $i;
                   15476: }
1.56      matthew  15477: 
1.144     matthew  15478: ######################################################
                   15479: ######################################################
                   15480: 
1.56      matthew  15481: =pod
1.31      albertel 15482: 
1.648     raeburn  15483: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       15484: 
                   15485: Prints a table of sample values from the upload and can make associate samples to internal names.
                   15486: 
                   15487: $r is an Apache Request ref,
                   15488: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   15489: $d is an array of 2 element arrays (internal name, displayed name)
                   15490: 
                   15491: =cut
                   15492: 
1.144     matthew  15493: ######################################################
                   15494: ######################################################
1.31      albertel 15495: sub csv_samples_select_table {
                   15496:     my ($r,$records,$d) = @_;
                   15497:     my $i=0;
1.144     matthew  15498:     #
1.662     bisitz   15499:     my $max_samples = 5;
                   15500:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  15501:     $r->print(&start_data_table().
                   15502:               &start_data_table_header_row().'<th>'.
                   15503:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   15504:               &end_data_table_header_row());
1.301     albertel 15505: 
                   15506:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  15507: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  15508: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 15509: 	foreach my $option (@$d) {
                   15510: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  15511: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 15512:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  15513:                       $display.'</option>');
1.31      albertel 15514: 	}
                   15515: 	$r->print('</select></td><td>');
1.662     bisitz   15516: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 15517: 	    if (defined($samples->[$line]{$key})) { 
                   15518: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   15519: 	    }
                   15520: 	}
1.594     raeburn  15521: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 15522: 	$i++;
                   15523:     }
1.594     raeburn  15524:     $r->print(&end_data_table());
1.31      albertel 15525:     $i--;
                   15526:     return($i);
1.115     matthew  15527: }
                   15528: 
1.144     matthew  15529: ######################################################
                   15530: ######################################################
                   15531: 
1.115     matthew  15532: =pod
                   15533: 
1.648     raeburn  15534: =item * &clean_excel_name($name)
1.115     matthew  15535: 
                   15536: Returns a replacement for $name which does not contain any illegal characters.
                   15537: 
                   15538: =cut
                   15539: 
1.144     matthew  15540: ######################################################
                   15541: ######################################################
1.115     matthew  15542: sub clean_excel_name {
                   15543:     my ($name) = @_;
                   15544:     $name =~ s/[:\*\?\/\\]//g;
                   15545:     if (length($name) > 31) {
                   15546:         $name = substr($name,0,31);
                   15547:     }
                   15548:     return $name;
1.25      albertel 15549: }
1.84      albertel 15550: 
1.85      albertel 15551: =pod
                   15552: 
1.648     raeburn  15553: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 15554: 
                   15555: Returns either 1 or undef
                   15556: 
                   15557: 1 if the part is to be hidden, undef if it is to be shown
                   15558: 
                   15559: Arguments are:
                   15560: 
                   15561: $id the id of the part to be checked
                   15562: $symb, optional the symb of the resource to check
                   15563: $udom, optional the domain of the user to check for
                   15564: $uname, optional the username of the user to check for
                   15565: 
                   15566: =cut
1.84      albertel 15567: 
                   15568: sub check_if_partid_hidden {
                   15569:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 15570:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 15571: 					 $symb,$udom,$uname);
1.141     albertel 15572:     my $truth=1;
                   15573:     #if the string starts with !, then the list is the list to show not hide
                   15574:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 15575:     my @hiddenlist=split(/,/,$hiddenparts);
                   15576:     foreach my $checkid (@hiddenlist) {
1.141     albertel 15577: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 15578:     }
1.141     albertel 15579:     return !$truth;
1.84      albertel 15580: }
1.127     matthew  15581: 
1.138     matthew  15582: 
                   15583: ############################################################
                   15584: ############################################################
                   15585: 
                   15586: =pod
                   15587: 
1.157     matthew  15588: =back 
                   15589: 
1.138     matthew  15590: =head1 cgi-bin script and graphing routines
                   15591: 
1.157     matthew  15592: =over 4
                   15593: 
1.648     raeburn  15594: =item * &get_cgi_id()
1.138     matthew  15595: 
                   15596: Inputs: none
                   15597: 
                   15598: Returns an id which can be used to pass environment variables
                   15599: to various cgi-bin scripts.  These environment variables will
                   15600: be removed from the users environment after a given time by
                   15601: the routine &Apache::lonnet::transfer_profile_to_env.
                   15602: 
                   15603: =cut
                   15604: 
                   15605: ############################################################
                   15606: ############################################################
1.152     albertel 15607: my $uniq=0;
1.136     matthew  15608: sub get_cgi_id {
1.154     albertel 15609:     $uniq=($uniq+1)%100000;
1.280     albertel 15610:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  15611: }
                   15612: 
1.127     matthew  15613: ############################################################
                   15614: ############################################################
                   15615: 
                   15616: =pod
                   15617: 
1.648     raeburn  15618: =item * &DrawBarGraph()
1.127     matthew  15619: 
1.138     matthew  15620: Facilitates the plotting of data in a (stacked) bar graph.
                   15621: Puts plot definition data into the users environment in order for 
                   15622: graph.png to plot it.  Returns an <img> tag for the plot.
                   15623: The bars on the plot are labeled '1','2',...,'n'.
                   15624: 
                   15625: Inputs:
                   15626: 
                   15627: =over 4
                   15628: 
                   15629: =item $Title: string, the title of the plot
                   15630: 
                   15631: =item $xlabel: string, text describing the X-axis of the plot
                   15632: 
                   15633: =item $ylabel: string, text describing the Y-axis of the plot
                   15634: 
                   15635: =item $Max: scalar, the maximum Y value to use in the plot
                   15636: If $Max is < any data point, the graph will not be rendered.
                   15637: 
1.140     matthew  15638: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  15639: they are plotted.  If undefined, default values will be used.
                   15640: 
1.178     matthew  15641: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   15642: 
1.138     matthew  15643: =item @Values: An array of array references.  Each array reference holds data
                   15644: to be plotted in a stacked bar chart.
                   15645: 
1.239     matthew  15646: =item If the final element of @Values is a hash reference the key/value
                   15647: pairs will be added to the graph definition.
                   15648: 
1.138     matthew  15649: =back
                   15650: 
                   15651: Returns:
                   15652: 
                   15653: An <img> tag which references graph.png and the appropriate identifying
                   15654: information for the plot.
                   15655: 
1.127     matthew  15656: =cut
                   15657: 
                   15658: ############################################################
                   15659: ############################################################
1.134     matthew  15660: sub DrawBarGraph {
1.178     matthew  15661:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  15662:     #
                   15663:     if (! defined($colors)) {
                   15664:         $colors = ['#33ff00', 
                   15665:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   15666:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   15667:                   ]; 
                   15668:     }
1.228     matthew  15669:     my $extra_settings = {};
                   15670:     if (ref($Values[-1]) eq 'HASH') {
                   15671:         $extra_settings = pop(@Values);
                   15672:     }
1.127     matthew  15673:     #
1.136     matthew  15674:     my $identifier = &get_cgi_id();
                   15675:     my $id = 'cgi.'.$identifier;        
1.129     matthew  15676:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  15677:         return '';
                   15678:     }
1.225     matthew  15679:     #
                   15680:     my @Labels;
                   15681:     if (defined($labels)) {
                   15682:         @Labels = @$labels;
                   15683:     } else {
                   15684:         for (my $i=0;$i<@{$Values[0]};$i++) {
1.1263    raeburn  15685:             push(@Labels,$i+1);
1.225     matthew  15686:         }
                   15687:     }
                   15688:     #
1.129     matthew  15689:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  15690:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  15691:     my %ValuesHash;
                   15692:     my $NumSets=1;
                   15693:     foreach my $array (@Values) {
                   15694:         next if (! ref($array));
1.136     matthew  15695:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  15696:             join(',',@$array);
1.129     matthew  15697:     }
1.127     matthew  15698:     #
1.136     matthew  15699:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  15700:     if ($NumBars < 3) {
                   15701:         $width = 120+$NumBars*32;
1.220     matthew  15702:         $xskip = 1;
1.225     matthew  15703:         $bar_width = 30;
                   15704:     } elsif ($NumBars < 5) {
                   15705:         $width = 120+$NumBars*20;
                   15706:         $xskip = 1;
                   15707:         $bar_width = 20;
1.220     matthew  15708:     } elsif ($NumBars < 10) {
1.136     matthew  15709:         $width = 120+$NumBars*15;
                   15710:         $xskip = 1;
                   15711:         $bar_width = 15;
                   15712:     } elsif ($NumBars <= 25) {
                   15713:         $width = 120+$NumBars*11;
                   15714:         $xskip = 5;
                   15715:         $bar_width = 8;
                   15716:     } elsif ($NumBars <= 50) {
                   15717:         $width = 120+$NumBars*8;
                   15718:         $xskip = 5;
                   15719:         $bar_width = 4;
                   15720:     } else {
                   15721:         $width = 120+$NumBars*8;
                   15722:         $xskip = 5;
                   15723:         $bar_width = 4;
                   15724:     }
                   15725:     #
1.137     matthew  15726:     $Max = 1 if ($Max < 1);
                   15727:     if ( int($Max) < $Max ) {
                   15728:         $Max++;
                   15729:         $Max = int($Max);
                   15730:     }
1.127     matthew  15731:     $Title  = '' if (! defined($Title));
                   15732:     $xlabel = '' if (! defined($xlabel));
                   15733:     $ylabel = '' if (! defined($ylabel));
1.369     www      15734:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   15735:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   15736:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  15737:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  15738:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   15739:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   15740:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   15741:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   15742:     $ValuesHash{$id.'.height'}   = $height;
                   15743:     $ValuesHash{$id.'.width'}    = $width;
                   15744:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   15745:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   15746:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  15747:     #
1.228     matthew  15748:     # Deal with other parameters
                   15749:     while (my ($key,$value) = each(%$extra_settings)) {
                   15750:         $ValuesHash{$id.'.'.$key} = $value;
                   15751:     }
                   15752:     #
1.646     raeburn  15753:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  15754:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   15755: }
                   15756: 
                   15757: ############################################################
                   15758: ############################################################
                   15759: 
                   15760: =pod
                   15761: 
1.648     raeburn  15762: =item * &DrawXYGraph()
1.137     matthew  15763: 
1.138     matthew  15764: Facilitates the plotting of data in an XY graph.
                   15765: Puts plot definition data into the users environment in order for 
                   15766: graph.png to plot it.  Returns an <img> tag for the plot.
                   15767: 
                   15768: Inputs:
                   15769: 
                   15770: =over 4
                   15771: 
                   15772: =item $Title: string, the title of the plot
                   15773: 
                   15774: =item $xlabel: string, text describing the X-axis of the plot
                   15775: 
                   15776: =item $ylabel: string, text describing the Y-axis of the plot
                   15777: 
                   15778: =item $Max: scalar, the maximum Y value to use in the plot
                   15779: If $Max is < any data point, the graph will not be rendered.
                   15780: 
                   15781: =item $colors: Array ref containing the hex color codes for the data to be 
                   15782: plotted in.  If undefined, default values will be used.
                   15783: 
                   15784: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   15785: 
                   15786: =item $Ydata: Array ref containing Array refs.  
1.185     www      15787: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  15788: 
                   15789: =item %Values: hash indicating or overriding any default values which are 
                   15790: passed to graph.png.  
                   15791: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   15792: 
                   15793: =back
                   15794: 
                   15795: Returns:
                   15796: 
                   15797: An <img> tag which references graph.png and the appropriate identifying
                   15798: information for the plot.
                   15799: 
1.137     matthew  15800: =cut
                   15801: 
                   15802: ############################################################
                   15803: ############################################################
                   15804: sub DrawXYGraph {
                   15805:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   15806:     #
                   15807:     # Create the identifier for the graph
                   15808:     my $identifier = &get_cgi_id();
                   15809:     my $id = 'cgi.'.$identifier;
                   15810:     #
                   15811:     $Title  = '' if (! defined($Title));
                   15812:     $xlabel = '' if (! defined($xlabel));
                   15813:     $ylabel = '' if (! defined($ylabel));
                   15814:     my %ValuesHash = 
                   15815:         (
1.369     www      15816:          $id.'.title'  => &escape($Title),
                   15817:          $id.'.xlabel' => &escape($xlabel),
                   15818:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  15819:          $id.'.y_max_value'=> $Max,
                   15820:          $id.'.labels'     => join(',',@$Xlabels),
                   15821:          $id.'.PlotType'   => 'XY',
                   15822:          );
                   15823:     #
                   15824:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   15825:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   15826:     }
                   15827:     #
                   15828:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   15829:         return '';
                   15830:     }
                   15831:     my $NumSets=1;
1.138     matthew  15832:     foreach my $array (@{$Ydata}){
1.137     matthew  15833:         next if (! ref($array));
                   15834:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   15835:     }
1.138     matthew  15836:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  15837:     #
                   15838:     # Deal with other parameters
                   15839:     while (my ($key,$value) = each(%Values)) {
                   15840:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  15841:     }
                   15842:     #
1.646     raeburn  15843:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  15844:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   15845: }
                   15846: 
                   15847: ############################################################
                   15848: ############################################################
                   15849: 
                   15850: =pod
                   15851: 
1.648     raeburn  15852: =item * &DrawXYYGraph()
1.138     matthew  15853: 
                   15854: Facilitates the plotting of data in an XY graph with two Y axes.
                   15855: Puts plot definition data into the users environment in order for 
                   15856: graph.png to plot it.  Returns an <img> tag for the plot.
                   15857: 
                   15858: Inputs:
                   15859: 
                   15860: =over 4
                   15861: 
                   15862: =item $Title: string, the title of the plot
                   15863: 
                   15864: =item $xlabel: string, text describing the X-axis of the plot
                   15865: 
                   15866: =item $ylabel: string, text describing the Y-axis of the plot
                   15867: 
                   15868: =item $colors: Array ref containing the hex color codes for the data to be 
                   15869: plotted in.  If undefined, default values will be used.
                   15870: 
                   15871: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   15872: 
                   15873: =item $Ydata1: The first data set
                   15874: 
                   15875: =item $Min1: The minimum value of the left Y-axis
                   15876: 
                   15877: =item $Max1: The maximum value of the left Y-axis
                   15878: 
                   15879: =item $Ydata2: The second data set
                   15880: 
                   15881: =item $Min2: The minimum value of the right Y-axis
                   15882: 
                   15883: =item $Max2: The maximum value of the left Y-axis
                   15884: 
                   15885: =item %Values: hash indicating or overriding any default values which are 
                   15886: passed to graph.png.  
                   15887: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   15888: 
                   15889: =back
                   15890: 
                   15891: Returns:
                   15892: 
                   15893: An <img> tag which references graph.png and the appropriate identifying
                   15894: information for the plot.
1.136     matthew  15895: 
                   15896: =cut
                   15897: 
                   15898: ############################################################
                   15899: ############################################################
1.137     matthew  15900: sub DrawXYYGraph {
                   15901:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   15902:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  15903:     #
                   15904:     # Create the identifier for the graph
                   15905:     my $identifier = &get_cgi_id();
                   15906:     my $id = 'cgi.'.$identifier;
                   15907:     #
                   15908:     $Title  = '' if (! defined($Title));
                   15909:     $xlabel = '' if (! defined($xlabel));
                   15910:     $ylabel = '' if (! defined($ylabel));
                   15911:     my %ValuesHash = 
                   15912:         (
1.369     www      15913:          $id.'.title'  => &escape($Title),
                   15914:          $id.'.xlabel' => &escape($xlabel),
                   15915:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  15916:          $id.'.labels' => join(',',@$Xlabels),
                   15917:          $id.'.PlotType' => 'XY',
                   15918:          $id.'.NumSets' => 2,
1.137     matthew  15919:          $id.'.two_axes' => 1,
                   15920:          $id.'.y1_max_value' => $Max1,
                   15921:          $id.'.y1_min_value' => $Min1,
                   15922:          $id.'.y2_max_value' => $Max2,
                   15923:          $id.'.y2_min_value' => $Min2,
1.136     matthew  15924:          );
                   15925:     #
1.137     matthew  15926:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   15927:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   15928:     }
                   15929:     #
                   15930:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   15931:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  15932:         return '';
                   15933:     }
                   15934:     my $NumSets=1;
1.137     matthew  15935:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  15936:         next if (! ref($array));
                   15937:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  15938:     }
                   15939:     #
                   15940:     # Deal with other parameters
                   15941:     while (my ($key,$value) = each(%Values)) {
                   15942:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  15943:     }
                   15944:     #
1.646     raeburn  15945:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 15946:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  15947: }
                   15948: 
                   15949: ############################################################
                   15950: ############################################################
                   15951: 
                   15952: =pod
                   15953: 
1.157     matthew  15954: =back 
                   15955: 
1.139     matthew  15956: =head1 Statistics helper routines?  
                   15957: 
                   15958: Bad place for them but what the hell.
                   15959: 
1.157     matthew  15960: =over 4
                   15961: 
1.648     raeburn  15962: =item * &chartlink()
1.139     matthew  15963: 
                   15964: Returns a link to the chart for a specific student.  
                   15965: 
                   15966: Inputs:
                   15967: 
                   15968: =over 4
                   15969: 
                   15970: =item $linktext: The text of the link
                   15971: 
                   15972: =item $sname: The students username
                   15973: 
                   15974: =item $sdomain: The students domain
                   15975: 
                   15976: =back
                   15977: 
1.157     matthew  15978: =back
                   15979: 
1.139     matthew  15980: =cut
                   15981: 
                   15982: ############################################################
                   15983: ############################################################
                   15984: sub chartlink {
                   15985:     my ($linktext, $sname, $sdomain) = @_;
                   15986:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      15987:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 15988:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  15989:        '">'.$linktext.'</a>';
1.153     matthew  15990: }
                   15991: 
                   15992: #######################################################
                   15993: #######################################################
                   15994: 
                   15995: =pod
                   15996: 
                   15997: =head1 Course Environment Routines
1.157     matthew  15998: 
                   15999: =over 4
1.153     matthew  16000: 
1.648     raeburn  16001: =item * &restore_course_settings()
1.153     matthew  16002: 
1.648     raeburn  16003: =item * &store_course_settings()
1.153     matthew  16004: 
                   16005: Restores/Store indicated form parameters from the course environment.
                   16006: Will not overwrite existing values of the form parameters.
                   16007: 
                   16008: Inputs: 
                   16009: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   16010: 
                   16011: a hash ref describing the data to be stored.  For example:
                   16012:    
                   16013: %Save_Parameters = ('Status' => 'scalar',
                   16014:     'chartoutputmode' => 'scalar',
                   16015:     'chartoutputdata' => 'scalar',
                   16016:     'Section' => 'array',
1.373     raeburn  16017:     'Group' => 'array',
1.153     matthew  16018:     'StudentData' => 'array',
                   16019:     'Maps' => 'array');
                   16020: 
                   16021: Returns: both routines return nothing
                   16022: 
1.631     raeburn  16023: =back
                   16024: 
1.153     matthew  16025: =cut
                   16026: 
                   16027: #######################################################
                   16028: #######################################################
                   16029: sub store_course_settings {
1.496     albertel 16030:     return &store_settings($env{'request.course.id'},@_);
                   16031: }
                   16032: 
                   16033: sub store_settings {
1.153     matthew  16034:     # save to the environment
                   16035:     # appenv the same items, just to be safe
1.300     albertel 16036:     my $udom  = $env{'user.domain'};
                   16037:     my $uname = $env{'user.name'};
1.496     albertel 16038:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  16039:     my %SaveHash;
                   16040:     my %AppHash;
                   16041:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 16042:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 16043:         my $envname = 'environment.'.$basename;
1.258     albertel 16044:         if (exists($env{'form.'.$setting})) {
1.153     matthew  16045:             # Save this value away
                   16046:             if ($type eq 'scalar' &&
1.258     albertel 16047:                 (! exists($env{$envname}) || 
                   16048:                  $env{$envname} ne $env{'form.'.$setting})) {
                   16049:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   16050:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  16051:             } elsif ($type eq 'array') {
                   16052:                 my $stored_form;
1.258     albertel 16053:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  16054:                     $stored_form = join(',',
                   16055:                                         map {
1.369     www      16056:                                             &escape($_);
1.258     albertel 16057:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  16058:                 } else {
                   16059:                     $stored_form = 
1.369     www      16060:                         &escape($env{'form.'.$setting});
1.153     matthew  16061:                 }
                   16062:                 # Determine if the array contents are the same.
1.258     albertel 16063:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  16064:                     $SaveHash{$basename} = $stored_form;
                   16065:                     $AppHash{$envname}   = $stored_form;
                   16066:                 }
                   16067:             }
                   16068:         }
                   16069:     }
                   16070:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 16071:                                           $udom,$uname);
1.153     matthew  16072:     if ($put_result !~ /^(ok|delayed)/) {
                   16073:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   16074:                                  'got error:'.$put_result);
                   16075:     }
                   16076:     # Make sure these settings stick around in this session, too
1.646     raeburn  16077:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  16078:     return;
                   16079: }
                   16080: 
                   16081: sub restore_course_settings {
1.499     albertel 16082:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 16083: }
                   16084: 
                   16085: sub restore_settings {
                   16086:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  16087:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 16088:         next if (exists($env{'form.'.$setting}));
1.496     albertel 16089:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  16090:             '.'.$setting;
1.258     albertel 16091:         if (exists($env{$envname})) {
1.153     matthew  16092:             if ($type eq 'scalar') {
1.258     albertel 16093:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  16094:             } elsif ($type eq 'array') {
1.258     albertel 16095:                 $env{'form.'.$setting} = [ 
1.153     matthew  16096:                                            map { 
1.369     www      16097:                                                &unescape($_); 
1.258     albertel 16098:                                            } split(',',$env{$envname})
1.153     matthew  16099:                                            ];
                   16100:             }
                   16101:         }
                   16102:     }
1.127     matthew  16103: }
                   16104: 
1.618     raeburn  16105: #######################################################
                   16106: #######################################################
                   16107: 
                   16108: =pod
                   16109: 
                   16110: =head1 Domain E-mail Routines  
                   16111: 
                   16112: =over 4
                   16113: 
1.648     raeburn  16114: =item * &build_recipient_list()
1.618     raeburn  16115: 
1.1144    raeburn  16116: Build recipient lists for following types of e-mail:
1.766     raeburn  16117: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.1144    raeburn  16118: (d) Help requests, (e) Course requests needing approval, (f) loncapa
                   16119: module change checking, student/employee ID conflict checks, as
                   16120: generated by lonerrorhandler.pm, CHECKRPMS, loncron,
                   16121: lonsupportreq.pm, loncoursequeueadmin.pm, searchcat.pl respectively.
1.618     raeburn  16122: 
                   16123: Inputs:
1.619     raeburn  16124: defmail (scalar - email address of default recipient), 
1.1144    raeburn  16125: mailing type (scalar: errormail, packagesmail, helpdeskmail,
                   16126: requestsmail, updatesmail, or idconflictsmail).
                   16127: 
1.619     raeburn  16128: defdom (domain for which to retrieve configuration settings),
1.1144    raeburn  16129: 
1.619     raeburn  16130: origmail (scalar - email address of recipient from loncapa.conf, 
1.1297    raeburn  16131: i.e., predates configuration by DC via domainprefs.pm
                   16132: 
                   16133: $requname username of requester (if mailing type is helpdeskmail)
                   16134: 
                   16135: $requdom domain of requester (if mailing type is helpdeskmail)
                   16136: 
                   16137: $reqemail e-mail address of requester (if mailing type is helpdeskmail)
                   16138: 
1.618     raeburn  16139: 
1.655     raeburn  16140: Returns: comma separated list of addresses to which to send e-mail.
                   16141: 
                   16142: =back
1.618     raeburn  16143: 
                   16144: =cut
                   16145: 
                   16146: ############################################################
                   16147: ############################################################
                   16148: sub build_recipient_list {
1.1297    raeburn  16149:     my ($defmail,$mailing,$defdom,$origmail,$requname,$requdom,$reqemail) = @_;
1.618     raeburn  16150:     my @recipients;
1.1270    raeburn  16151:     my ($otheremails,$lastresort,$allbcc,$addtext);
1.618     raeburn  16152:     my %domconfig =
1.1270    raeburn  16153:         &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
1.618     raeburn  16154:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  16155:         if (exists($domconfig{'contacts'}{$mailing})) {
                   16156:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   16157:                 my @contacts = ('adminemail','supportemail');
                   16158:                 foreach my $item (@contacts) {
                   16159:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   16160:                         my $addr = $domconfig{'contacts'}{$item}; 
                   16161:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16162:                             push(@recipients,$addr);
                   16163:                         }
1.619     raeburn  16164:                     }
1.1270    raeburn  16165:                 }
                   16166:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   16167:                 if ($mailing eq 'helpdeskmail') {
                   16168:                     if ($domconfig{'contacts'}{$mailing}{'bcc'}) {
                   16169:                         my @bccs = split(/,/,$domconfig{'contacts'}{$mailing}{'bcc'});
                   16170:                         my @ok_bccs;
                   16171:                         foreach my $bcc (@bccs) {
                   16172:                             $bcc =~ s/^\s+//g;
                   16173:                             $bcc =~ s/\s+$//g;
                   16174:                             if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   16175:                                 if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   16176:                                     push(@ok_bccs,$bcc);
                   16177:                                 }
                   16178:                             }
                   16179:                         }
                   16180:                         if (@ok_bccs > 0) {
                   16181:                             $allbcc = join(', ',@ok_bccs);
                   16182:                         }
                   16183:                     }
                   16184:                     $addtext = $domconfig{'contacts'}{$mailing}{'include'};
1.618     raeburn  16185:                 }
                   16186:             }
1.766     raeburn  16187:         } elsif ($origmail ne '') {
1.1270    raeburn  16188:             $lastresort = $origmail;
1.618     raeburn  16189:         }
1.1297    raeburn  16190:         if ($mailing eq 'helpdeskmail') {
                   16191:             if ((ref($domconfig{'contacts'}{'overrides'}) eq 'HASH') &&
                   16192:                 (keys(%{$domconfig{'contacts'}{'overrides'}}))) {
                   16193:                 my ($inststatus,$inststatus_checked);
                   16194:                 if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
                   16195:                     ($env{'user.domain'} ne 'public')) {
                   16196:                     $inststatus_checked = 1;
                   16197:                     $inststatus = $env{'environment.inststatus'};
                   16198:                 }
                   16199:                 unless ($inststatus_checked) {
                   16200:                     if (($requname ne '') && ($requdom ne '')) {
                   16201:                         if (($requname =~ /^$match_username$/) &&
                   16202:                             ($requdom =~ /^$match_domain$/) &&
                   16203:                             (&Apache::lonnet::domain($requdom))) {
                   16204:                             my $requhome = &Apache::lonnet::homeserver($requname,
                   16205:                                                                       $requdom);
                   16206:                             unless ($requhome eq 'no_host') {
                   16207:                                 my %userenv = &Apache::lonnet::userenvironment($requdom,$requname,'inststatus');
                   16208:                                 $inststatus = $userenv{'inststatus'};
                   16209:                                 $inststatus_checked = 1;
                   16210:                             }
                   16211:                         }
                   16212:                     }
                   16213:                 }
                   16214:                 unless ($inststatus_checked) {
                   16215:                     if ($reqemail =~ /^[^\@]+\@[^\@]+$/) {
                   16216:                         my %srch = (srchby     => 'email',
                   16217:                                     srchdomain => $defdom,
                   16218:                                     srchterm   => $reqemail,
                   16219:                                     srchtype   => 'exact');
                   16220:                         my %srch_results = &Apache::lonnet::usersearch(\%srch);
                   16221:                         foreach my $uname (keys(%srch_results)) {
                   16222:                             if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   16223:                                 $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   16224:                                 $inststatus_checked = 1;
                   16225:                                 last;
                   16226:                             }
                   16227:                         }
                   16228:                         unless ($inststatus_checked) {
                   16229:                             my ($dirsrchres,%srch_results) = &Apache::lonnet::inst_directory_query(\%srch);
                   16230:                             if ($dirsrchres eq 'ok') {
                   16231:                                 foreach my $uname (keys(%srch_results)) {
                   16232:                                     if (ref($srch_results{$uname}{'inststatus'}) eq 'ARRAY') {
                   16233:                                         $inststatus = join(',',@{$srch_results{$uname}{'inststatus'}});
                   16234:                                         $inststatus_checked = 1;
                   16235:                                         last;
                   16236:                                     }
                   16237:                                 }
                   16238:                             }
                   16239:                         }
                   16240:                     }
                   16241:                 }
                   16242:                 if ($inststatus ne '') {
                   16243:                     foreach my $status (split(/\:/,$inststatus)) {
                   16244:                         if (ref($domconfig{'contacts'}{'overrides'}{$status}) eq 'HASH') {
                   16245:                             my @contacts = ('adminemail','supportemail');
                   16246:                             foreach my $item (@contacts) {
                   16247:                                 if ($domconfig{'contacts'}{'overrides'}{$status}{$item}) {
                   16248:                                     my $addr = $domconfig{'contacts'}{'overrides'}{$status};
                   16249:                                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16250:                                         push(@recipients,$addr);
                   16251:                                     }
                   16252:                                 }
                   16253:                             }
                   16254:                             $otheremails = $domconfig{'contacts'}{'overrides'}{$status}{'others'};
                   16255:                             if ($domconfig{'contacts'}{'overrides'}{$status}{'bcc'}) {
                   16256:                                 my @bccs = split(/,/,$domconfig{'contacts'}{'overrides'}{$status}{'bcc'});
                   16257:                                 my @ok_bccs;
                   16258:                                 foreach my $bcc (@bccs) {
                   16259:                                     $bcc =~ s/^\s+//g;
                   16260:                                     $bcc =~ s/\s+$//g;
                   16261:                                     if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   16262:                                         if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   16263:                                             push(@ok_bccs,$bcc);
                   16264:                                         }
                   16265:                                     }
                   16266:                                 }
                   16267:                                 if (@ok_bccs > 0) {
                   16268:                                     $allbcc = join(', ',@ok_bccs);
                   16269:                                 }
                   16270:                             }
                   16271:                             $addtext = $domconfig{'contacts'}{'overrides'}{$status}{'include'};
                   16272:                             last;
                   16273:                         }
                   16274:                     }
                   16275:                 }
                   16276:             }
                   16277:         }
1.619     raeburn  16278:     } elsif ($origmail ne '') {
1.1270    raeburn  16279:         $lastresort = $origmail;
                   16280:     }
1.1297    raeburn  16281:     if (($mailing eq 'helpdeskmail') && ($lastresort ne '')) {
1.1270    raeburn  16282:         unless (grep(/^\Q$defdom\E$/,&Apache::lonnet::current_machine_domains())) {
                   16283:             my $lonhost = $Apache::lonnet::perlvar{'lonHostID'};
                   16284:             my $machinedom = $Apache::lonnet::perlvar{'lonDefDomain'};
                   16285:             my %what = (
                   16286:                           perlvar => 1,
                   16287:                        );
                   16288:             my $primary = &Apache::lonnet::domain($defdom,'primary');
                   16289:             if ($primary) {
                   16290:                 my $gotaddr;
                   16291:                 my ($result,$returnhash) =
                   16292:                     &Apache::lonnet::get_remote_globals($primary,{ perlvar => 1 });
                   16293:                 if (($result eq 'ok') && (ref($returnhash) eq 'HASH')) {
                   16294:                     if ($returnhash->{'lonSupportEMail'} =~ /^[^\@]+\@[^\@]+$/) {
                   16295:                         $lastresort = $returnhash->{'lonSupportEMail'};
                   16296:                         $gotaddr = 1;
                   16297:                     }
                   16298:                 }
                   16299:                 unless ($gotaddr) {
                   16300:                     my $uintdom = &Apache::lonnet::internet_dom($primary);
                   16301:                     my $intdom = &Apache::lonnet::internet_dom($lonhost);
                   16302:                     unless ($uintdom eq $intdom) {
                   16303:                         my %domconfig =
                   16304:                             &Apache::lonnet::get_dom('configuration',['contacts'],$machinedom);
                   16305:                         if (ref($domconfig{'contacts'}) eq 'HASH') {
                   16306:                             if (ref($domconfig{'contacts'}{'otherdomsmail'}) eq 'HASH') {
                   16307:                                 my @contacts = ('adminemail','supportemail');
                   16308:                                 foreach my $item (@contacts) {
                   16309:                                     if ($domconfig{'contacts'}{'otherdomsmail'}{$item}) {
                   16310:                                         my $addr = $domconfig{'contacts'}{$item};
                   16311:                                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16312:                                             push(@recipients,$addr);
                   16313:                                         }
                   16314:                                     }
                   16315:                                 }
                   16316:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'others'}) {
                   16317:                                     $otheremails = $domconfig{'contacts'}{'otherdomsmail'}{'others'};
                   16318:                                 }
                   16319:                                 if ($domconfig{'contacts'}{'otherdomsmail'}{'bcc'}) {
                   16320:                                     my @bccs = split(/,/,$domconfig{'contacts'}{'otherdomsmail'}{'bcc'});
                   16321:                                     my @ok_bccs;
                   16322:                                     foreach my $bcc (@bccs) {
                   16323:                                         $bcc =~ s/^\s+//g;
                   16324:                                         $bcc =~ s/\s+$//g;
                   16325:                                         if ($bcc =~ m/^[^\@]+\@[^\@]+$/) {
                   16326:                                             if (!(grep(/^\Q$bcc\E$/,@ok_bccs))) {
                   16327:                                                 push(@ok_bccs,$bcc);
                   16328:                                             }
                   16329:                                         }
                   16330:                                     }
                   16331:                                     if (@ok_bccs > 0) {
                   16332:                                         $allbcc = join(', ',@ok_bccs);
                   16333:                                     }
                   16334:                                 }
                   16335:                                 $addtext = $domconfig{'contacts'}{'otherdomsmail'}{'include'};
                   16336:                             }
                   16337:                         }
                   16338:                     }
                   16339:                 }
                   16340:             }
                   16341:         }
1.618     raeburn  16342:     }
1.688     raeburn  16343:     if (defined($defmail)) {
                   16344:         if ($defmail ne '') {
                   16345:             push(@recipients,$defmail);
                   16346:         }
1.618     raeburn  16347:     }
                   16348:     if ($otheremails) {
1.619     raeburn  16349:         my @others;
                   16350:         if ($otheremails =~ /,/) {
                   16351:             @others = split(/,/,$otheremails);
1.618     raeburn  16352:         } else {
1.619     raeburn  16353:             push(@others,$otheremails);
                   16354:         }
                   16355:         foreach my $addr (@others) {
                   16356:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   16357:                 push(@recipients,$addr);
                   16358:             }
1.618     raeburn  16359:         }
                   16360:     }
1.1298    raeburn  16361:     if ($mailing eq 'helpdeskmail') {
1.1270    raeburn  16362:         if ((!@recipients) && ($lastresort ne '')) {
                   16363:             push(@recipients,$lastresort);
                   16364:         }
                   16365:     } elsif ($lastresort ne '') {
                   16366:         if (!grep(/^\Q$lastresort\E$/,@recipients)) {
                   16367:             push(@recipients,$lastresort);
                   16368:         }
                   16369:     }
1.1271    raeburn  16370:     my $recipientlist = join(',',@recipients);
1.1270    raeburn  16371:     if (wantarray) {
                   16372:         return ($recipientlist,$allbcc,$addtext);
                   16373:     } else {
                   16374:         return $recipientlist;
                   16375:     }
1.618     raeburn  16376: }
                   16377: 
1.127     matthew  16378: ############################################################
                   16379: ############################################################
1.154     albertel 16380: 
1.655     raeburn  16381: =pod
                   16382: 
1.1224    musolffc 16383: =over 4
                   16384: 
1.1223    musolffc 16385: =item * &mime_email()
                   16386: 
                   16387: Sends an email with a possible attachment
                   16388: 
                   16389: Inputs:
                   16390: 
                   16391: =over 4
                   16392: 
                   16393: from -              Sender's email address
                   16394: 
1.1343    raeburn  16395: replyto -           Reply-To email address
                   16396: 
1.1223    musolffc 16397: to -                Email address of recipient
                   16398: 
                   16399: subject -           Subject of email
                   16400: 
                   16401: body -              Body of email
                   16402: 
                   16403: cc_string -         Carbon copy email address
                   16404: 
                   16405: bcc -               Blind carbon copy email address
                   16406: 
                   16407: attachment_path -   Path of file to be attached
                   16408: 
                   16409: file_name -         Name of file to be attached
                   16410: 
                   16411: attachment_text -   The body of an attachment of type "TEXT"
                   16412: 
                   16413: =back
                   16414: 
                   16415: =back
                   16416: 
                   16417: =cut
                   16418: 
                   16419: ############################################################
                   16420: ############################################################
                   16421: 
                   16422: sub mime_email {
1.1343    raeburn  16423:     my ($from,$replyto,$to,$subject,$body,$cc_string,$bcc,$attachment_path, 
                   16424:         $file_name,$attachment_text) = @_;
                   16425:  
1.1223    musolffc 16426:     my $msg = MIME::Lite->new(
                   16427:              From    => $from,
                   16428:              To      => $to,
                   16429:              Subject => $subject,
                   16430:              Type    =>'TEXT',
                   16431:              Data    => $body,
                   16432:              );
1.1343    raeburn  16433:     if ($replyto ne '') {
                   16434:         $msg->add("Reply-To" => $replyto);
                   16435:     }
1.1223    musolffc 16436:     if ($cc_string ne '') {
                   16437:         $msg->add("Cc" => $cc_string);
                   16438:     }
                   16439:     if ($bcc ne '') {
                   16440:         $msg->add("Bcc" => $bcc);
                   16441:     }
                   16442:     $msg->attr("content-type"         => "text/plain");
                   16443:     $msg->attr("content-type.charset" => "UTF-8");
                   16444:     # Attach file if given
                   16445:     if ($attachment_path) {
                   16446:         unless ($file_name) {
                   16447:             if ($attachment_path =~ m-/([^/]+)$-) { $file_name = $1; }
                   16448:         }
                   16449:         my ($type, $encoding) = MIME::Types::by_suffix($attachment_path);
                   16450:         $msg->attach(Type     => $type,
                   16451:                      Path     => $attachment_path,
                   16452:                      Filename => $file_name
                   16453:                      );
                   16454:     # Otherwise attach text if given
                   16455:     } elsif ($attachment_text) {
                   16456:         $msg->attach(Type => 'TEXT',
                   16457:                      Data => $attachment_text);
                   16458:     }
                   16459:     # Send it
                   16460:     $msg->send('sendmail');
                   16461: }
                   16462: 
                   16463: ############################################################
                   16464: ############################################################
                   16465: 
                   16466: =pod
                   16467: 
1.655     raeburn  16468: =head1 Course Catalog Routines
                   16469: 
                   16470: =over 4
                   16471: 
                   16472: =item * &gather_categories()
                   16473: 
                   16474: Converts category definitions - keys of categories hash stored in  
                   16475: coursecategories in configuration.db on the primary library server in a 
                   16476: domain - to an array.  Also generates javascript and idx hash used to 
                   16477: generate Domain Coordinator interface for editing Course Categories.
                   16478: 
                   16479: Inputs:
1.663     raeburn  16480: 
1.655     raeburn  16481: categories (reference to hash of category definitions).
1.663     raeburn  16482: 
1.655     raeburn  16483: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   16484:       categories and subcategories).
1.663     raeburn  16485: 
1.655     raeburn  16486: idx (reference to hash of counters used in Domain Coordinator interface for 
                   16487:       editing Course Categories).
1.663     raeburn  16488: 
1.655     raeburn  16489: jsarray (reference to array of categories used to create Javascript arrays for
                   16490:          Domain Coordinator interface for editing Course Categories).
                   16491: 
                   16492: Returns: nothing
                   16493: 
                   16494: Side effects: populates cats, idx and jsarray. 
                   16495: 
                   16496: =cut
                   16497: 
                   16498: sub gather_categories {
                   16499:     my ($categories,$cats,$idx,$jsarray) = @_;
                   16500:     my %counters;
                   16501:     my $num = 0;
                   16502:     foreach my $item (keys(%{$categories})) {
                   16503:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   16504:         if ($container eq '' && $depth == 0) {
                   16505:             $cats->[$depth][$categories->{$item}] = $cat;
                   16506:         } else {
                   16507:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   16508:         }
                   16509:         my ($escitem,$tail) = split(/:/,$item,2);
                   16510:         if ($counters{$tail} eq '') {
                   16511:             $counters{$tail} = $num;
                   16512:             $num ++;
                   16513:         }
                   16514:         if (ref($idx) eq 'HASH') {
                   16515:             $idx->{$item} = $counters{$tail};
                   16516:         }
                   16517:         if (ref($jsarray) eq 'ARRAY') {
                   16518:             push(@{$jsarray->[$counters{$tail}]},$item);
                   16519:         }
                   16520:     }
                   16521:     return;
                   16522: }
                   16523: 
                   16524: =pod
                   16525: 
                   16526: =item * &extract_categories()
                   16527: 
                   16528: Used to generate breadcrumb trails for course categories.
                   16529: 
                   16530: Inputs:
1.663     raeburn  16531: 
1.655     raeburn  16532: categories (reference to hash of category definitions).
1.663     raeburn  16533: 
1.655     raeburn  16534: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   16535:       categories and subcategories).
1.663     raeburn  16536: 
1.655     raeburn  16537: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  16538: 
1.655     raeburn  16539: allitems (reference to hash - key is category key 
                   16540:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  16541: 
1.655     raeburn  16542: idx (reference to hash of counters used in Domain Coordinator interface for
                   16543:       editing Course Categories).
1.663     raeburn  16544: 
1.655     raeburn  16545: jsarray (reference to array of categories used to create Javascript arrays for
                   16546:          Domain Coordinator interface for editing Course Categories).
                   16547: 
1.665     raeburn  16548: subcats (reference to hash of arrays containing all subcategories within each 
                   16549:          category, -recursive)
                   16550: 
1.1321    raeburn  16551: maxd (reference to hash used to hold max depth for all top-level categories).
                   16552: 
1.655     raeburn  16553: Returns: nothing
                   16554: 
                   16555: Side effects: populates trails and allitems hash references.
                   16556: 
                   16557: =cut
                   16558: 
                   16559: sub extract_categories {
1.1321    raeburn  16560:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats,$maxd) = @_;
1.655     raeburn  16561:     if (ref($categories) eq 'HASH') {
                   16562:         &gather_categories($categories,$cats,$idx,$jsarray);
                   16563:         if (ref($cats->[0]) eq 'ARRAY') {
                   16564:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   16565:                 my $name = $cats->[0][$i];
                   16566:                 my $item = &escape($name).'::0';
                   16567:                 my $trailstr;
                   16568:                 if ($name eq 'instcode') {
                   16569:                     $trailstr = &mt('Official courses (with institutional codes)');
1.919     raeburn  16570:                 } elsif ($name eq 'communities') {
                   16571:                     $trailstr = &mt('Communities');
1.1239    raeburn  16572:                 } elsif ($name eq 'placement') {
                   16573:                     $trailstr = &mt('Placement Tests');
1.655     raeburn  16574:                 } else {
                   16575:                     $trailstr = $name;
                   16576:                 }
                   16577:                 if ($allitems->{$item} eq '') {
                   16578:                     push(@{$trails},$trailstr);
                   16579:                     $allitems->{$item} = scalar(@{$trails})-1;
                   16580:                 }
                   16581:                 my @parents = ($name);
                   16582:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   16583:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   16584:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  16585:                         if (ref($subcats) eq 'HASH') {
                   16586:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   16587:                         }
1.1321    raeburn  16588:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats,$maxd);
1.665     raeburn  16589:                     }
                   16590:                 } else {
                   16591:                     if (ref($subcats) eq 'HASH') {
                   16592:                         $subcats->{$item} = [];
1.655     raeburn  16593:                     }
1.1321    raeburn  16594:                     if (ref($maxd) eq 'HASH') {
                   16595:                         $maxd->{$name} = 1;
                   16596:                     }
1.655     raeburn  16597:                 }
                   16598:             }
                   16599:         }
                   16600:     }
                   16601:     return;
                   16602: }
                   16603: 
                   16604: =pod
                   16605: 
1.1162    raeburn  16606: =item * &recurse_categories()
1.655     raeburn  16607: 
                   16608: Recursively used to generate breadcrumb trails for course categories.
                   16609: 
                   16610: Inputs:
1.663     raeburn  16611: 
1.655     raeburn  16612: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   16613:       categories and subcategories).
1.663     raeburn  16614: 
1.655     raeburn  16615: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  16616: 
                   16617: category (current course category, for which breadcrumb trail is being generated).
                   16618: 
                   16619: trails (reference to array of breadcrumb trails for each category).
                   16620: 
1.655     raeburn  16621: allitems (reference to hash - key is category key
                   16622:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  16623: 
1.655     raeburn  16624: parents (array containing containers directories for current category, 
                   16625:          back to top level). 
                   16626: 
                   16627: Returns: nothing
                   16628: 
                   16629: Side effects: populates trails and allitems hash references
                   16630: 
                   16631: =cut
                   16632: 
                   16633: sub recurse_categories {
1.1321    raeburn  16634:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats,$maxd) = @_;
1.655     raeburn  16635:     my $shallower = $depth - 1;
                   16636:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   16637:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   16638:             my $name = $cats->[$depth]{$category}[$k];
                   16639:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321    raeburn  16640:             my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  16641:             if ($allitems->{$item} eq '') {
                   16642:                 push(@{$trails},$trailstr);
                   16643:                 $allitems->{$item} = scalar(@{$trails})-1;
                   16644:             }
                   16645:             my $deeper = $depth+1;
                   16646:             push(@{$parents},$category);
1.665     raeburn  16647:             if (ref($subcats) eq 'HASH') {
                   16648:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   16649:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   16650:                     my $higher;
                   16651:                     if ($j > 0) {
                   16652:                         $higher = &escape($parents->[$j]).':'.
                   16653:                                   &escape($parents->[$j-1]).':'.$j;
                   16654:                     } else {
                   16655:                         $higher = &escape($parents->[$j]).'::'.$j;
                   16656:                     }
                   16657:                     push(@{$subcats->{$higher}},$subcat);
                   16658:                 }
                   16659:             }
                   16660:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
1.1321    raeburn  16661:                                 $subcats,$maxd);
1.655     raeburn  16662:             pop(@{$parents});
                   16663:         }
                   16664:     } else {
                   16665:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
1.1321    raeburn  16666:         my $trailstr = join(' &raquo; ',(@{$parents},$category));
1.655     raeburn  16667:         if ($allitems->{$item} eq '') {
                   16668:             push(@{$trails},$trailstr);
                   16669:             $allitems->{$item} = scalar(@{$trails})-1;
                   16670:         }
1.1321    raeburn  16671:         if (ref($maxd) eq 'HASH') {
                   16672:             if ($depth > $maxd->{$parents->[0]}) {
                   16673:                 $maxd->{$parents->[0]} = $depth;
                   16674:             }
                   16675:         }
1.655     raeburn  16676:     }
                   16677:     return;
                   16678: }
                   16679: 
1.663     raeburn  16680: =pod
                   16681: 
1.1162    raeburn  16682: =item * &assign_categories_table()
1.663     raeburn  16683: 
                   16684: Create a datatable for display of hierarchical categories in a domain,
                   16685: with checkboxes to allow a course to be categorized. 
                   16686: 
                   16687: Inputs:
                   16688: 
                   16689: cathash - reference to hash of categories defined for the domain (from
                   16690:           configuration.db)
                   16691: 
                   16692: currcat - scalar with an & separated list of categories assigned to a course. 
                   16693: 
1.919     raeburn  16694: type    - scalar contains course type (Course or Community).
                   16695: 
1.1260    raeburn  16696: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   16697:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   16698: 
1.663     raeburn  16699: Returns: $output (markup to be displayed) 
                   16700: 
                   16701: =cut
                   16702: 
                   16703: sub assign_categories_table {
1.1259    raeburn  16704:     my ($cathash,$currcat,$type,$disabled) = @_;
1.663     raeburn  16705:     my $output;
                   16706:     if (ref($cathash) eq 'HASH') {
1.1321    raeburn  16707:         my (@cats,@trails,%allitems,%idx,@jsarray,%maxd,@path,$maxdepth);
                   16708:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray,\%maxd);
1.663     raeburn  16709:         $maxdepth = scalar(@cats);
                   16710:         if (@cats > 0) {
                   16711:             my $itemcount = 0;
                   16712:             if (ref($cats[0]) eq 'ARRAY') {
                   16713:                 my @currcategories;
                   16714:                 if ($currcat ne '') {
                   16715:                     @currcategories = split('&',$currcat);
                   16716:                 }
1.919     raeburn  16717:                 my $table;
1.663     raeburn  16718:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   16719:                     my $parent = $cats[0][$i];
1.919     raeburn  16720:                     next if ($parent eq 'instcode');
                   16721:                     if ($type eq 'Community') {
                   16722:                         next unless ($parent eq 'communities');
1.1239    raeburn  16723:                     } elsif ($type eq 'Placement') {
                   16724:                         next unless ($parent eq 'placement');
1.919     raeburn  16725:                     } else {
1.1239    raeburn  16726:                         next if (($parent eq 'communities') || ($parent eq 'placement'));
1.919     raeburn  16727:                     }
1.663     raeburn  16728:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   16729:                     my $item = &escape($parent).'::0';
                   16730:                     my $checked = '';
                   16731:                     if (@currcategories > 0) {
                   16732:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   16733:                             $checked = ' checked="checked"';
1.663     raeburn  16734:                         }
                   16735:                     }
1.919     raeburn  16736:                     my $parent_title = $parent;
                   16737:                     if ($parent eq 'communities') {
                   16738:                         $parent_title = &mt('Communities');
1.1239    raeburn  16739:                     } elsif ($parent eq 'placement') {
                   16740:                         $parent_title = &mt('Placement Tests');
1.919     raeburn  16741:                     }
                   16742:                     $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   16743:                               '<input type="checkbox" name="usecategory" value="'.
1.1259    raeburn  16744:                               $item.'"'.$checked.$disabled.' />'.$parent_title.'</span>'.
1.919     raeburn  16745:                               '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  16746:                     my $depth = 1;
                   16747:                     push(@path,$parent);
1.1259    raeburn  16748:                     $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories,$disabled);
1.663     raeburn  16749:                     pop(@path);
1.919     raeburn  16750:                     $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
1.663     raeburn  16751:                     $itemcount ++;
                   16752:                 }
1.919     raeburn  16753:                 if ($itemcount) {
                   16754:                     $output = &Apache::loncommon::start_data_table().
                   16755:                               $table.
                   16756:                               &Apache::loncommon::end_data_table();
                   16757:                 }
1.663     raeburn  16758:             }
                   16759:         }
                   16760:     }
                   16761:     return $output;
                   16762: }
                   16763: 
                   16764: =pod
                   16765: 
1.1162    raeburn  16766: =item * &assign_category_rows()
1.663     raeburn  16767: 
                   16768: Create a datatable row for display of nested categories in a domain,
                   16769: with checkboxes to allow a course to be categorized,called recursively.
                   16770: 
                   16771: Inputs:
                   16772: 
                   16773: itemcount - track row number for alternating colors
                   16774: 
                   16775: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   16776:       categories and subcategories.
                   16777: 
                   16778: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   16779: 
                   16780: parent - parent of current category item
                   16781: 
                   16782: path - Array containing all categories back up through the hierarchy from the
                   16783:        current category to the top level.
                   16784: 
                   16785: currcategories - reference to array of current categories assigned to the course
                   16786: 
1.1260    raeburn  16787: disabled - scalar (optional) contains disabled="disabled" if input elements are
                   16788:            to be readonly (e.g., Domain Helpdesk role viewing course settings).
                   16789: 
1.663     raeburn  16790: Returns: $output (markup to be displayed).
                   16791: 
                   16792: =cut
                   16793: 
                   16794: sub assign_category_rows {
1.1259    raeburn  16795:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories,$disabled) = @_;
1.663     raeburn  16796:     my ($text,$name,$item,$chgstr);
                   16797:     if (ref($cats) eq 'ARRAY') {
                   16798:         my $maxdepth = scalar(@{$cats});
                   16799:         if (ref($cats->[$depth]) eq 'HASH') {
                   16800:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   16801:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   16802:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
1.1145    raeburn  16803:                 $text .= '<td><table class="LC_data_table">';
1.663     raeburn  16804:                 for (my $j=0; $j<$numchildren; $j++) {
                   16805:                     $name = $cats->[$depth]{$parent}[$j];
                   16806:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   16807:                     my $deeper = $depth+1;
                   16808:                     my $checked = '';
                   16809:                     if (ref($currcategories) eq 'ARRAY') {
                   16810:                         if (@{$currcategories} > 0) {
                   16811:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   16812:                                 $checked = ' checked="checked"';
1.663     raeburn  16813:                             }
                   16814:                         }
                   16815:                     }
1.664     raeburn  16816:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   16817:                              '<input type="checkbox" name="usecategory" value="'.
1.1259    raeburn  16818:                              $item.'"'.$checked.$disabled.' />'.$name.'</label></span>'.
1.675     raeburn  16819:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   16820:                              '</td><td>';
1.663     raeburn  16821:                     if (ref($path) eq 'ARRAY') {
                   16822:                         push(@{$path},$name);
1.1259    raeburn  16823:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories,$disabled);
1.663     raeburn  16824:                         pop(@{$path});
                   16825:                     }
                   16826:                     $text .= '</td></tr>';
                   16827:                 }
                   16828:                 $text .= '</table></td>';
                   16829:             }
                   16830:         }
                   16831:     }
                   16832:     return $text;
                   16833: }
                   16834: 
1.1181    raeburn  16835: =pod
                   16836: 
                   16837: =back
                   16838: 
                   16839: =cut
                   16840: 
1.655     raeburn  16841: ############################################################
                   16842: ############################################################
                   16843: 
                   16844: 
1.443     albertel 16845: sub commit_customrole {
1.1408    raeburn  16846:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context,$othdomby,$requester) = @_;
1.1399    raeburn  16847:     my $result = &Apache::lonnet::assigncustomrole(
1.1408    raeburn  16848:                      $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,
                   16849:                      $context,$othdomby,$requester);
1.630     raeburn  16850:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 16851:                          ($start?', '.&mt('starting').' '.localtime($start):'').
1.1399    raeburn  16852:                          ($end?', ending '.localtime($end):'').': <b>'.$result.'</b><br />';
                   16853:     if (wantarray) {
                   16854:         return ($output,$result);
                   16855:     } else {
                   16856:         return $output;
                   16857:     }
1.443     albertel 16858: }
                   16859: 
                   16860: sub commit_standardrole {
1.1408    raeburn  16861:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,$credits,
                   16862:         $othdomby,$requester) = @_;
1.1399    raeburn  16863:     my ($output,$logmsg,$linefeed,$result);
1.541     raeburn  16864:     if ($context eq 'auto') {
                   16865:         $linefeed = "\n";
                   16866:     } else {
                   16867:         $linefeed = "<br />\n";
                   16868:     }  
1.443     albertel 16869:     if ($three eq 'st') {
1.1399    raeburn  16870:         $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
1.1408    raeburn  16871:                                       $one,$two,$sec,$context,$credits,$othdomby,
                   16872:                                       $requester);
1.541     raeburn  16873:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  16874:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   16875:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 16876:         } else {
1.541     raeburn  16877:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 16878:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  16879:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   16880:             if ($context eq 'auto') {
                   16881:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   16882:             } else {
                   16883:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   16884:                &mt('Add to classlist').': <b>ok</b>';
                   16885:             }
                   16886:             $output .= $linefeed;
1.443     albertel 16887:         }
                   16888:     } else {
                   16889:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   16890:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  16891:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.1408    raeburn  16892:         $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,
                   16893:                                               '','',$context,$othdomby,$requester);
1.541     raeburn  16894:         if ($context eq 'auto') {
                   16895:             $output .= $result.$linefeed;
                   16896:         } else {
                   16897:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   16898:         }
1.443     albertel 16899:     }
1.1399    raeburn  16900:     if (wantarray) {
                   16901:         return ($output,$result);
                   16902:     } else {
                   16903:         return $output;
                   16904:     }
1.443     albertel 16905: }
                   16906: 
                   16907: sub commit_studentrole {
1.1116    raeburn  16908:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context,
1.1408    raeburn  16909:         $credits,$othdomby,$requester) = @_;
1.626     raeburn  16910:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  16911:     if ($context eq 'auto') {
                   16912:         $linefeed = "\n";
                   16913:     } else {
                   16914:         $linefeed = '<br />'."\n";
                   16915:     }
1.443     albertel 16916:     if (defined($one) && defined($two)) {
                   16917:         my $cid=$one.'_'.$two;
                   16918:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   16919:         my $secchange = 0;
                   16920:         my $expire_role_result;
                   16921:         my $modify_section_result;
1.628     raeburn  16922:         if ($oldsec ne '-1') { 
                   16923:             if ($oldsec ne $sec) {
1.443     albertel 16924:                 $secchange = 1;
1.628     raeburn  16925:                 my $now = time;
1.443     albertel 16926:                 my $uurl='/'.$cid;
                   16927:                 $uurl=~s/\_/\//g;
                   16928:                 if ($oldsec) {
                   16929:                     $uurl.='/'.$oldsec;
                   16930:                 }
1.626     raeburn  16931:                 $oldsecurl = $uurl;
1.628     raeburn  16932:                 $expire_role_result = 
1.1408    raeburn  16933:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,
                   16934:                                                 '','','',$context,$othdomby,$requester);
                   16935:                 if ($env{'request.course.sec'} ne '') {
1.628     raeburn  16936:                     if ($expire_role_result eq 'refused') {
                   16937:                         my @roles = ('st');
                   16938:                         my @statuses = ('previous');
                   16939:                         my @roledoms = ($one);
                   16940:                         my $withsec = 1;
                   16941:                         my %roleshash = 
                   16942:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   16943:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   16944:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   16945:                             my ($oldstart,$oldend) = 
                   16946:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   16947:                             if ($oldend > 0 && $oldend <= $now) {
                   16948:                                 $expire_role_result = 'ok';
                   16949:                             }
                   16950:                         }
                   16951:                     }
                   16952:                 }
1.443     albertel 16953:                 $result = $expire_role_result;
                   16954:             }
                   16955:         }
                   16956:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.1116    raeburn  16957:             $modify_section_result = 
                   16958:                 &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,
                   16959:                                                            undef,undef,undef,$sec,
                   16960:                                                            $end,$start,'','',$cid,
1.1408    raeburn  16961:                                                            '',$context,$credits,'',
                   16962:                                                            $othdomby,$requester);
1.443     albertel 16963:             if ($modify_section_result =~ /^ok/) {
                   16964:                 if ($secchange == 1) {
1.628     raeburn  16965:                     if ($sec eq '') {
                   16966:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   16967:                     } else {
                   16968:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   16969:                     }
1.443     albertel 16970:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  16971:                     if ($sec eq '') {
                   16972:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   16973:                     } else {
                   16974:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   16975:                     }
1.443     albertel 16976:                 } else {
1.628     raeburn  16977:                     if ($sec eq '') {
                   16978:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   16979:                     } else {
                   16980:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   16981:                     }
1.443     albertel 16982:                 }
                   16983:             } else {
1.1115    raeburn  16984:                 if ($secchange) { 
1.628     raeburn  16985:                     $$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;
                   16986:                 } else {
                   16987:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   16988:                 }
1.443     albertel 16989:             }
                   16990:             $result = $modify_section_result;
                   16991:         } elsif ($secchange == 1) {
1.628     raeburn  16992:             if ($oldsec eq '') {
1.1103    raeburn  16993:                 $$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  16994:             } else {
                   16995:                 $$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;
                   16996:             }
1.626     raeburn  16997:             if ($expire_role_result eq 'refused') {
                   16998:                 my $newsecurl = '/'.$cid;
                   16999:                 $newsecurl =~ s/\_/\//g;
                   17000:                 if ($sec ne '') {
                   17001:                     $newsecurl.='/'.$sec;
                   17002:                 }
                   17003:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   17004:                     if ($sec eq '') {
                   17005:                         $$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;
                   17006:                     } else {
                   17007:                         $$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;
                   17008:                     }
                   17009:                 }
                   17010:             }
1.443     albertel 17011:         }
                   17012:     } else {
1.626     raeburn  17013:         $$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 17014:         $result = "error: incomplete course id\n";
                   17015:     }
                   17016:     return $result;
                   17017: }
                   17018: 
1.1108    raeburn  17019: sub show_role_extent {
                   17020:     my ($scope,$context,$role) = @_;
                   17021:     $scope =~ s{^/}{};
                   17022:     my @courseroles = &Apache::lonuserutils::roles_by_context('course',1);
                   17023:     push(@courseroles,'co');
                   17024:     my @authorroles = &Apache::lonuserutils::roles_by_context('author');
                   17025:     if (($context eq 'course') || (grep(/^\Q$role\E/,@courseroles))) {
                   17026:         $scope =~ s{/}{_};
                   17027:         return '<span class="LC_cusr_emph">'.$env{'course.'.$scope.'.description'}.'</span>';
                   17028:     } elsif (($context eq 'author') || (grep(/^\Q$role\E/,@authorroles))) {
                   17029:         my ($audom,$auname) = split(/\//,$scope);
                   17030:         return &mt('[_1] Author Space','<span class="LC_cusr_emph">'.
                   17031:                    &Apache::loncommon::plainname($auname,$audom).'</span>');
                   17032:     } else {
                   17033:         $scope =~ s{/$}{};
                   17034:         return &mt('Domain: [_1]','<span class="LC_cusr_emph">'.
                   17035:                    &Apache::lonnet::domain($scope,'description').'</span>');
                   17036:     }
                   17037: }
                   17038: 
1.443     albertel 17039: ############################################################
                   17040: ############################################################
                   17041: 
1.566     albertel 17042: sub check_clone {
1.578     raeburn  17043:     my ($args,$linefeed) = @_;
1.566     albertel 17044:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   17045:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   17046:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
1.1344    raeburn  17047:     my $clonetitle;
                   17048:     my @clonemsg;
1.566     albertel 17049:     my $can_clone = 0;
1.944     raeburn  17050:     my $lctype = lc($args->{'crstype'});
1.908     raeburn  17051:     if ($lctype ne 'community') {
                   17052:         $lctype = 'course';
                   17053:     }
1.566     albertel 17054:     if ($clonehome eq 'no_host') {
1.944     raeburn  17055:         if ($args->{'crstype'} eq 'Community') {
1.1344    raeburn  17056:             push(@clonemsg,({
                   17057:                               mt => 'No new community created.',
                   17058:                               args => [],
                   17059:                             },
                   17060:                             {
                   17061:                               mt => 'A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',
                   17062:                               args => [$args->{'clonedomain'}.':'.$args->{'clonedomain'}],
                   17063:                             }));
1.908     raeburn  17064:         } else {
1.1344    raeburn  17065:             push(@clonemsg,({
                   17066:                               mt => 'No new course created.',
                   17067:                               args => [],
                   17068:                             },
                   17069:                             {
                   17070:                               mt => 'A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',
                   17071:                               args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   17072:                             }));
                   17073:         }
1.566     albertel 17074:     } else {
                   17075: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.1344    raeburn  17076:         $clonetitle = $clonedesc{'description'};
1.944     raeburn  17077:         if ($args->{'crstype'} eq 'Community') {
1.908     raeburn  17078:             if ($clonedesc{'type'} ne 'Community') {
1.1344    raeburn  17079:                 push(@clonemsg,({
                   17080:                                   mt => 'No new community created.',
                   17081:                                   args => [],
                   17082:                                 },
                   17083:                                 {
                   17084:                                   mt => 'A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',
                   17085:                                   args => [$args->{'clonecourse'}.':'.$args->{'clonedomain'}],
                   17086:                                 }));
                   17087:                 return ($can_clone,\@clonemsg,$cloneid,$clonehome);
1.908     raeburn  17088:             }
                   17089:         }
1.1262    raeburn  17090: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) &&
1.882     raeburn  17091:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 17092: 	    $can_clone = 1;
                   17093: 	} else {
1.1221    raeburn  17094: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners','internal.coursecode'],
1.566     albertel 17095: 						 $args->{'clonedomain'},$args->{'clonecourse'});
1.1221    raeburn  17096:             if ($clonehash{'cloners'} eq '') {
                   17097:                 my %domdefs = &Apache::lonnet::get_domain_defaults($args->{'course_domain'});
                   17098:                 if ($domdefs{'canclone'}) {
                   17099:                     unless ($domdefs{'canclone'} eq 'none') {
                   17100:                         if ($domdefs{'canclone'} eq 'domain') {
                   17101:                             if ($args->{'ccdomain'} eq $args->{'clonedomain'}) {
                   17102:                                 $can_clone = 1;
                   17103:                             }
                   17104:                         } elsif (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) && 
                   17105:                                  ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
                   17106:                             if (&Apache::lonnet::default_instcode_cloning($args->{'clonedomain'},$domdefs{'canclone'},
                   17107:                                                                           $clonehash{'internal.coursecode'},$args->{'crscode'})) {
                   17108:                                 $can_clone = 1;
                   17109:                             }
                   17110:                         }
                   17111:                     }
                   17112:                 }
1.578     raeburn  17113:             } else {
1.1221    raeburn  17114: 	        my @cloners = split(/,/,$clonehash{'cloners'});
                   17115:                 if (grep(/^\*$/,@cloners)) {
1.942     raeburn  17116:                     $can_clone = 1;
1.1221    raeburn  17117:                 } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
1.942     raeburn  17118:                     $can_clone = 1;
1.1225    raeburn  17119:                 } elsif (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   17120:                     $can_clone = 1;
1.1221    raeburn  17121:                 }
                   17122:                 unless ($can_clone) {
1.1225    raeburn  17123:                     if (($clonehash{'internal.coursecode'}) && ($args->{'crscode'}) && 
                   17124:                         ($args->{'clonedomain'} eq  $args->{'course_domain'})) {
1.1221    raeburn  17125:                         my (%gotdomdefaults,%gotcodedefaults);
                   17126:                         foreach my $cloner (@cloners) {
                   17127:                             if (($cloner ne '*') && ($cloner !~ /^\*\:$match_domain$/) &&
                   17128:                                 ($cloner !~ /^$match_username\:$match_domain$/) && ($cloner ne '')) {
                   17129:                                 my (%codedefaults,@code_order);
                   17130:                                 if (ref($gotcodedefaults{$args->{'clonedomain'}}) eq 'HASH') {
                   17131:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'defaults'}) eq 'HASH') {
                   17132:                                         %codedefaults = %{$gotcodedefaults{$args->{'clonedomain'}}{'defaults'}};
                   17133:                                     }
                   17134:                                     if (ref($gotcodedefaults{$args->{'clonedomain'}}{'order'}) eq 'ARRAY') {
                   17135:                                         @code_order = @{$gotcodedefaults{$args->{'clonedomain'}}{'order'}};
                   17136:                                     }
                   17137:                                 } else {
                   17138:                                     &Apache::lonnet::auto_instcode_defaults($args->{'clonedomain'},
                   17139:                                                                             \%codedefaults,
                   17140:                                                                             \@code_order);
                   17141:                                     $gotcodedefaults{$args->{'clonedomain'}}{'defaults'} = \%codedefaults;
                   17142:                                     $gotcodedefaults{$args->{'clonedomain'}}{'order'} = \@code_order;
                   17143:                                 }
                   17144:                                 if (@code_order > 0) {
                   17145:                                     if (&Apache::lonnet::check_instcode_cloning(\%codedefaults,\@code_order,
                   17146:                                                                                 $cloner,$clonehash{'internal.coursecode'},
                   17147:                                                                                 $args->{'crscode'})) {
                   17148:                                         $can_clone = 1;
                   17149:                                         last;
                   17150:                                     }
                   17151:                                 }
                   17152:                             }
                   17153:                         }
                   17154:                     }
1.1225    raeburn  17155:                 }
                   17156:             }
                   17157:             unless ($can_clone) {
                   17158:                 my $ccrole = 'cc';
                   17159:                 if ($args->{'crstype'} eq 'Community') {
                   17160:                     $ccrole = 'co';
                   17161:                 }
                   17162: 	        my %roleshash =
                   17163: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   17164: 					          $args->{'ccdomain'},
                   17165:                                                   'userroles',['active'],[$ccrole],
                   17166: 					          [$args->{'clonedomain'}]);
                   17167: 	        if ($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) {
                   17168:                     $can_clone = 1;
                   17169:                 } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},
                   17170:                                                           $args->{'ccuname'},$args->{'ccdomain'})) {
                   17171:                     $can_clone = 1;
1.1221    raeburn  17172:                 }
                   17173:             }
                   17174:             unless ($can_clone) {
                   17175:                 if ($args->{'crstype'} eq 'Community') {
1.1344    raeburn  17176:                     push(@clonemsg,({
                   17177:                                       mt => 'No new community created.',
                   17178:                                       args => [],
                   17179:                                     },
                   17180:                                     {
                   17181:                                       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]).',
                   17182:                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   17183:                                     }));
1.942     raeburn  17184:                 } else {
1.1344    raeburn  17185:                     push(@clonemsg,({
                   17186:                                       mt => 'No new course created.',
                   17187:                                       args => [],
                   17188:                                     },
                   17189:                                     {
                   17190:                                       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]).',
                   17191:                                       args => [$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}],
                   17192:                                     }));
1.1221    raeburn  17193:                 }
1.566     albertel 17194: 	    }
1.578     raeburn  17195:         }
1.566     albertel 17196:     }
1.1344    raeburn  17197:     return ($can_clone,\@clonemsg,$cloneid,$clonehome,$clonetitle);
1.566     albertel 17198: }
                   17199: 
1.444     albertel 17200: sub construct_course {
1.1262    raeburn  17201:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,
1.1344    raeburn  17202:         $cnum,$category,$coderef,$callercontext,$user_lh) = @_;
                   17203:     my ($outcome,$msgref,$clonemsgref);
1.541     raeburn  17204:     my $linefeed =  '<br />'."\n";
                   17205:     if ($context eq 'auto') {
                   17206:         $linefeed = "\n";
                   17207:     }
1.566     albertel 17208: 
                   17209: #
                   17210: # Are we cloning?
                   17211: #
1.1344    raeburn  17212:     my ($can_clone,$cloneid,$clonehome,$clonetitle);
1.566     albertel 17213:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.1344    raeburn  17214: 	($can_clone,$clonemsgref,$cloneid,$clonehome,$clonetitle) = &check_clone($args,$linefeed);
1.566     albertel 17215:         if (!$can_clone) {
1.1344    raeburn  17216: 	    return (0,$outcome,$clonemsgref);
1.566     albertel 17217: 	}
                   17218:     }
                   17219: 
1.444     albertel 17220: #
                   17221: # Open course
                   17222: #
1.1239    raeburn  17223:     my $showncrstype;
                   17224:     if ($args->{'crstype'} eq 'Placement') {
                   17225:         $showncrstype = 'placement test'; 
                   17226:     } else {  
                   17227:         $showncrstype = lc($args->{'crstype'});
                   17228:     }
1.444     albertel 17229:     my %cenv=();
                   17230:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   17231:                                              $args->{'cdescr'},
                   17232:                                              $args->{'curl'},
                   17233:                                              $args->{'course_home'},
                   17234:                                              $args->{'nonstandard'},
                   17235:                                              $args->{'crscode'},
                   17236:                                              $args->{'ccuname'}.':'.
                   17237:                                              $args->{'ccdomain'},
1.882     raeburn  17238:                                              $args->{'crstype'},
1.1344    raeburn  17239:                                              $cnum,$context,$category,
                   17240:                                              $callercontext);
1.444     albertel 17241: 
                   17242:     # Note: The testing routines depend on this being output; see 
                   17243:     # Utils::Course. This needs to at least be output as a comment
                   17244:     # if anyone ever decides to not show this, and Utils::Course::new
                   17245:     # will need to be suitably modified.
1.1344    raeburn  17246:     if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   17247:         $outcome .= &mt_user($user_lh,'New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
                   17248:     } else {
                   17249:         $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$showncrstype,$$courseid).$linefeed;
                   17250:     }
1.943     raeburn  17251:     if ($$courseid =~ /^error:/) {
1.1344    raeburn  17252:         return (0,$outcome,$clonemsgref);
1.943     raeburn  17253:     }
                   17254: 
1.444     albertel 17255: #
                   17256: # Check if created correctly
                   17257: #
1.479     albertel 17258:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 17259:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.943     raeburn  17260:     if ($crsuhome eq 'no_host') {
1.1344    raeburn  17261:         if (($callercontext eq 'auto') && ($user_lh ne '')) {
                   17262:             $outcome .= &mt_user($user_lh,
                   17263:                             'Course creation failed, unrecognized course home server.');
                   17264:         } else {
                   17265:             $outcome .= &mt('Course creation failed, unrecognized course home server.');
                   17266:         }
                   17267:         $outcome .= $linefeed;
                   17268:         return (0,$outcome,$clonemsgref);
1.943     raeburn  17269:     }
1.541     raeburn  17270:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 17271: 
1.444     albertel 17272: #
1.566     albertel 17273: # Do the cloning
                   17274: #   
1.1344    raeburn  17275:     my @clonemsg;
1.566     albertel 17276:     if ($can_clone && $cloneid) {
1.1344    raeburn  17277:         push(@clonemsg,
                   17278:                       {
                   17279:                           mt => 'Created [_1] by cloning from [_2]',
                   17280:                           args => [$showncrstype,$clonetitle],
                   17281:                       });
1.566     albertel 17282: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 17283: # Copy all files
1.1344    raeburn  17284:         my @info =
                   17285: 	    &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},
                   17286: 	                                             $args->{'dateshift'},$args->{'crscode'},
                   17287:                                                      $args->{'ccuname'}.':'.$args->{'ccdomain'},
                   17288:                                                      $args->{'tinyurls'});
                   17289:         if (@info) {
                   17290:             push(@clonemsg,@info);
                   17291:         }
1.444     albertel 17292: # Restore URL
1.566     albertel 17293: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 17294: # Restore title
1.566     albertel 17295: 	$cenv{'description'}=$oldcenv{'description'};
1.955     raeburn  17296: # Restore creation date, creator and creation context.
                   17297:         $cenv{'internal.created'}=$oldcenv{'internal.created'};
                   17298:         $cenv{'internal.creator'}=$oldcenv{'internal.creator'};
                   17299:         $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'};
1.444     albertel 17300: # Mark as cloned
1.566     albertel 17301: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      17302: # Need to clone grading mode
                   17303:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   17304:         $cenv{'grading'}=$newenv{'grading'};
                   17305: # Do not clone these environment entries
                   17306:         &Apache::lonnet::del('environment',
                   17307:                   ['default_enrollment_start_date',
                   17308:                    'default_enrollment_end_date',
                   17309:                    'question.email',
                   17310:                    'policy.email',
                   17311:                    'comment.email',
                   17312:                    'pch.users.denied',
1.725     raeburn  17313:                    'plc.users.denied',
                   17314:                    'hidefromcat',
1.1121    raeburn  17315:                    'checkforpriv',
1.1355    raeburn  17316:                    'categories'],
1.638     www      17317:                    $$crsudom,$$crsunum);
1.1170    raeburn  17318:         if ($args->{'textbook'}) {
                   17319:             $cenv{'internal.textbook'} = $args->{'textbook'};
                   17320:         }
1.444     albertel 17321:     }
1.566     albertel 17322: 
1.444     albertel 17323: #
                   17324: # Set environment (will override cloned, if existing)
                   17325: #
                   17326:     my @sections = ();
                   17327:     my @xlists = ();
                   17328:     if ($args->{'crstype'}) {
                   17329:         $cenv{'type'}=$args->{'crstype'};
                   17330:     }
1.1371    raeburn  17331:     if ($args->{'lti'}) {
                   17332:         $cenv{'internal.lti'}=$args->{'lti'};
                   17333:     }
1.444     albertel 17334:     if ($args->{'crsid'}) {
                   17335:         $cenv{'courseid'}=$args->{'crsid'};
                   17336:     }
                   17337:     if ($args->{'crscode'}) {
                   17338:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   17339:     }
                   17340:     if ($args->{'crsquota'} ne '') {
                   17341:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   17342:     } else {
                   17343:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   17344:     }
                   17345:     if ($args->{'ccuname'}) {
                   17346:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   17347:                                         ':'.$args->{'ccdomain'};
                   17348:     } else {
                   17349:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   17350:     }
1.1116    raeburn  17351:     if ($args->{'defaultcredits'}) {
                   17352:         $cenv{'internal.defaultcredits'} = $args->{'defaultcredits'};
                   17353:     }
1.444     albertel 17354:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
1.1412    raeburn  17355:     my @oklcsecs = (); # Used to accumulate LON-CAPA sections for validated institutional sections.
1.444     albertel 17356:     if ($args->{'crssections'}) {
                   17357:         $cenv{'internal.sectionnums'} = '';
                   17358:         if ($args->{'crssections'} =~ m/,/) {
                   17359:             @sections = split/,/,$args->{'crssections'};
                   17360:         } else {
                   17361:             $sections[0] = $args->{'crssections'};
                   17362:         }
                   17363:         if (@sections > 0) {
                   17364:             foreach my $item (@sections) {
                   17365:                 my ($sec,$gp) = split/:/,$item;
                   17366:                 my $class = $args->{'crscode'}.$sec;
                   17367:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   17368:                 $cenv{'internal.sectionnums'} .= $item.',';
1.1412    raeburn  17369:                 if ($addcheck eq 'ok') {
                   17370:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   17371:                         push(@oklcsecs,$gp);
                   17372:                     }
                   17373:                 } else {
1.1263    raeburn  17374:                     push(@badclasses,$class);
1.444     albertel 17375:                 }
                   17376:             }
                   17377:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   17378:         }
                   17379:     }
                   17380: # do not hide course coordinator from staff listing, 
                   17381: # even if privileged
                   17382:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
1.1121    raeburn  17383: # add course coordinator's domain to domains to check for privileged users
                   17384: # if different to course domain
                   17385:     if ($$crsudom ne $args->{'ccdomain'}) {
                   17386:         $cenv{'checkforpriv'} = $args->{'ccdomain'};
                   17387:     }
1.444     albertel 17388: # add crosslistings
                   17389:     if ($args->{'crsxlist'}) {
                   17390:         $cenv{'internal.crosslistings'}='';
                   17391:         if ($args->{'crsxlist'} =~ m/,/) {
                   17392:             @xlists = split/,/,$args->{'crsxlist'};
                   17393:         } else {
                   17394:             $xlists[0] = $args->{'crsxlist'};
                   17395:         }
                   17396:         if (@xlists > 0) {
                   17397:             foreach my $item (@xlists) {
                   17398:                 my ($xl,$gp) = split/:/,$item;
                   17399:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   17400:                 $cenv{'internal.crosslistings'} .= $item.',';
1.1412    raeburn  17401:                 if ($addcheck eq 'ok') {
                   17402:                     unless (grep(/^\Q$gp\E$/,@oklcsecs)) {
                   17403:                         push(@oklcsecs,$gp);
                   17404:                     }
                   17405:                 } else {
1.1263    raeburn  17406:                     push(@badclasses,$xl);
1.444     albertel 17407:                 }
                   17408:             }
                   17409:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   17410:         }
                   17411:     }
                   17412:     if ($args->{'autoadds'}) {
                   17413:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   17414:     }
                   17415:     if ($args->{'autodrops'}) {
                   17416:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   17417:     }
                   17418: # check for notification of enrollment changes
                   17419:     my @notified = ();
                   17420:     if ($args->{'notify_owner'}) {
                   17421:         if ($args->{'ccuname'} ne '') {
                   17422:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   17423:         }
                   17424:     }
                   17425:     if ($args->{'notify_dc'}) {
                   17426:         if ($uname ne '') { 
1.630     raeburn  17427:             push(@notified,$uname.':'.$udom);
1.444     albertel 17428:         }
                   17429:     }
                   17430:     if (@notified > 0) {
                   17431:         my $notifylist;
                   17432:         if (@notified > 1) {
                   17433:             $notifylist = join(',',@notified);
                   17434:         } else {
                   17435:             $notifylist = $notified[0];
                   17436:         }
                   17437:         $cenv{'internal.notifylist'} = $notifylist;
                   17438:     }
                   17439:     if (@badclasses > 0) {
                   17440:         my %lt=&Apache::lonlocal::texthash(
1.1264    raeburn  17441:                 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course.',
                   17442:                 'howi' => 'However, if automated course roster updates are enabled for this class, these particular sections/crosslistings are not guaranteed to contribute towards enrollment.',
                   17443:                 'itis' => 'It is possible that rights to access enrollment for these classes will be available through assignment of co-owners.',
1.444     albertel 17444:         );
1.1264    raeburn  17445:         my $badclass_msg = $lt{'tclb'}.$linefeed.$lt{'howi'}.$linefeed.
                   17446:                            &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  17447:         if ($context eq 'auto') {
                   17448:             $outcome .= $badclass_msg.$linefeed;
1.1261    raeburn  17449:         } else {
1.566     albertel 17450:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.1261    raeburn  17451:         }
                   17452:         foreach my $item (@badclasses) {
1.541     raeburn  17453:             if ($context eq 'auto') {
1.1261    raeburn  17454:                 $outcome .= " - $item\n";
1.541     raeburn  17455:             } else {
1.1261    raeburn  17456:                 $outcome .= "<li>$item</li>\n";
1.541     raeburn  17457:             }
1.1261    raeburn  17458:         }
                   17459:         if ($context eq 'auto') {
                   17460:             $outcome .= $linefeed;
                   17461:         } else {
                   17462:             $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  17463:         } 
1.444     albertel 17464:     }
                   17465:     if ($args->{'no_end_date'}) {
                   17466:         $args->{'endaccess'} = 0;
                   17467:     }
1.1412    raeburn  17468: #  If an official course with institutional sections is created by cloning 
                   17469: #  an existing course, section-specific hiding of course totals in student's
                   17470: #  view of grades as copied from cloned course, will be checked for valid 
                   17471: #  sections.
                   17472:     if (($can_clone && $cloneid) &&
                   17473:         ($cenv{'internal.coursecode'} ne '') &&
                   17474:         ($cenv{'grading'} eq 'standard') &&
                   17475:         ($cenv{'hidetotals'} ne '') &&
                   17476:         ($cenv{'hidetotals'} ne 'all')) {
                   17477:         my @hidesecs;
                   17478:         my $deletehidetotals;
                   17479:         if (@oklcsecs) {
                   17480:             foreach my $sec (split(/,/,$cenv{'hidetotals'})) {
                   17481:                 if (grep(/^\Q$sec$/,@oklcsecs)) {
                   17482:                     push(@hidesecs,$sec);
                   17483:                 }
                   17484:             }
                   17485:             if (@hidesecs) {
                   17486:                 $cenv{'hidetotals'} = join(',',@hidesecs);
                   17487:             } else {
                   17488:                 $deletehidetotals = 1;
                   17489:             }
                   17490:         } else {
                   17491:             $deletehidetotals = 1;
                   17492:         }
                   17493:         if ($deletehidetotals) {
                   17494:             delete($cenv{'hidetotals'});
                   17495:             &Apache::lonnet::del('environment',['hidetotals'],$$crsudom,$$crsunum);
                   17496:         }
                   17497:     }
1.444     albertel 17498:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   17499:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   17500:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   17501:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   17502:     if ($args->{'showphotos'}) {
                   17503:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   17504:     }
                   17505:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   17506:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   17507:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   17508:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  17509:             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'); 
                   17510:             if ($context eq 'auto') {
                   17511:                 $outcome .= $krb_msg;
                   17512:             } else {
1.566     albertel 17513:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  17514:             }
                   17515:             $outcome .= $linefeed;
1.444     albertel 17516:         }
                   17517:     }
                   17518:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   17519:        if ($args->{'setpolicy'}) {
                   17520:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   17521:        }
                   17522:        if ($args->{'setcontent'}) {
                   17523:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   17524:        }
1.1251    raeburn  17525:        if ($args->{'setcomment'}) {
                   17526:            $cenv{'comment.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   17527:        }
1.444     albertel 17528:     }
                   17529:     if ($args->{'reshome'}) {
                   17530: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   17531: 	$cenv{'reshome'}=~s/\/+$/\//;
                   17532:     }
                   17533: #
                   17534: # course has keyed access
                   17535: #
                   17536:     if ($args->{'setkeys'}) {
                   17537:        $cenv{'keyaccess'}='yes';
                   17538:     }
                   17539: # if specified, key authority is not course, but user
                   17540: # only active if keyaccess is yes
                   17541:     if ($args->{'keyauth'}) {
1.487     albertel 17542: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   17543: 	$user = &LONCAPA::clean_username($user);
                   17544: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     17545: 	if ($user ne '' && $domain ne '') {
1.487     albertel 17546: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 17547: 	}
                   17548:     }
                   17549: 
1.1166    raeburn  17550: #
1.1167    raeburn  17551: #  generate and store uniquecode (available to course requester), if course should have one.
1.1166    raeburn  17552: #
                   17553:     if ($args->{'uniquecode'}) {
                   17554:         my ($code,$error) = &make_unique_code($$crsudom,$$crsunum);
                   17555:         if ($code) {
                   17556:             $cenv{'internal.uniquecode'} = $code;
1.1167    raeburn  17557:             my %crsinfo =
                   17558:                 &Apache::lonnet::courseiddump($$crsudom,'.',1,'.','.',$$crsunum,undef,undef,'.');
                   17559:             if (ref($crsinfo{$$crsudom.'_'.$$crsunum}) eq 'HASH') {
                   17560:                 $crsinfo{$$crsudom.'_'.$$crsunum}{'uniquecode'} = $code;
                   17561:                 my $putres = &Apache::lonnet::courseidput($$crsudom,\%crsinfo,$crsuhome,'notime');
                   17562:             } 
1.1166    raeburn  17563:             if (ref($coderef)) {
                   17564:                 $$coderef = $code;
                   17565:             }
                   17566:         }
                   17567:     }
                   17568: 
1.444     albertel 17569:     if ($args->{'disresdis'}) {
                   17570:         $cenv{'pch.roles.denied'}='st';
                   17571:     }
                   17572:     if ($args->{'disablechat'}) {
                   17573:         $cenv{'plc.roles.denied'}='st';
                   17574:     }
                   17575: 
                   17576:     # Record we've not yet viewed the Course Initialization Helper for this 
                   17577:     # course
                   17578:     $cenv{'course.helper.not.run'} = 1;
                   17579:     #
                   17580:     # Use new Randomseed
                   17581:     #
                   17582:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   17583:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   17584:     #
                   17585:     # The encryption code and receipt prefix for this course
                   17586:     #
                   17587:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   17588:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   17589:     #
                   17590:     # By default, use standard grading
                   17591:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   17592: 
1.541     raeburn  17593:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   17594:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 17595: #
                   17596: # Open all assignments
                   17597: #
                   17598:     if ($args->{'openall'}) {
1.1341    raeburn  17599:        my $opendate = time;
                   17600:        if ($args->{'openallfrom'} =~ /^\d+$/) {
                   17601:            $opendate = $args->{'openallfrom'};
                   17602:        }
1.444     albertel 17603:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
1.1341    raeburn  17604:        my %storecontent = ($storeunder         => $opendate,
1.444     albertel 17605:                            $storeunder.'.type' => 'date_start');
1.1341    raeburn  17606:        $outcome .= &mt('All assignments open starting [_1]',
                   17607:                        &Apache::lonlocal::locallocaltime($opendate)).': '.
                   17608:                    &Apache::lonnet::cput
                   17609:                        ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 17610:    }
                   17611: #
                   17612: # Set first page
                   17613: #
                   17614:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   17615: 	    || ($cloneid)) {
                   17616: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 17617: 
                   17618: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   17619:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   17620: 
1.444     albertel 17621:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   17622:         my $title; my $url;
                   17623:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   17624: 	    $title=&mt('Syllabus');
1.444     albertel 17625:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   17626:         } else {
1.963     raeburn  17627:             $title=&mt('Table of Contents');
1.444     albertel 17628:             $url='/adm/navmaps';
                   17629:         }
1.445     albertel 17630: 
                   17631:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   17632: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   17633: 
                   17634: 	if ($errtext) { $fatal=2; }
1.541     raeburn  17635:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 17636:     }
1.566     albertel 17637: 
1.1237    raeburn  17638: # 
                   17639: # Set params for Placement Tests
                   17640: #
1.1239    raeburn  17641:     if ($args->{'crstype'} eq 'Placement') {
                   17642:        my %storecontent; 
                   17643:        my $prefix=$$crsudom.'_'.$$crsunum.'.0.';
                   17644:        my %defaults = (
                   17645:                         buttonshide   => { value => 'yes',
                   17646:                                            type => 'string_yesno',},
                   17647:                         type          => { value => 'randomizetry',
                   17648:                                            type  => 'string_questiontype',},
                   17649:                         maxtries      => { value => 1,
                   17650:                                            type => 'int_pos',},
                   17651:                         problemstatus => { value => 'no',
                   17652:                                            type  => 'string_problemstatus',},
                   17653:                       );
                   17654:        foreach my $key (keys(%defaults)) {
                   17655:            $storecontent{$prefix.$key} = $defaults{$key}{'value'};
                   17656:            $storecontent{$prefix.$key.'.type'} = $defaults{$key}{'type'};
                   17657:        }
1.1237    raeburn  17658:        &Apache::lonnet::cput
                   17659:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum); 
                   17660:     }
                   17661: 
1.1344    raeburn  17662:     return (1,$outcome,\@clonemsg);
1.444     albertel 17663: }
                   17664: 
1.1166    raeburn  17665: sub make_unique_code {
                   17666:     my ($cdom,$cnum) = @_;
                   17667:     # get lock on uniquecodes db
                   17668:     my $lockhash = {
                   17669:                       $cnum."\0".'uniquecodes' => $env{'user.name'}.
                   17670:                                                   ':'.$env{'user.domain'},
                   17671:                    };
                   17672:     my $tries = 0;
                   17673:     my $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   17674:     my ($code,$error);
                   17675:   
                   17676:     while (($gotlock ne 'ok') && ($tries<3)) {
                   17677:         $tries ++;
                   17678:         sleep 1;
                   17679:         $gotlock = &Apache::lonnet::newput_dom('uniquecodes',$lockhash,$cdom);
                   17680:     }
                   17681:     if ($gotlock eq 'ok') {
                   17682:         my %currcodes = &Apache::lonnet::dump_dom('uniquecodes',$cdom);
                   17683:         my $gotcode;
                   17684:         my $attempts = 0;
                   17685:         while ((!$gotcode) && ($attempts < 100)) {
                   17686:             $code = &generate_code();
                   17687:             if (!exists($currcodes{$code})) {
                   17688:                 $gotcode = 1;
                   17689:                 unless (&Apache::lonnet::newput_dom('uniquecodes',{ $code => $cnum },$cdom) eq 'ok') {
                   17690:                     $error = 'nostore';
                   17691:                 }
                   17692:             }
                   17693:             $attempts ++;
                   17694:         }
                   17695:         my @del_lock = ($cnum."\0".'uniquecodes');
                   17696:         my $dellockoutcome = &Apache::lonnet::del_dom('uniquecodes',\@del_lock,$cdom);
                   17697:     } else {
                   17698:         $error = 'nolock';
                   17699:     }
                   17700:     return ($code,$error);
                   17701: }
                   17702: 
                   17703: sub generate_code {
                   17704:     my $code;
                   17705:     my @letts = qw(B C D G H J K M N P Q R S T V W X Z);
                   17706:     for (my $i=0; $i<6; $i++) {
                   17707:         my $lettnum = int (rand 2);
                   17708:         my $item = '';
                   17709:         if ($lettnum) {
                   17710:             $item = $letts[int( rand(18) )];
                   17711:         } else {
                   17712:             $item = 1+int( rand(8) );
                   17713:         }
                   17714:         $code .= $item;
                   17715:     }
                   17716:     return $code;
                   17717: }
                   17718: 
1.444     albertel 17719: ############################################################
                   17720: ############################################################
                   17721: 
1.1237    raeburn  17722: # Community, Course and Placement Test
1.378     raeburn  17723: sub course_type {
                   17724:     my ($cid) = @_;
                   17725:     if (!defined($cid)) {
                   17726:         $cid = $env{'request.course.id'};
                   17727:     }
1.404     albertel 17728:     if (defined($env{'course.'.$cid.'.type'})) {
                   17729:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  17730:     } else {
                   17731:         return 'Course';
1.377     raeburn  17732:     }
                   17733: }
1.156     albertel 17734: 
1.406     raeburn  17735: sub group_term {
                   17736:     my $crstype = &course_type();
                   17737:     my %names = (
                   17738:                   'Course' => 'group',
1.865     raeburn  17739:                   'Community' => 'group',
1.1237    raeburn  17740:                   'Placement' => 'group',
1.406     raeburn  17741:                 );
                   17742:     return $names{$crstype};
                   17743: }
                   17744: 
1.902     raeburn  17745: sub course_types {
1.1310    raeburn  17746:     my @types = ('official','unofficial','community','textbook','placement','lti');
1.902     raeburn  17747:     my %typename = (
                   17748:                          official   => 'Official course',
                   17749:                          unofficial => 'Unofficial course',
                   17750:                          community  => 'Community',
1.1165    raeburn  17751:                          textbook   => 'Textbook course',
1.1237    raeburn  17752:                          placement  => 'Placement test',
1.1310    raeburn  17753:                          lti        => 'LTI provider',
1.902     raeburn  17754:                    );
                   17755:     return (\@types,\%typename);
                   17756: }
                   17757: 
1.156     albertel 17758: sub icon {
                   17759:     my ($file)=@_;
1.505     albertel 17760:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 17761:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 17762:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 17763:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   17764: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   17765: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   17766: 	            $curfext.".gif") {
                   17767: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   17768: 		$curfext.".gif";
                   17769: 	}
                   17770:     }
1.249     albertel 17771:     return &lonhttpdurl($iconname);
1.154     albertel 17772: } 
1.84      albertel 17773: 
1.575     albertel 17774: sub lonhttpdurl {
1.692     www      17775: #
                   17776: # Had been used for "small fry" static images on separate port 8080.
                   17777: # Modify here if lightweight http functionality desired again.
                   17778: # Currently eliminated due to increasing firewall issues.
                   17779: #
1.575     albertel 17780:     my ($url)=@_;
1.692     www      17781:     return $url;
1.215     albertel 17782: }
                   17783: 
1.213     albertel 17784: sub connection_aborted {
                   17785:     my ($r)=@_;
                   17786:     $r->print(" ");$r->rflush();
                   17787:     my $c = $r->connection;
                   17788:     return $c->aborted();
                   17789: }
                   17790: 
1.221     foxr     17791: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     17792: #    strings as 'strings'.
                   17793: sub escape_single {
1.221     foxr     17794:     my ($input) = @_;
1.223     albertel 17795:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     17796:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   17797:     return $input;
                   17798: }
1.223     albertel 17799: 
1.222     foxr     17800: #  Same as escape_single, but escape's "'s  This 
                   17801: #  can be used for  "strings"
                   17802: sub escape_double {
                   17803:     my ($input) = @_;
                   17804:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   17805:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   17806:     return $input;
                   17807: }
1.223     albertel 17808:  
1.222     foxr     17809: #   Escapes the last element of a full URL.
                   17810: sub escape_url {
                   17811:     my ($url)   = @_;
1.238     raeburn  17812:     my @urlslices = split(/\//, $url,-1);
1.369     www      17813:     my $lastitem = &escape(pop(@urlslices));
1.1203    raeburn  17814:     return &HTML::Entities::encode(join('/',@urlslices),"'").'/'.$lastitem;
1.222     foxr     17815: }
1.462     albertel 17816: 
1.820     raeburn  17817: sub compare_arrays {
                   17818:     my ($arrayref1,$arrayref2) = @_;
                   17819:     my (@difference,%count);
                   17820:     @difference = ();
                   17821:     %count = ();
                   17822:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   17823:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   17824:         foreach my $element (keys(%count)) {
                   17825:             if ($count{$element} == 1) {
                   17826:                 push(@difference,$element);
                   17827:             }
                   17828:         }
                   17829:     }
                   17830:     return @difference;
                   17831: }
                   17832: 
1.1322    raeburn  17833: sub lon_status_items {
                   17834:     my %defaults = (
                   17835:                      E         => 100,
                   17836:                      W         => 4,
                   17837:                      N         => 1,
1.1324    raeburn  17838:                      U         => 5,
1.1322    raeburn  17839:                      threshold => 200,
                   17840:                      sysmail   => 2500,
                   17841:                    );
                   17842:     my %names = (
                   17843:                    E => 'Errors',
                   17844:                    W => 'Warnings',
                   17845:                    N => 'Notices',
1.1324    raeburn  17846:                    U => 'Unsent',
1.1322    raeburn  17847:                 );
                   17848:     return (\%defaults,\%names);
                   17849: }
                   17850: 
1.817     bisitz   17851: # -------------------------------------------------------- Initialize user login
1.462     albertel 17852: sub init_user_environment {
1.463     albertel 17853:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 17854:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   17855: 
                   17856:     my $public=($username eq 'public' && $domain eq 'public');
                   17857: 
1.1415    raeburn  17858:     my ($filename,$cookie,$userroles,$firstaccenv,$timerintenv,
                   17859:         $coauthorenv);
1.462     albertel 17860:     my $now=time;
                   17861: 
                   17862:     if ($public) {
                   17863: 	my $max_public=100;
                   17864: 	my $oldest;
                   17865: 	my $oldest_time=0;
                   17866: 	for(my $next=1;$next<=$max_public;$next++) {
                   17867: 	    if (-e $lonids."/publicuser_$next.id") {
                   17868: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   17869: 		if ($mtime<$oldest_time || !$oldest_time) {
                   17870: 		    $oldest_time=$mtime;
                   17871: 		    $oldest=$next;
                   17872: 		}
                   17873: 	    } else {
                   17874: 		$cookie="publicuser_$next";
                   17875: 		last;
                   17876: 	    }
                   17877: 	}
                   17878: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   17879:     } else {
1.1275    raeburn  17880: 	# See if old ID present, if so, remove if this isn't a robot,
                   17881: 	# killing any existing non-robot sessions
1.463     albertel 17882: 	if (!$args->{'robot'}) {
                   17883: 	    opendir(DIR,$lonids);
                   17884: 	    while ($filename=readdir(DIR)) {
                   17885: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
1.1320    raeburn  17886:                     if (tie(my %oldenv,'GDBM_File',"$lonids/$filename",
                   17887:                             &GDBM_READER(),0640)) {
1.1295    raeburn  17888:                         my $linkedfile;
1.1320    raeburn  17889:                         if (exists($oldenv{'user.linkedenv'})) {
                   17890:                             $linkedfile = $oldenv{'user.linkedenv'};
1.1295    raeburn  17891:                         }
1.1320    raeburn  17892:                         untie(%oldenv);
                   17893:                         if (unlink("$lonids/$filename")) {
                   17894:                             if ($linkedfile =~ /^[a-f0-9]+_linked$/) {
                   17895:                                 if (-l "$lonids/$linkedfile.id") {
                   17896:                                     unlink("$lonids/$linkedfile.id");
                   17897:                                 }
1.1295    raeburn  17898:                             }
                   17899:                         }
                   17900:                     } else {
                   17901:                         unlink($lonids.'/'.$filename);
                   17902:                     }
1.463     albertel 17903: 		}
1.462     albertel 17904: 	    }
1.463     albertel 17905: 	    closedir(DIR);
1.1204    raeburn  17906: # If there is a undeleted lockfile for the user's paste buffer remove it.
                   17907:             my $namespace = 'nohist_courseeditor';
                   17908:             my $lockingkey = 'paste'."\0".'locked_num';
                   17909:             my %lockhash = &Apache::lonnet::get($namespace,[$lockingkey],
                   17910:                                                 $domain,$username);
                   17911:             if (exists($lockhash{$lockingkey})) {
                   17912:                 my $delresult = &Apache::lonnet::del($namespace,[$lockingkey],$domain,$username);
                   17913:                 unless ($delresult eq 'ok') {
                   17914:                     &Apache::lonnet::logthis("Failed to delete paste buffer locking key in $namespace for ".$username.":".$domain." Result was: $delresult");
                   17915:                 }
                   17916:             }
1.462     albertel 17917: 	}
                   17918: # Give them a new cookie
1.463     albertel 17919: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      17920: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 17921: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 17922:     
                   17923: # Initialize roles
                   17924: 
1.1414    raeburn  17925: 	($userroles,$firstaccenv,$timerintenv,$coauthorenv) = 
1.1062    raeburn  17926:             &Apache::lonnet::rolesinit($domain,$username,$authhost);
1.462     albertel 17927:     }
                   17928: # ------------------------------------ Check browser type and MathML capability
                   17929: 
1.1194    raeburn  17930:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,$clientunicode,
                   17931:         $clientos,$clientmobile,$clientinfo,$clientosversion) = &decode_user_agent($r);
1.462     albertel 17932: 
                   17933: # ------------------------------------------------------------- Get environment
                   17934: 
                   17935:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   17936:     my ($tmp) = keys(%userenv);
1.1275    raeburn  17937:     if ($tmp =~ /^(con_lost|error|no_such_host)/i) {
1.462     albertel 17938: 	undef(%userenv);
                   17939:     }
                   17940:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   17941: 	$form->{'interface'}=$userenv{'interface'};
                   17942:     }
                   17943:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   17944: 
                   17945: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   17946:     foreach my $option ('interface','localpath','localres') {
                   17947:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 17948:     }
                   17949: # --------------------------------------------------------- Write first profile
                   17950: 
                   17951:     {
1.1350    raeburn  17952:         my $ip = &Apache::lonnet::get_requestor_ip($r);
1.462     albertel 17953: 	my %initial_env = 
                   17954: 	    ("user.name"          => $username,
                   17955: 	     "user.domain"        => $domain,
                   17956: 	     "user.home"          => $authhost,
                   17957: 	     "browser.type"       => $clientbrowser,
                   17958: 	     "browser.version"    => $clientversion,
                   17959: 	     "browser.mathml"     => $clientmathml,
                   17960: 	     "browser.unicode"    => $clientunicode,
                   17961: 	     "browser.os"         => $clientos,
1.1137    raeburn  17962:              "browser.mobile"     => $clientmobile,
1.1141    raeburn  17963:              "browser.info"       => $clientinfo,
1.1194    raeburn  17964:              "browser.osversion"  => $clientosversion,
1.462     albertel 17965: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   17966: 	     "request.course.fn"  => '',
                   17967: 	     "request.course.uri" => '',
                   17968: 	     "request.course.sec" => '',
                   17969: 	     "request.role"       => 'cm',
                   17970: 	     "request.role.adv"   => $env{'user.adv'},
1.1350    raeburn  17971: 	     "request.host"       => $ip,);
1.462     albertel 17972: 
                   17973:         if ($form->{'localpath'}) {
                   17974: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   17975: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   17976:         }
                   17977: 	
                   17978: 	if ($form->{'interface'}) {
                   17979: 	    $form->{'interface'}=~s/\W//gs;
                   17980: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   17981: 	    $env{'browser.interface'}=$form->{'interface'};
                   17982: 	}
                   17983: 
1.1157    raeburn  17984:         if ($form->{'iptoken'}) {
                   17985:             my $lonhost = $r->dir_config('lonHostID');
                   17986:             $initial_env{"user.noloadbalance"} = $lonhost;
                   17987:             $env{'user.noloadbalance'} = $lonhost;
                   17988:         }
                   17989: 
1.1268    raeburn  17990:         if ($form->{'noloadbalance'}) {
                   17991:             my @hosts = &Apache::lonnet::current_machine_ids();
                   17992:             my $hosthere = $form->{'noloadbalance'};
                   17993:             if (grep(/^\Q$hosthere\E$/,@hosts)) {
                   17994:                 $initial_env{"user.noloadbalance"} = $hosthere;
                   17995:                 $env{'user.noloadbalance'} = $hosthere;
                   17996:             }
                   17997:         }
                   17998: 
1.1016    raeburn  17999:         unless ($domain eq 'public') {
1.1273    raeburn  18000:             my %is_adv = ( is_adv => $env{'user.adv'} );
                   18001:             my %domdef = &Apache::lonnet::get_domain_defaults($domain);
                   18002: 
1.1414    raeburn  18003:             foreach my $tool ('aboutme','blog','webdav','portfolio','portaccess','timezone') {
                   18004:                 $userenv{'availabletools.'.$tool} =
1.1273    raeburn  18005:                     &Apache::lonnet::usertools_access($username,$domain,$tool,'reload',
                   18006:                                                       undef,\%userenv,\%domdef,\%is_adv);
                   18007:             }
1.980     raeburn  18008: 
1.1311    raeburn  18009:             foreach my $crstype ('official','unofficial','community','textbook','placement','lti') {
1.1273    raeburn  18010:                 $userenv{'canrequest.'.$crstype} =
                   18011:                     &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   18012:                                                       'reload','requestcourses',
                   18013:                                                       \%userenv,\%domdef,\%is_adv);
                   18014:             }
1.724     raeburn  18015: 
1.1418    raeburn  18016:             if ((ref($userroles) eq 'HASH') && ($userroles->{'user.author'}) &&
                   18017:                 (exists($userroles->{"user.role.au./$domain/"}))) {
                   18018:                 if ($userenv{'authoreditors'}) {
                   18019:                     $userenv{'editors'} = $userenv{'authoreditors'};
                   18020:                 } elsif ($domdef{'editors'} ne '') {
                   18021:                     $userenv{'editors'} = $domdef{'editors'};
                   18022:                 } else {
                   18023:                     $userenv{'editors'} = 'edit,xml';
                   18024:                 }
                   18025:             }
                   18026: 
1.1273    raeburn  18027:             $userenv{'canrequest.author'} =
                   18028:                 &Apache::lonnet::usertools_access($username,$domain,'requestauthor',
                   18029:                                                   'reload','requestauthor',
1.980     raeburn  18030:                                                   \%userenv,\%domdef,\%is_adv);
1.1273    raeburn  18031:             my %reqauthor = &Apache::lonnet::get('requestauthor',['author_status','author'],
                   18032:                                                  $domain,$username);
                   18033:             my $reqstatus = $reqauthor{'author_status'};
                   18034:             if ($reqstatus eq 'approval' || $reqstatus eq 'approved') { 
                   18035:                 if (ref($reqauthor{'author'}) eq 'HASH') {
                   18036:                     $userenv{'requestauthorqueued'} = $reqstatus.':'.
                   18037:                                                       $reqauthor{'author'}{'timestamp'};
                   18038:                 }
1.1092    raeburn  18039:             }
1.1287    raeburn  18040:             my ($types,$typename) = &course_types();
                   18041:             if (ref($types) eq 'ARRAY') {
                   18042:                 my @options = ('approval','validate','autolimit');
                   18043:                 my $optregex = join('|',@options);
                   18044:                 my (%willtrust,%trustchecked);
                   18045:                 foreach my $type (@{$types}) {
                   18046:                     my $dom_str = $env{'environment.reqcrsotherdom.'.$type};
                   18047:                     if ($dom_str ne '') {
                   18048:                         my $updatedstr = '';
                   18049:                         my @possdomains = split(',',$dom_str);
                   18050:                         foreach my $entry (@possdomains) {
                   18051:                             my ($extdom,$extopt) = split(':',$entry);
                   18052:                             unless ($trustchecked{$extdom}) {
                   18053:                                 $willtrust{$extdom} = &Apache::lonnet::will_trust('reqcrs',$domain,$extdom);
                   18054:                                 $trustchecked{$extdom} = 1;
                   18055:                             }
                   18056:                             if ($willtrust{$extdom}) {
                   18057:                                 $updatedstr .= $entry.',';
                   18058:                             }
                   18059:                         }
                   18060:                         $updatedstr =~ s/,$//;
                   18061:                         if ($updatedstr) {
                   18062:                             $userenv{'reqcrsotherdom.'.$type} = $updatedstr;
                   18063:                         } else {
                   18064:                             delete($userenv{'reqcrsotherdom.'.$type});
                   18065:                         }
                   18066:                     }
                   18067:                 }
                   18068:             }
1.1092    raeburn  18069:         }
1.462     albertel 18070: 	$env{'user.environment'} = "$lonids/$cookie.id";
1.1062    raeburn  18071: 
1.462     albertel 18072: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   18073: 		 &GDBM_WRCREAT(),0640)) {
                   18074: 	    &_add_to_env(\%disk_env,\%initial_env);
                   18075: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   18076: 	    &_add_to_env(\%disk_env,$userroles);
1.1062    raeburn  18077:             if (ref($firstaccenv) eq 'HASH') {
                   18078:                 &_add_to_env(\%disk_env,$firstaccenv);
                   18079:             }
                   18080:             if (ref($timerintenv) eq 'HASH') {
                   18081:                 &_add_to_env(\%disk_env,$timerintenv);
                   18082:             }
1.1414    raeburn  18083:             if (ref($coauthorenv) eq 'HASH') {
                   18084:                 if (keys(%{$coauthorenv})) {
                   18085:                     &_add_to_env(\%disk_env,$coauthorenv);
                   18086:                 }
                   18087:             }
1.463     albertel 18088: 	    if (ref($args->{'extra_env'})) {
                   18089: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   18090: 	    }
1.462     albertel 18091: 	    untie(%disk_env);
                   18092: 	} else {
1.705     tempelho 18093: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   18094: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 18095: 	    return 'error: '.$!;
                   18096: 	}
                   18097:     }
                   18098:     $env{'request.role'}='cm';
                   18099:     $env{'request.role.adv'}=$env{'user.adv'};
                   18100:     $env{'browser.type'}=$clientbrowser;
                   18101: 
                   18102:     return $cookie;
                   18103: 
                   18104: }
                   18105: 
                   18106: sub _add_to_env {
                   18107:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  18108:     if (ref($env_data) eq 'HASH') {
                   18109:         while (my ($key,$value) = each(%$env_data)) {
                   18110: 	    $idf->{$prefix.$key} = $value;
                   18111: 	    $env{$prefix.$key}   = $value;
                   18112:         }
1.462     albertel 18113:     }
                   18114: }
                   18115: 
1.685     tempelho 18116: # --- Get the symbolic name of a problem and the url
                   18117: sub get_symb {
                   18118:     my ($request,$silent) = @_;
1.726     raeburn  18119:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 18120:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   18121:     if ($symb eq '') {
                   18122:         if (!$silent) {
1.1071    raeburn  18123:             if (ref($request)) { 
                   18124:                 $request->print("Unable to handle ambiguous references:$url:.");
                   18125:             }
1.685     tempelho 18126:             return ();
                   18127:         }
                   18128:     }
                   18129:     &Apache::lonenc::check_decrypt(\$symb);
                   18130:     return ($symb);
                   18131: }
                   18132: 
                   18133: # --------------------------------------------------------------Get annotation
                   18134: 
                   18135: sub get_annotation {
                   18136:     my ($symb,$enc) = @_;
                   18137: 
                   18138:     my $key = $symb;
                   18139:     if (!$enc) {
                   18140:         $key =
                   18141:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   18142:     }
                   18143:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   18144:     return $annotation{$key};
                   18145: }
                   18146: 
                   18147: sub clean_symb {
1.731     raeburn  18148:     my ($symb,$delete_enc) = @_;
1.685     tempelho 18149: 
                   18150:     &Apache::lonenc::check_decrypt(\$symb);
                   18151:     my $enc = $env{'request.enc'};
1.731     raeburn  18152:     if ($delete_enc) {
1.730     raeburn  18153:         delete($env{'request.enc'});
                   18154:     }
1.685     tempelho 18155: 
                   18156:     return ($symb,$enc);
                   18157: }
1.462     albertel 18158: 
1.1181    raeburn  18159: ############################################################
                   18160: ############################################################
                   18161: 
                   18162: =pod
                   18163: 
                   18164: =head1 Routines for building display used to search for courses
                   18165: 
                   18166: 
                   18167: =over 4
                   18168: 
                   18169: =item * &build_filters()
                   18170: 
                   18171: Create markup for a table used to set filters to use when selecting
1.1182    raeburn  18172: courses in a domain.  Used by lonpickcourse.pm, lonmodifycourse.pm
                   18173: and quotacheck.pl
                   18174: 
1.1181    raeburn  18175: 
                   18176: Inputs:
                   18177: 
                   18178: filterlist - anonymous array of fields to include as potential filters 
                   18179: 
                   18180: crstype - course type
                   18181: 
                   18182: roleelement - fifth arg in selectcourse_link() populates fifth arg in javascript: opencrsbrowser() function, used
                   18183:               to pop-open a course selector (will contain "extra element"). 
                   18184: 
                   18185: multelement - if multiple course selections will be allowed, this will be a hidden form element: name: multiple; value: 1
                   18186: 
                   18187: filter - anonymous hash of criteria and their values
                   18188: 
                   18189: action - form action
                   18190: 
                   18191: numfiltersref - ref to scalar (count of number of elements in institutional codes -- e.g., 4 for year, semester, department, and number)
                   18192: 
1.1182    raeburn  18193: caller - caller context (e.g., set to 'modifycourse' when routine is called from lonmodifycourse.pm)
1.1181    raeburn  18194: 
                   18195: cloneruname - username of owner of new course who wants to clone
                   18196: 
                   18197: clonerudom - domain of owner of new course who wants to clone
                   18198: 
                   18199: typeelem - text to use for left column in row containing course type (i.e., Course, Community or Course/Community) 
                   18200: 
                   18201: codetitlesref - reference to array of titles of components in institutional codes (official courses)
                   18202: 
                   18203: codedom - domain
                   18204: 
                   18205: formname - value of form element named "form". 
                   18206: 
                   18207: fixeddom - domain, if fixed.
                   18208: 
                   18209: prevphase - value to assign to form element named "phase" when going back to the previous screen  
                   18210: 
                   18211: cnameelement - name of form element in form on opener page which will receive title of selected course 
                   18212: 
                   18213: cnumelement - name of form element in form on opener page which will receive courseID  of selected course
                   18214: 
                   18215: cdomelement - name of form element in form on opener page which will receive domain of selected course
                   18216: 
                   18217: setroles - includes access constraint identifier when setting a roles-based condition for acces to a portfolio file
                   18218: 
                   18219: clonetext - hidden form elements containing list of courses cloneable by intended course owner when DC creates a course
                   18220: 
                   18221: clonewarning - warning message about missing information for intended course owner when DC creates a course
                   18222: 
1.1182    raeburn  18223: 
1.1181    raeburn  18224: Returns: $output - HTML for display of search criteria, and hidden form elements.
                   18225: 
1.1182    raeburn  18226: 
1.1181    raeburn  18227: Side Effects: None
                   18228: 
                   18229: =cut
                   18230: 
                   18231: # ---------------------------------------------- search for courses based on last activity etc.
                   18232: 
                   18233: sub build_filters {
                   18234:     my ($filterlist,$crstype,$roleelement,$multelement,$filter,$action,
                   18235:         $numtitlesref,$caller,$cloneruname,$clonerudom,$typeelement,
                   18236:         $codetitlesref,$codedom,$formname,$fixeddom,$prevphase,
                   18237:         $cnameelement,$cnumelement,$cdomelement,$setroles,
                   18238:         $clonetext,$clonewarning) = @_;
1.1182    raeburn  18239:     my ($list,$jscript);
1.1181    raeburn  18240:     my $onchange = 'javascript:updateFilters(this)';
                   18241:     my ($domainselectform,$sincefilterform,$createdfilterform,
                   18242:         $ownerdomselectform,$persondomselectform,$instcodeform,
                   18243:         $typeselectform,$instcodetitle);
                   18244:     if ($formname eq '') {
                   18245:         $formname = $caller;
                   18246:     }
                   18247:     foreach my $item (@{$filterlist}) {
                   18248:         unless (($item eq 'descriptfilter') || ($item eq 'instcodefilter') ||
                   18249:                 ($item eq 'sincefilter') || ($item eq 'createdfilter')) {
                   18250:             if ($item eq 'domainfilter') {
                   18251:                 $filter->{$item} = &LONCAPA::clean_domain($filter->{$item});
                   18252:             } elsif ($item eq 'coursefilter') {
                   18253:                 $filter->{$item} = &LONCAPA::clean_courseid($filter->{$item});
                   18254:             } elsif ($item eq 'ownerfilter') {
                   18255:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   18256:             } elsif ($item eq 'ownerdomfilter') {
                   18257:                 $filter->{'ownerdomfilter'} =
                   18258:                     &LONCAPA::clean_domain($filter->{$item});
                   18259:                 $ownerdomselectform = &select_dom_form($filter->{'ownerdomfilter'},
                   18260:                                                        'ownerdomfilter',1);
                   18261:             } elsif ($item eq 'personfilter') {
                   18262:                 $filter->{$item} = &LONCAPA::clean_username($filter->{$item});
                   18263:             } elsif ($item eq 'persondomfilter') {
                   18264:                 $persondomselectform = &select_dom_form($filter->{'persondomfilter'},
                   18265:                                                         'persondomfilter',1);
                   18266:             } else {
                   18267:                 $filter->{$item} =~ s/\W//g;
                   18268:             }
                   18269:             if (!$filter->{$item}) {
                   18270:                 $filter->{$item} = '';
                   18271:             }
                   18272:         }
                   18273:         if ($item eq 'domainfilter') {
                   18274:             my $allow_blank = 1;
                   18275:             if ($formname eq 'portform') {
                   18276:                 $allow_blank=0;
                   18277:             } elsif ($formname eq 'studentform') {
                   18278:                 $allow_blank=0;
                   18279:             }
                   18280:             if ($fixeddom) {
                   18281:                 $domainselectform = '<input type="hidden" name="domainfilter"'.
                   18282:                                     ' value="'.$codedom.'" />'.
                   18283:                                     &Apache::lonnet::domain($codedom,'description');
                   18284:             } else {
                   18285:                 $domainselectform = &select_dom_form($filter->{$item},
                   18286:                                                      'domainfilter',
                   18287:                                                       $allow_blank,'',$onchange);
                   18288:             }
                   18289:         } else {
                   18290:             $list->{$item} = &HTML::Entities::encode($filter->{$item},'<>&"');
                   18291:         }
                   18292:     }
                   18293: 
                   18294:     # last course activity filter and selection
                   18295:     $sincefilterform = &timebased_select_form('sincefilter',$filter);
                   18296: 
                   18297:     # course created filter and selection
                   18298:     if (exists($filter->{'createdfilter'})) {
                   18299:         $createdfilterform = &timebased_select_form('createdfilter',$filter);
                   18300:     }
                   18301: 
1.1239    raeburn  18302:     my $prefix = $crstype;
                   18303:     if ($crstype eq 'Placement') {
                   18304:         $prefix = 'Placement Test'
                   18305:     }
1.1181    raeburn  18306:     my %lt = &Apache::lonlocal::texthash(
1.1239    raeburn  18307:                 'cac' => "$prefix Activity",
                   18308:                 'ccr' => "$prefix Created",
                   18309:                 'cde' => "$prefix Title",
                   18310:                 'cdo' => "$prefix Domain",
1.1181    raeburn  18311:                 'ins' => 'Institutional Code',
                   18312:                 'inc' => 'Institutional Categorization',
1.1239    raeburn  18313:                 'cow' => "$prefix Owner/Co-owner",
                   18314:                 'cop' => "$prefix Personnel Includes",
1.1181    raeburn  18315:                 'cog' => 'Type',
                   18316:              );
                   18317: 
                   18318:     if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   18319:         my $typeval = 'Course';
                   18320:         if ($crstype eq 'Community') {
                   18321:             $typeval = 'Community';
1.1239    raeburn  18322:         } elsif ($crstype eq 'Placement') {
                   18323:             $typeval = 'Placement';
1.1181    raeburn  18324:         }
                   18325:         $typeselectform = '<input type="hidden" name="type" value="'.$typeval.'" />';
                   18326:     } else {
                   18327:         $typeselectform =  '<select name="type" size="1"';
                   18328:         if ($onchange) {
                   18329:             $typeselectform .= ' onchange="'.$onchange.'"';
                   18330:         }
                   18331:         $typeselectform .= '>'."\n";
1.1237    raeburn  18332:         foreach my $posstype ('Course','Community','Placement') {
1.1239    raeburn  18333:             my $shown;
                   18334:             if ($posstype eq 'Placement') {
                   18335:                 $shown = &mt('Placement Test');
                   18336:             } else {
                   18337:                 $shown = &mt($posstype);
                   18338:             }
1.1181    raeburn  18339:             $typeselectform.='<option value="'.$posstype.'"'.
1.1239    raeburn  18340:                 ($posstype eq $crstype ? ' selected="selected" ' : ''). ">".$shown."</option>\n";
1.1181    raeburn  18341:         }
                   18342:         $typeselectform.="</select>";
                   18343:     }
                   18344: 
                   18345:     my ($cloneableonlyform,$cloneabletitle);
                   18346:     if (exists($filter->{'cloneableonly'})) {
                   18347:         my $cloneableon = '';
                   18348:         my $cloneableoff = ' checked="checked"';
                   18349:         if ($filter->{'cloneableonly'}) {
                   18350:             $cloneableon = $cloneableoff;
                   18351:             $cloneableoff = '';
                   18352:         }
                   18353:         $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>';
                   18354:         if ($formname eq 'ccrs') {
1.1187    bisitz   18355:             $cloneabletitle = &mt('Cloneable for [_1]',$cloneruname.':'.$clonerudom);
1.1181    raeburn  18356:         } else {
                   18357:             $cloneabletitle = &mt('Cloneable by you');
                   18358:         }
                   18359:     }
                   18360:     my $officialjs;
                   18361:     if ($crstype eq 'Course') {
                   18362:         if (exists($filter->{'instcodefilter'})) {
1.1182    raeburn  18363: #            if (($fixeddom) || ($formname eq 'requestcrs') ||
                   18364: #                ($formname eq 'modifycourse') || ($formname eq 'filterpicker')) {
                   18365:             if ($codedom) { 
1.1181    raeburn  18366:                 $officialjs = 1;
                   18367:                 ($instcodeform,$jscript,$$numtitlesref) =
                   18368:                     &Apache::courseclassifier::instcode_selectors($codedom,'filterpicker',
                   18369:                                                                   $officialjs,$codetitlesref);
                   18370:                 if ($jscript) {
1.1182    raeburn  18371:                     $jscript = '<script type="text/javascript">'."\n".
                   18372:                                '// <![CDATA['."\n".
                   18373:                                $jscript."\n".
                   18374:                                '// ]]>'."\n".
                   18375:                                '</script>'."\n";
1.1181    raeburn  18376:                 }
                   18377:             }
                   18378:             if ($instcodeform eq '') {
                   18379:                 $instcodeform =
                   18380:                     '<input type="text" name="instcodefilter" size="10" value="'.
                   18381:                     $list->{'instcodefilter'}.'" />';
                   18382:                 $instcodetitle = $lt{'ins'};
                   18383:             } else {
                   18384:                 $instcodetitle = $lt{'inc'};
                   18385:             }
                   18386:             if ($fixeddom) {
                   18387:                 $instcodetitle .= '<br />('.$codedom.')';
                   18388:             }
                   18389:         }
                   18390:     }
                   18391:     my $output = qq|
                   18392: <form method="post" name="filterpicker" action="$action">
                   18393: <input type="hidden" name="form" value="$formname" />
                   18394: |;
                   18395:     if ($formname eq 'modifycourse') {
                   18396:         $output .= '<input type="hidden" name="phase" value="courselist" />'."\n".
                   18397:                    '<input type="hidden" name="prevphase" value="'.
                   18398:                    $prevphase.'" />'."\n";
1.1198    musolffc 18399:     } elsif ($formname eq 'quotacheck') {
                   18400:         $output .= qq|
                   18401: <input type="hidden" name="sortby" value="" />
                   18402: <input type="hidden" name="sortorder" value="" />
                   18403: |;
                   18404:     } else {
1.1181    raeburn  18405:         my $name_input;
                   18406:         if ($cnameelement ne '') {
                   18407:             $name_input = '<input type="hidden" name="cnameelement" value="'.
                   18408:                           $cnameelement.'" />';
                   18409:         }
                   18410:         $output .= qq|
1.1182    raeburn  18411: <input type="hidden" name="cnumelement" value="$cnumelement" />
                   18412: <input type="hidden" name="cdomelement" value="$cdomelement" />
1.1181    raeburn  18413: $name_input
                   18414: $roleelement
                   18415: $multelement
                   18416: $typeelement
                   18417: |;
                   18418:         if ($formname eq 'portform') {
                   18419:             $output .= '<input type="hidden" name="setroles" value="'.$setroles.'" />'."\n";
                   18420:         }
                   18421:     }
                   18422:     if ($fixeddom) {
                   18423:         $output .= '<input type="hidden" name="fixeddom" value="'.$fixeddom.'" />'."\n";
                   18424:     }
                   18425:     $output .= "<br />\n".&Apache::lonhtmlcommon::start_pick_box();
                   18426:     if ($sincefilterform) {
                   18427:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cac'})
                   18428:                   .$sincefilterform
                   18429:                   .&Apache::lonhtmlcommon::row_closure();
                   18430:     }
                   18431:     if ($createdfilterform) {
                   18432:         $output .= &Apache::lonhtmlcommon::row_title($lt{'ccr'})
                   18433:                   .$createdfilterform
                   18434:                   .&Apache::lonhtmlcommon::row_closure();
                   18435:     }
                   18436:     if ($domainselectform) {
                   18437:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cdo'})
                   18438:                   .$domainselectform
                   18439:                   .&Apache::lonhtmlcommon::row_closure();
                   18440:     }
                   18441:     if ($typeselectform) {
                   18442:         if (($formname eq 'ccrs') || ($formname eq 'requestcrs')) {
                   18443:             $output .= $typeselectform;
                   18444:         } else {
                   18445:             $output .= &Apache::lonhtmlcommon::row_title($lt{'cog'})
                   18446:                       .$typeselectform
                   18447:                       .&Apache::lonhtmlcommon::row_closure();
                   18448:         }
                   18449:     }
                   18450:     if ($instcodeform) {
                   18451:         $output .= &Apache::lonhtmlcommon::row_title($instcodetitle)
                   18452:                   .$instcodeform
                   18453:                   .&Apache::lonhtmlcommon::row_closure();
                   18454:     }
                   18455:     if (exists($filter->{'ownerfilter'})) {
                   18456:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cow'}).
                   18457:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   18458:                    '<input type="text" name="ownerfilter" size="20" value="'.
                   18459:                    $list->{'ownerfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   18460:                    $ownerdomselectform.'</td></tr></table>'.
                   18461:                    &Apache::lonhtmlcommon::row_closure();
                   18462:     }
                   18463:     if (exists($filter->{'personfilter'})) {
                   18464:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cop'}).
                   18465:                    '<table><tr><td>'.&mt('Username').'<br />'.
                   18466:                    '<input type="text" name="personfilter" size="20" value="'.
                   18467:                    $list->{'personfilter'}.'" /></td><td>'.&mt('Domain').'<br />'.
                   18468:                    $persondomselectform.'</td></tr></table>'.
                   18469:                    &Apache::lonhtmlcommon::row_closure();
                   18470:     }
                   18471:     if (exists($filter->{'coursefilter'})) {
                   18472:         $output .= &Apache::lonhtmlcommon::row_title(&mt('LON-CAPA course ID'))
                   18473:                   .'<input type="text" name="coursefilter" size="25" value="'
                   18474:                   .$list->{'coursefilter'}.'" />'
                   18475:                   .&Apache::lonhtmlcommon::row_closure();
                   18476:     }
                   18477:     if ($cloneableonlyform) {
                   18478:         $output .= &Apache::lonhtmlcommon::row_title($cloneabletitle).
                   18479:                    $cloneableonlyform.&Apache::lonhtmlcommon::row_closure();
                   18480:     }
                   18481:     if (exists($filter->{'descriptfilter'})) {
                   18482:         $output .= &Apache::lonhtmlcommon::row_title($lt{'cde'})
                   18483:                   .'<input type="text" name="descriptfilter" size="40" value="'
                   18484:                   .$list->{'descriptfilter'}.'" />'
                   18485:                   .&Apache::lonhtmlcommon::row_closure(1);
                   18486:     }
                   18487:     $output .= &Apache::lonhtmlcommon::end_pick_box().'<p>'.$clonetext."\n".
                   18488:                '<input type="hidden" name="updater" value="" />'."\n".
                   18489:                '<input type="submit" name="gosearch" value="'.
                   18490:                &mt('Search').'" /></p>'."\n".'</form>'."\n".'<hr />'."\n";
                   18491:     return $jscript.$clonewarning.$output;
                   18492: }
                   18493: 
                   18494: =pod 
                   18495: 
                   18496: =item * &timebased_select_form()
                   18497: 
1.1182    raeburn  18498: Create markup for a dropdown list used to select a time-based
1.1181    raeburn  18499: filter e.g., Course Activity, Course Created, when searching for courses
                   18500: or communities
                   18501: 
                   18502: Inputs:
                   18503: 
                   18504: item - name of form element (sincefilter or createdfilter)
                   18505: 
                   18506: filter - anonymous hash of criteria and their values
                   18507: 
                   18508: Returns: HTML for a select box contained a blank, then six time selections,
                   18509:          with value set in incoming form variables currently selected. 
                   18510: 
                   18511: Side Effects: None
                   18512: 
                   18513: =cut
                   18514: 
                   18515: sub timebased_select_form {
                   18516:     my ($item,$filter) = @_;
                   18517:     if (ref($filter) eq 'HASH') {
                   18518:         $filter->{$item} =~ s/[^\d-]//g;
                   18519:         if (!$filter->{$item}) { $filter->{$item}=-1; }
                   18520:         return &select_form(
                   18521:                             $filter->{$item},
                   18522:                             $item,
                   18523:                             {      '-1' => '',
                   18524:                                 '86400' => &mt('today'),
                   18525:                                '604800' => &mt('last week'),
                   18526:                               '2592000' => &mt('last month'),
                   18527:                               '7776000' => &mt('last three months'),
                   18528:                              '15552000' => &mt('last six months'),
                   18529:                              '31104000' => &mt('last year'),
                   18530:                     'select_form_order' =>
                   18531:                            ['-1','86400','604800','2592000','7776000',
                   18532:                             '15552000','31104000']});
                   18533:     }
                   18534: }
                   18535: 
                   18536: =pod
                   18537: 
                   18538: =item * &js_changer()
                   18539: 
                   18540: Create script tag containing Javascript used to submit course search form
1.1183    raeburn  18541: when course type or domain is changed, and also to hide 'Searching ...' on
                   18542: page load completion for page showing search result.
1.1181    raeburn  18543: 
                   18544: Inputs: None
                   18545: 
1.1183    raeburn  18546: Returns: markup containing updateFilters() and hideSearching() javascript functions. 
1.1181    raeburn  18547: 
                   18548: Side Effects: None
                   18549: 
                   18550: =cut
                   18551: 
                   18552: sub js_changer {
                   18553:     return <<ENDJS;
                   18554: <script type="text/javascript">
                   18555: // <![CDATA[
                   18556: function updateFilters(caller) {
                   18557:     if (typeof(caller) != "undefined") {
                   18558:         document.filterpicker.updater.value = caller.name;
                   18559:     }
                   18560:     document.filterpicker.submit();
                   18561: }
1.1183    raeburn  18562: 
                   18563: function hideSearching() {
                   18564:     if (document.getElementById('searching')) {
                   18565:         document.getElementById('searching').style.display = 'none';
                   18566:     }
                   18567:     return;
                   18568: }
                   18569: 
1.1181    raeburn  18570: // ]]>
                   18571: </script>
                   18572: 
                   18573: ENDJS
                   18574: }
                   18575: 
                   18576: =pod
                   18577: 
1.1182    raeburn  18578: =item * &search_courses()
                   18579: 
                   18580: Process selected filters form course search form and pass to lonnet::courseiddump
                   18581: to retrieve a hash for which keys are courseIDs which match the selected filters.
                   18582: 
                   18583: Inputs:
                   18584: 
                   18585: dom - domain being searched 
                   18586: 
                   18587: type - course type ('Course' or 'Community' or '.' if any).
                   18588: 
                   18589: filter - anonymous hash of criteria and their values
                   18590: 
                   18591: numtitles - for institutional codes - number of categories
                   18592: 
                   18593: cloneruname - optional username of new course owner
                   18594: 
                   18595: clonerudom - optional domain of new course owner
                   18596: 
1.1221    raeburn  18597: domcloner - optional "domcloner" flag; has value=1 if user has ccc priv in domain being filtered by, 
1.1182    raeburn  18598:             (used when DC is using course creation form)
                   18599: 
                   18600: codetitles - reference to array of titles of components in institutional codes (official courses).
                   18601: 
1.1221    raeburn  18602: cc_clone - escaped comma separated list of courses for which course cloner has active CC role
                   18603:            (and so can clone automatically)
                   18604: 
                   18605: reqcrsdom - domain of new course, where search_courses is used to identify potential courses to clone
                   18606: 
                   18607: reqinstcode - institutional code of new course, where search_courses is used to identify potential 
                   18608:               courses to clone 
1.1182    raeburn  18609: 
                   18610: Returns: %courses - hash of courses satisfying search criteria, keys = course IDs, values are corresponding colon-separated escaped description, institutional code, owner and type.
                   18611: 
                   18612: 
                   18613: Side Effects: None
                   18614: 
                   18615: =cut
                   18616: 
                   18617: 
                   18618: sub search_courses {
1.1221    raeburn  18619:     my ($dom,$type,$filter,$numtitles,$cloneruname,$clonerudom,$domcloner,$codetitles,
                   18620:         $cc_clone,$reqcrsdom,$reqinstcode) = @_;
1.1182    raeburn  18621:     my (%courses,%showcourses,$cloner);
                   18622:     if (($filter->{'ownerfilter'} ne '') ||
                   18623:         ($filter->{'ownerdomfilter'} ne '')) {
                   18624:         $filter->{'combownerfilter'} = $filter->{'ownerfilter'}.':'.
                   18625:                                        $filter->{'ownerdomfilter'};
                   18626:     }
                   18627:     foreach my $item ('descriptfilter','coursefilter','combownerfilter') {
                   18628:         if (!$filter->{$item}) {
                   18629:             $filter->{$item}='.';
                   18630:         }
                   18631:     }
                   18632:     my $now = time;
                   18633:     my $timefilter =
                   18634:        ($filter->{'sincefilter'}==-1?1:$now-$filter->{'sincefilter'});
                   18635:     my ($createdbefore,$createdafter);
                   18636:     if (($filter->{'createdfilter'} ne '') && ($filter->{'createdfilter'} !=-1)) {
                   18637:         $createdbefore = $now;
                   18638:         $createdafter = $now-$filter->{'createdfilter'};
                   18639:     }
                   18640:     my ($instcodefilter,$regexpok);
                   18641:     if ($numtitles) {
                   18642:         if ($env{'form.official'} eq 'on') {
                   18643:             $instcodefilter =
                   18644:                 &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   18645:             $regexpok = 1;
                   18646:         } elsif ($env{'form.official'} eq 'off') {
                   18647:             $instcodefilter = &Apache::courseclassifier::instcode_search_str($dom,$numtitles,$codetitles);
                   18648:             unless ($instcodefilter eq '') {
                   18649:                 $regexpok = -1;
                   18650:             }
                   18651:         }
                   18652:     } else {
                   18653:         $instcodefilter = $filter->{'instcodefilter'};
                   18654:     }
                   18655:     if ($instcodefilter eq '') { $instcodefilter = '.'; }
                   18656:     if ($type eq '') { $type = '.'; }
                   18657: 
                   18658:     if (($clonerudom ne '') && ($cloneruname ne '')) {
                   18659:         $cloner = $cloneruname.':'.$clonerudom;
                   18660:     }
                   18661:     %courses = &Apache::lonnet::courseiddump($dom,
                   18662:                                              $filter->{'descriptfilter'},
                   18663:                                              $timefilter,
                   18664:                                              $instcodefilter,
                   18665:                                              $filter->{'combownerfilter'},
                   18666:                                              $filter->{'coursefilter'},
                   18667:                                              undef,undef,$type,$regexpok,undef,undef,
1.1221    raeburn  18668:                                              undef,undef,$cloner,$cc_clone,
1.1182    raeburn  18669:                                              $filter->{'cloneableonly'},
                   18670:                                              $createdbefore,$createdafter,undef,
1.1221    raeburn  18671:                                              $domcloner,undef,$reqcrsdom,$reqinstcode);
1.1182    raeburn  18672:     if (($filter->{'personfilter'} ne '') && ($filter->{'persondomfilter'} ne '')) {
                   18673:         my $ccrole;
                   18674:         if ($type eq 'Community') {
                   18675:             $ccrole = 'co';
                   18676:         } else {
                   18677:             $ccrole = 'cc';
                   18678:         }
                   18679:         my %rolehash = &Apache::lonnet::get_my_roles($filter->{'personfilter'},
                   18680:                                                      $filter->{'persondomfilter'},
                   18681:                                                      'userroles',undef,
                   18682:                                                      [$ccrole,'in','ad','ep','ta','cr'],
                   18683:                                                      $dom);
                   18684:         foreach my $role (keys(%rolehash)) {
                   18685:             my ($cnum,$cdom,$courserole) = split(':',$role);
                   18686:             my $cid = $cdom.'_'.$cnum;
                   18687:             if (exists($courses{$cid})) {
                   18688:                 if (ref($courses{$cid}) eq 'HASH') {
                   18689:                     if (ref($courses{$cid}{roles}) eq 'ARRAY') {
                   18690:                         if (!grep(/^\Q$courserole\E$/,@{$courses{$cid}{roles}})) {
1.1263    raeburn  18691:                             push(@{$courses{$cid}{roles}},$courserole);
1.1182    raeburn  18692:                         }
                   18693:                     } else {
                   18694:                         $courses{$cid}{roles} = [$courserole];
                   18695:                     }
                   18696:                     $showcourses{$cid} = $courses{$cid};
                   18697:                 }
                   18698:             }
                   18699:         }
                   18700:         %courses = %showcourses;
                   18701:     }
                   18702:     return %courses;
                   18703: }
                   18704: 
                   18705: =pod
                   18706: 
1.1181    raeburn  18707: =back
                   18708: 
1.1207    raeburn  18709: =head1 Routines for version requirements for current course.
                   18710: 
                   18711: =over 4
                   18712: 
                   18713: =item * &check_release_required()
                   18714: 
                   18715: Compares required LON-CAPA version with version on server, and
                   18716: if required version is newer looks for a server with the required version.
                   18717: 
                   18718: Looks first at servers in user's owen domain; if none suitable, looks at
                   18719: servers in course's domain are permitted to host sessions for user's domain.
                   18720: 
                   18721: Inputs:
                   18722: 
                   18723: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   18724: 
                   18725: $courseid - Course ID of current course
                   18726: 
                   18727: $rolecode - User's current role in course (for switchserver query string).
                   18728: 
                   18729: $required - LON-CAPA version needed by course (format: Major.Minor).
                   18730: 
                   18731: 
                   18732: Returns:
                   18733: 
                   18734: $switchserver - query string tp append to /adm/switchserver call (if 
                   18735:                 current server's LON-CAPA version is too old. 
                   18736: 
                   18737: $warning - Message is displayed if no suitable server could be found.
                   18738: 
                   18739: =cut
                   18740: 
                   18741: sub check_release_required {
                   18742:     my ($loncaparev,$courseid,$rolecode,$required) = @_;
                   18743:     my ($switchserver,$warning);
                   18744:     if ($required ne '') {
                   18745:         my ($reqdmajor,$reqdminor) = ($required =~ /^(\d+)\.(\d+)$/);
                   18746:         my ($major,$minor) = ($loncaparev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   18747:         if ($reqdmajor ne '' && $reqdminor ne '') {
                   18748:             my $otherserver;
                   18749:             if (($major eq '' && $minor eq '') ||
                   18750:                 (($reqdmajor > $major) || (($reqdmajor == $major) && ($reqdminor > $minor)))) {
                   18751:                 my ($userdomserver) = &Apache::lonnet::choose_server($env{'user.domain'},undef,$required,1);
                   18752:                 my $switchlcrev =
                   18753:                     &Apache::lonnet::get_server_loncaparev($env{'user.domain'},
                   18754:                                                            $userdomserver);
                   18755:                 my ($swmajor,$swminor) = ($switchlcrev =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?$/);
                   18756:                 if (($swmajor eq '' && $swminor eq '') || ($reqdmajor > $swmajor) ||
                   18757:                     (($reqdmajor == $swmajor) && ($reqdminor > $swminor))) {
                   18758:                     my $cdom = $env{'course.'.$courseid.'.domain'};
                   18759:                     if ($cdom ne $env{'user.domain'}) {
                   18760:                         my ($coursedomserver,$coursehostname) = &Apache::lonnet::choose_server($cdom,undef,$required,1);
                   18761:                         my $serverhomeID = &Apache::lonnet::get_server_homeID($coursehostname);
                   18762:                         my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
                   18763:                         my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
                   18764:                         my %udomdefaults = &Apache::lonnet::get_domain_defaults($env{'user.domain'});
                   18765:                         my $remoterev = &Apache::lonnet::get_server_loncaparev($serverhomedom,$coursedomserver);
                   18766:                         my $canhost =
                   18767:                             &Apache::lonnet::can_host_session($env{'user.domain'},
                   18768:                                                               $coursedomserver,
                   18769:                                                               $remoterev,
                   18770:                                                               $udomdefaults{'remotesessions'},
                   18771:                                                               $defdomdefaults{'hostedsessions'});
                   18772: 
                   18773:                         if ($canhost) {
                   18774:                             $otherserver = $coursedomserver;
                   18775:                         } else {
                   18776:                             $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.");
                   18777:                         }
                   18778:                     } else {
                   18779:                         $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).");
                   18780:                     }
                   18781:                 } else {
                   18782:                     $otherserver = $userdomserver;
                   18783:                 }
                   18784:             }
                   18785:             if ($otherserver ne '') {
                   18786:                 $switchserver = 'otherserver='.$otherserver.'&amp;role='.$rolecode;
                   18787:             }
                   18788:         }
                   18789:     }
                   18790:     return ($switchserver,$warning);
                   18791: }
                   18792: 
                   18793: =pod
                   18794: 
                   18795: =item * &check_release_result()
                   18796: 
                   18797: Inputs:
                   18798: 
                   18799: $switchwarning - Warning message if no suitable server found to host session.
                   18800: 
                   18801: $switchserver - query string to append to /adm/switchserver containing lonHostID
                   18802:                 and current role.
                   18803: 
                   18804: Returns: HTML to display with information about requirement to switch server.
                   18805:          Either displaying warning with link to Roles/Courses screen or
                   18806:          display link to switchserver.
                   18807: 
1.1181    raeburn  18808: =cut
                   18809: 
1.1207    raeburn  18810: sub check_release_result {
                   18811:     my ($switchwarning,$switchserver) = @_;
                   18812:     my $output = &start_page('Selected course unavailable on this server').
                   18813:                  '<p class="LC_warning">';
                   18814:     if ($switchwarning) {
                   18815:         $output .= $switchwarning.'<br /><a href="/adm/roles">';
                   18816:         if (&show_course()) {
                   18817:             $output .= &mt('Display courses');
                   18818:         } else {
                   18819:             $output .= &mt('Display roles');
                   18820:         }
                   18821:         $output .= '</a>';
                   18822:     } elsif ($switchserver) {
                   18823:         $output .= &mt('This course requires a newer version of LON-CAPA than is installed on this server.').
                   18824:                    '<br />'.
                   18825:                    '<a href="/adm/switchserver?'.$switchserver.'">'.
                   18826:                    &mt('Switch Server').
                   18827:                    '</a>';
                   18828:     }
                   18829:     $output .= '</p>'.&end_page();
                   18830:     return $output;
                   18831: }
                   18832: 
                   18833: =pod
                   18834: 
                   18835: =item * &needs_coursereinit()
                   18836: 
                   18837: Determine if course contents stored for user's session needs to be
                   18838: refreshed, because content has changed since "Big Hash" last tied.
                   18839: 
                   18840: Check for change is made if time last checked is more than 10 minutes ago
                   18841: (by default).
                   18842: 
                   18843: Inputs:
                   18844: 
                   18845: $loncaparev - Version on current server (format: Major.Minor.Subrelease-datestamp)
                   18846: 
                   18847: $interval (optional) - Time which may elapse (in s) between last check for content
                   18848:                        change in current course. (default: 600 s).  
                   18849: 
                   18850: Returns: an array; first element is:
                   18851: 
                   18852: =over 4
                   18853: 
                   18854: 'switch' - if content updates mean user's session
                   18855:            needs to be switched to a server running a newer LON-CAPA version
                   18856:  
                   18857: 'update' - if course session needs to be refreshed (i.e., Big Hash needs to be reloaded)
                   18858:            on current server hosting user's session                
                   18859: 
                   18860: ''       - if no action required.
                   18861: 
                   18862: =back
                   18863: 
                   18864: If first item element is 'switch':
                   18865: 
                   18866: second item is $switchwarning - Warning message if no suitable server found to host session. 
                   18867: 
                   18868: third item is $switchserver - query string to append to /adm/switchserver containing lonHostID
                   18869:                               and current role. 
                   18870: 
                   18871: otherwise: no other elements returned.
                   18872: 
                   18873: =back
                   18874: 
                   18875: =cut
                   18876: 
                   18877: sub needs_coursereinit {
                   18878:     my ($loncaparev,$interval) = @_;
                   18879:     return() unless ($env{'request.course.id'} && $env{'request.course.tied'});
                   18880:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   18881:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                   18882:     my $now = time;
                   18883:     if ($interval eq '') {
                   18884:         $interval = 600;
                   18885:     }
                   18886:     if (($now-$env{'request.course.timechecked'})>$interval) {
1.1282    raeburn  18887:         &Apache::lonnet::appenv({'request.course.timechecked'=>$now});
1.1372    raeburn  18888:         my $blocked = &blocking_status('reinit',undef,$cnum,$cdom,undef,1);
1.1282    raeburn  18889:         if ($blocked) {
                   18890:             return ();
                   18891:         }
1.1391    raeburn  18892:         my $update;
                   18893:         my $lastmainchange = &Apache::lonnet::get_coursechange($cdom,$cnum);
                   18894:         my $lastsuppchange = &Apache::lonnet::get_suppchange($cdom,$cnum);
                   18895:         if ($lastmainchange > $env{'request.course.tied'}) {
                   18896:             my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
                   18897:             if ($needswitch) {
                   18898:                 return ('switch',$switchwarning,$switchserver);
                   18899:             }
                   18900:             $update = 'main';
                   18901:         }
                   18902:         if ($lastsuppchange > $env{'request.course.suppupdated'}) {
                   18903:             if ($update) {
                   18904:                 $update = 'both';
                   18905:             } else {
                   18906:                 my ($needswitch,$switchwarning,$switchserver) = &switch_for_update($loncaparev,$cdom,$cnum);
                   18907:                 if ($needswitch) {
                   18908:                     return ('switch',$switchwarning,$switchserver);
                   18909:                 } else {
                   18910:                     $update = 'supp';
1.1207    raeburn  18911:                 }
                   18912:             }
1.1391    raeburn  18913:             return ($update);
                   18914:         }
                   18915:     }
                   18916:     return ();
                   18917: }
                   18918: 
                   18919: sub switch_for_update {
                   18920:     my ($loncaparev,$cdom,$cnum) = @_;
                   18921:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   18922:     if ($curr_reqd_hash{'internal.releaserequired'} ne '') {
                   18923:         my $required = $env{'course.'.$cdom.'_'.$cnum.'.internal.releaserequired'};
                   18924:         if ($curr_reqd_hash{'internal.releaserequired'} ne $required) {
                   18925:             &Apache::lonnet::appenv({'course.'.$cdom.'_'.$cnum.'.internal.releaserequired' =>
                   18926:                                     $curr_reqd_hash{'internal.releaserequired'}});
                   18927:             my ($switchserver,$switchwarning) =
                   18928:                 &check_release_required($loncaparev,$cdom.'_'.$cnum,$env{'request.role'},
                   18929:                                         $curr_reqd_hash{'internal.releaserequired'});
                   18930:             if ($switchwarning ne '' || $switchserver ne '') {
                   18931:                 return ('switch',$switchwarning,$switchserver);
                   18932:             }
1.1207    raeburn  18933:         }
                   18934:     }
                   18935:     return ();
                   18936: }
1.1181    raeburn  18937: 
1.1083    raeburn  18938: sub update_content_constraints {
1.1395    raeburn  18939:     my ($cdom,$cnum,$chome,$cid) = @_;
1.1083    raeburn  18940:     my %curr_reqd_hash = &Apache::lonnet::userenvironment($cdom,$cnum,'internal.releaserequired');
                   18941:     my ($reqdmajor,$reqdminor) = split(/\./,$curr_reqd_hash{'internal.releaserequired'});
1.1307    raeburn  18942:     my (%checkresponsetypes,%checkcrsrestypes);
1.1083    raeburn  18943:     foreach my $key (keys(%Apache::lonnet::needsrelease)) {
1.1236    raeburn  18944:         my ($item,$name,$value) = split(/:/,$key);
1.1083    raeburn  18945:         if ($item eq 'resourcetag') {
                   18946:             if ($name eq 'responsetype') {
                   18947:                 $checkresponsetypes{$value} = $Apache::lonnet::needsrelease{$key}
                   18948:             }
1.1307    raeburn  18949:         } elsif ($item eq 'course') {
                   18950:             if ($name eq 'courserestype') {
                   18951:                 $checkcrsrestypes{$value} = $Apache::lonnet::needsrelease{$key};
                   18952:             }
1.1083    raeburn  18953:         }
                   18954:     }
                   18955:     my $navmap = Apache::lonnavmaps::navmap->new();
                   18956:     if (defined($navmap)) {
1.1307    raeburn  18957:         my (%allresponses,%allcrsrestypes);
                   18958:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0)) {
                   18959:             if ($res->is_tool()) {
                   18960:                 if ($allcrsrestypes{'exttool'}) {
                   18961:                     $allcrsrestypes{'exttool'} ++;
                   18962:                 } else {
                   18963:                     $allcrsrestypes{'exttool'} = 1;
                   18964:                 }
                   18965:                 next;
                   18966:             }
1.1083    raeburn  18967:             my %responses = $res->responseTypes();
                   18968:             foreach my $key (keys(%responses)) {
                   18969:                 next unless(exists($checkresponsetypes{$key}));
                   18970:                 $allresponses{$key} += $responses{$key};
                   18971:             }
                   18972:         }
                   18973:         foreach my $key (keys(%allresponses)) {
                   18974:             my ($major,$minor) = split(/\./,$checkresponsetypes{$key});
                   18975:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   18976:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   18977:             }
                   18978:         }
1.1307    raeburn  18979:         foreach my $key (keys(%allcrsrestypes)) {
1.1308    raeburn  18980:             my ($major,$minor) = split(/\./,$checkcrsrestypes{$key});
1.1307    raeburn  18981:             if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   18982:                 ($reqdmajor,$reqdminor) = ($major,$minor);
                   18983:             }
                   18984:         }
1.1083    raeburn  18985:         undef($navmap);
                   18986:     }
1.1391    raeburn  18987:     if (&Apache::lonnet::count_supptools($cnum,$cdom,1)) {
1.1308    raeburn  18988:         my ($major,$minor) = split(/\./,$checkcrsrestypes{'exttool'});
                   18989:         if (($major > $reqdmajor) || ($major == $reqdmajor && $minor > $reqdminor)) {
                   18990:             ($reqdmajor,$reqdminor) = ($major,$minor);
                   18991:         }
                   18992:     }
1.1083    raeburn  18993:     unless (($reqdmajor eq '') && ($reqdminor eq '')) {
                   18994:         &Apache::lonnet::update_released_required($reqdmajor.'.'.$reqdminor,$cdom,$cnum,$chome,$cid);
                   18995:     }
                   18996:     return;
                   18997: }
                   18998: 
1.1110    raeburn  18999: sub allmaps_incourse {
                   19000:     my ($cdom,$cnum,$chome,$cid) = @_;
                   19001:     if ($cdom eq '' || $cnum eq '' || $chome eq '' || $cid eq '') {
                   19002:         $cid = $env{'request.course.id'};
                   19003:         $cdom = $env{'course.'.$cid.'.domain'};
                   19004:         $cnum = $env{'course.'.$cid.'.num'};
                   19005:         $chome = $env{'course.'.$cid.'.home'};
                   19006:     }
                   19007:     my %allmaps = ();
                   19008:     my $lastchange =
                   19009:         &Apache::lonnet::get_coursechange($cdom,$cnum);
                   19010:     if ($lastchange > $env{'request.course.tied'}) {
                   19011:         my ($furl,$ferr) = &Apache::lonuserstate::readmap("$cdom/$cnum");
                   19012:         unless ($ferr) {
1.1395    raeburn  19013:             &update_content_constraints($cdom,$cnum,$chome,$cid);
1.1110    raeburn  19014:         }
                   19015:     }
                   19016:     my $navmap = Apache::lonnavmaps::navmap->new();
                   19017:     if (defined($navmap)) {
                   19018:         foreach my $res ($navmap->retrieveResources(undef,sub { $_[0]->is_map() },1,0,1)) {
                   19019:             $allmaps{$res->src()} = 1;
                   19020:         }
                   19021:     }
                   19022:     return \%allmaps;
                   19023: }
                   19024: 
1.1083    raeburn  19025: sub parse_supplemental_title {
                   19026:     my ($title) = @_;
                   19027: 
                   19028:     my ($foldertitle,$renametitle);
                   19029:     if ($title =~ /&amp;&amp;&amp;/) {
                   19030:         $title = &HTML::Entites::decode($title);
                   19031:     }
                   19032:     if ($title =~ m/^(\d+)___&&&___($match_username)___&&&___($match_domain)___&&&___(.*)$/) {
                   19033:         $renametitle=$4;
                   19034:         my ($time,$uname,$udom) = ($1,$2,$3);
                   19035:         $foldertitle=&Apache::lontexconvert::msgtexconverted($4);
                   19036:         my $name =  &plainname($uname,$udom);
                   19037:         $name = &HTML::Entities::encode($name,'"<>&\'');
                   19038:         $renametitle = &HTML::Entities::encode($renametitle,'"<>&\'');
1.1401    raeburn  19039:         $title='<i>'.&Apache::lonlocal::locallocaltime($time).'</i> '.$name;
1.1402    raeburn  19040:         if ($foldertitle ne '') {
1.1401    raeburn  19041:             $title .= ': <br />'.$foldertitle;
                   19042:         }
1.1083    raeburn  19043:     }
                   19044:     if (wantarray) {
                   19045:         return ($title,$foldertitle,$renametitle);
                   19046:     }
                   19047:     return $title;
                   19048: }
                   19049: 
1.1395    raeburn  19050: sub get_supplemental {
                   19051:     my ($cnum,$cdom,$ignorecache,$possdel)=@_;
                   19052:     my $hashid=$cnum.':'.$cdom;
                   19053:     my ($supplemental,$cached,$set_httprefs);
                   19054:     unless ($ignorecache) {
                   19055:         ($supplemental,$cached) = &Apache::lonnet::is_cached_new('supplemental',$hashid);
                   19056:     }
                   19057:     unless (defined($cached)) {
                   19058:         my $chome=&Apache::lonnet::homeserver($cnum,$cdom);
                   19059:         unless ($chome eq 'no_host') {
                   19060:             my @order = @LONCAPA::map::order;
                   19061:             my @resources = @LONCAPA::map::resources;
                   19062:             my @resparms = @LONCAPA::map::resparms;
                   19063:             my @zombies = @LONCAPA::map::zombies;
                   19064:             my ($errors,%ids,%hidden);
                   19065:             $errors =
                   19066:                 &recurse_supplemental($cnum,$cdom,'supplemental.sequence',
                   19067:                                       $errors,$possdel,\%ids,\%hidden);
                   19068:             @LONCAPA::map::order = @order;
                   19069:             @LONCAPA::map::resources = @resources;
                   19070:             @LONCAPA::map::resparms = @resparms;
                   19071:             @LONCAPA::map::zombies = @zombies;
                   19072:             $set_httprefs = 1;
                   19073:             if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
                   19074:                 &Apache::lonnet::appenv({'request.course.suppupdated' => time});
                   19075:             }
                   19076:             $supplemental = {
                   19077:                                ids => \%ids,
                   19078:                                hidden => \%hidden,
                   19079:                             };
                   19080:             &Apache::lonnet::do_cache_new('supplemental',$hashid,$supplemental,600);
                   19081:         }
                   19082:     }
                   19083:     return ($supplemental,$set_httprefs);
                   19084: }
                   19085: 
1.1143    raeburn  19086: sub recurse_supplemental {
1.1391    raeburn  19087:     my ($cnum,$cdom,$suppmap,$errors,$possdel,$suppids,$hiddensupp,$hidden) = @_;
                   19088:     if (($suppmap) && (ref($suppids) eq 'HASH') && (ref($hiddensupp) eq 'HASH')) {
                   19089:         my $mapnum;
                   19090:         if ($suppmap eq 'supplemental.sequence') {
                   19091:             $mapnum = 0;
                   19092:         } else {
                   19093:             ($mapnum) = ($suppmap =~ /^supplemental_(\d+)\.sequence$/);
                   19094:         }
1.1143    raeburn  19095:         my ($errtext,$fatal) = &LONCAPA::map::mapread('/uploaded/'.$cdom.'/'.$cnum.'/'.$suppmap);
                   19096:         if ($fatal) {
                   19097:             $errors ++;
                   19098:         } else {
1.1389    raeburn  19099:             my @order = @LONCAPA::map::order;
                   19100:             if (@order > 0) {
                   19101:                 my @resources = @LONCAPA::map::resources;
1.1391    raeburn  19102:                 my @resparms = @LONCAPA::map::resparms;
1.1389    raeburn  19103:                 foreach my $idx (@order) {
                   19104:                     my ($title,$src,$ext,$type,$status)=split(/\:/,$resources[$idx]);
1.1143    raeburn  19105:                     if (($src ne '') && ($status eq 'res')) {
1.1391    raeburn  19106:                         my $id = $mapnum.':'.$idx;
                   19107:                         push(@{$suppids->{$src}},$id);
                   19108:                         if (($hidden) || (&get_supp_parameter($resparms[$idx],'parameter_hiddenresource') =~ /^yes/i)) {
                   19109:                             $hiddensupp->{$id} = 1;
                   19110:                         }
1.1146    raeburn  19111:                         if ($src =~ m{^\Q/uploaded/$cdom/$cnum/\E(supplemental_\d+\.sequence)$}) {
1.1391    raeburn  19112:                             $errors = &recurse_supplemental($cnum,$cdom,$1,$errors,$possdel,$suppids,
                   19113:                                                             $hiddensupp,$hiddensupp->{$id});
1.1143    raeburn  19114:                         } else {
1.1391    raeburn  19115:                             my $allowed;
                   19116:                             if (($env{'request.role.adv'}) || (!$hiddensupp->{$id})) {
                   19117:                                 $allowed = 1;
                   19118:                             } elsif ($possdel) {
                   19119:                                 foreach my $item (@{$suppids->{$src}}) {
                   19120:                                     next if ($item eq $id);
                   19121:                                     unless ($hiddensupp->{$item}) {
                   19122:                                        $allowed = 1;
                   19123:                                        last;
                   19124:                                     }
                   19125:                                 }
                   19126:                                 if ((!$allowed) && (exists($env{'httpref.'.$src}))) {
                   19127:                                     &Apache::lonnet::delenv('httpref.'.$src);
                   19128:                                 }
                   19129:                             }
                   19130:                             if ($allowed && (!exists($env{'httpref.'.$src}))) {
                   19131:                                 &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
1.1308    raeburn  19132:                             }
1.1143    raeburn  19133:                         }
                   19134:                     }
                   19135:                 }
                   19136:             }
                   19137:         }
                   19138:     }
1.1391    raeburn  19139:     return $errors;
                   19140: }
                   19141: 
                   19142: sub set_supp_httprefs {
                   19143:     my ($cnum,$cdom,$supplemental,$possdel) = @_;
                   19144:     if (ref($supplemental) eq 'HASH') {
                   19145:         if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
                   19146:             foreach my $src (keys(%{$supplemental->{'ids'}})) {
                   19147:                 next if ($src =~ /\.sequence$/);
                   19148:                 if (ref($supplemental->{'ids'}->{$src}) eq 'ARRAY') {
                   19149:                     my $allowed;
                   19150:                     if ($env{'request.role.adv'}) {
                   19151:                         $allowed = 1;
                   19152:                     } else {
                   19153:                         foreach my $id (@{$supplemental->{'ids'}->{$src}}) {
                   19154:                             unless ($supplemental->{'hidden'}->{$id}) {
                   19155:                                 $allowed = 1;
                   19156:                                 last;
                   19157:                             }
                   19158:                         }
                   19159:                     }
                   19160:                     if (exists($env{'httpref.'.$src})) {
                   19161:                         if ($possdel) {
                   19162:                             unless ($allowed) {
                   19163:                                 &Apache::lonnet::delenv('httpref.'.$src);
                   19164:                             }
                   19165:                         }
                   19166:                     } elsif ($allowed) {
                   19167:                         &Apache::lonnet::allowuploaded('/adm/coursedoc',$src);
                   19168:                     }
                   19169:                 }
                   19170:             }
                   19171:             if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
                   19172:                 &Apache::lonnet::appenv({'request.course.suppupdated' => time});
                   19173:             }
                   19174:         }
                   19175:     }
                   19176: }
                   19177: 
                   19178: sub get_supp_parameter {
                   19179:     my ($resparm,$name)=@_;
                   19180:     return if ($resparm eq '');
                   19181:     my $value=undef;
                   19182:     my $ptype=undef;
                   19183:     foreach (split('&&&',$resparm)) {
                   19184:         my ($thistype,$thisname,$thisvalue)=split('___',$_);
                   19185:         if ($thisname eq $name) {
                   19186:             $value=$thisvalue;
                   19187:             $ptype=$thistype;
                   19188:         }
                   19189:     }
                   19190:     return $value;
1.1143    raeburn  19191: }
                   19192: 
1.1101    raeburn  19193: sub symb_to_docspath {
1.1267    raeburn  19194:     my ($symb,$navmapref) = @_;
                   19195:     return unless ($symb && ref($navmapref));
1.1101    raeburn  19196:     my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
                   19197:     if ($resurl=~/\.(sequence|page)$/) {
                   19198:         $mapurl=$resurl;
                   19199:     } elsif ($resurl eq 'adm/navmaps') {
                   19200:         $mapurl=$env{'course.'.$env{'request.course.id'}.'.url'};
                   19201:     }
                   19202:     my $mapresobj;
1.1267    raeburn  19203:     unless (ref($$navmapref)) {
                   19204:         $$navmapref = Apache::lonnavmaps::navmap->new();
                   19205:     }
                   19206:     if (ref($$navmapref)) {
                   19207:         $mapresobj = $$navmapref->getResourceByUrl($mapurl);
1.1101    raeburn  19208:     }
                   19209:     $mapurl=~s{^.*/([^/]+)\.(\w+)$}{$1};
                   19210:     my $type=$2;
                   19211:     my $path;
                   19212:     if (ref($mapresobj)) {
                   19213:         my $pcslist = $mapresobj->map_hierarchy();
                   19214:         if ($pcslist ne '') {
                   19215:             foreach my $pc (split(/,/,$pcslist)) {
                   19216:                 next if ($pc <= 1);
1.1267    raeburn  19217:                 my $res = $$navmapref->getByMapPc($pc);
1.1101    raeburn  19218:                 if (ref($res)) {
                   19219:                     my $thisurl = $res->src();
                   19220:                     $thisurl=~s{^.*/([^/]+)\.\w+$}{$1};
                   19221:                     my $thistitle = $res->title();
                   19222:                     $path .= '&'.
                   19223:                              &Apache::lonhtmlcommon::entity_encode($thisurl).'&'.
1.1146    raeburn  19224:                              &escape($thistitle).
1.1101    raeburn  19225:                              ':'.$res->randompick().
                   19226:                              ':'.$res->randomout().
                   19227:                              ':'.$res->encrypted().
                   19228:                              ':'.$res->randomorder().
                   19229:                              ':'.$res->is_page();
                   19230:                 }
                   19231:             }
                   19232:         }
                   19233:         $path =~ s/^\&//;
                   19234:         my $maptitle = $mapresobj->title();
                   19235:         if ($mapurl eq 'default') {
1.1129    raeburn  19236:             $maptitle = 'Main Content';
1.1101    raeburn  19237:         }
                   19238:         $path .= (($path ne '')? '&' : '').
                   19239:                  &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146    raeburn  19240:                  &escape($maptitle).
1.1101    raeburn  19241:                  ':'.$mapresobj->randompick().
                   19242:                  ':'.$mapresobj->randomout().
                   19243:                  ':'.$mapresobj->encrypted().
                   19244:                  ':'.$mapresobj->randomorder().
                   19245:                  ':'.$mapresobj->is_page();
                   19246:     } else {
                   19247:         my $maptitle = &Apache::lonnet::gettitle($mapurl);
                   19248:         my $ispage = (($type eq 'page')? 1 : '');
                   19249:         if ($mapurl eq 'default') {
1.1129    raeburn  19250:             $maptitle = 'Main Content';
1.1101    raeburn  19251:         }
                   19252:         $path = &Apache::lonhtmlcommon::entity_encode($mapurl).'&'.
1.1146    raeburn  19253:                 &escape($maptitle).':::::'.$ispage;
1.1101    raeburn  19254:     }
                   19255:     unless ($mapurl eq 'default') {
                   19256:         $path = 'default&'.
1.1146    raeburn  19257:                 &escape('Main Content').
1.1101    raeburn  19258:                 ':::::&'.$path;
                   19259:     }
                   19260:     return $path;
                   19261: }
                   19262: 
1.1393    raeburn  19263: sub validate_folderpath {
                   19264:     my ($supplementalflag,$allowed,$coursenum,$coursedom) = @_;
                   19265:     if ($env{'form.folderpath'} ne '') {
                   19266:         my @items = split(/\&/,$env{'form.folderpath'});
1.1394    raeburn  19267:         my ($badpath,$changed,$got_supp,$supppath,%supphidden,%suppids);
1.1393    raeburn  19268:         for (my $i=0; $i<@items; $i++) {
                   19269:             my $odd = $i%2;
                   19270:             if (($odd) && (!$supplementalflag) && ($items[$i] !~ /^[^:]*:(|\d+):(|1):(|1):(|1):(|1)$/)) {
                   19271:                 $badpath = 1;
1.1394    raeburn  19272:             } elsif ($odd && $supplementalflag) {
1.1393    raeburn  19273:                 my $idx = $i-1;
1.1394    raeburn  19274:                 if ($items[$i] =~ /^([^:]*)::(|1):::$/) {
                   19275:                     my $esc_name = $1;
                   19276:                     if ((!$allowed) || ($items[$idx] eq 'supplemental')) {
                   19277:                         $supppath .= '&'.$esc_name;
                   19278:                         $changed = 1;
                   19279:                     } else {
                   19280:                         $supppath .= '&'.$items[$i];
                   19281:                     }
                   19282:                 } elsif (($allowed) && ($items[$idx] ne 'supplemental')) {
                   19283:                     $changed = 1;
1.1393    raeburn  19284:                     my $is_hidden;
                   19285:                     unless ($got_supp) {
1.1395    raeburn  19286:                         my ($supplemental) = &get_supplemental($coursenum,$coursedom);
1.1393    raeburn  19287:                         if (ref($supplemental) eq 'HASH') {
                   19288:                             if (ref($supplemental->{'hidden'}) eq 'HASH') {
                   19289:                                 %supphidden = %{$supplemental->{'hidden'}};
                   19290:                             }
                   19291:                             if (ref($supplemental->{'ids'}) eq 'HASH') {
                   19292:                                 %suppids = %{$supplemental->{'ids'}};
                   19293:                             }
                   19294:                         }
                   19295:                         $got_supp = 1;
                   19296:                     }
                   19297:                     if (ref($suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}) eq 'ARRAY') {
                   19298:                         my $mapid = $suppids{"/uploaded/$coursedom/$coursenum/$items[$idx].sequence"}->[0];
                   19299:                         if ($supphidden{$mapid}) {
                   19300:                             $is_hidden = 1;
                   19301:                         }
                   19302:                     }
1.1394    raeburn  19303:                     $supppath .= '&'.$items[$i].'::'.$is_hidden.':::';
                   19304:                 } else {
                   19305:                     $supppath .= '&'.$items[$i];
1.1393    raeburn  19306:                 }
                   19307:             } elsif ((!$odd) && ($items[$i] !~ /^(default|supplemental)(|_\d+)$/)) {
                   19308:                 $badpath = 1;
1.1394    raeburn  19309:             } elsif ($supplementalflag) {
1.1393    raeburn  19310:                 $supppath .= '&'.$items[$i];
                   19311:             }
                   19312:             last if ($badpath);
                   19313:         }
                   19314:         if ($badpath) {
                   19315:             delete($env{'form.folderpath'});
1.1394    raeburn  19316:         } elsif ($changed && $supplementalflag) {
1.1393    raeburn  19317:             $supppath =~ s/^\&//;
                   19318:             $env{'form.folderpath'} = $supppath;
                   19319:         }
                   19320:     }
                   19321:     return;
                   19322: }
                   19323: 
1.1094    raeburn  19324: sub captcha_display {
1.1327    raeburn  19325:     my ($context,$lonhost,$defdom) = @_;
1.1094    raeburn  19326:     my ($output,$error);
1.1234    raeburn  19327:     my ($captcha,$pubkey,$privkey,$version) = 
1.1327    raeburn  19328:         &get_captcha_config($context,$lonhost,$defdom);
1.1095    raeburn  19329:     if ($captcha eq 'original') {
1.1094    raeburn  19330:         $output = &create_captcha();
                   19331:         unless ($output) {
1.1172    raeburn  19332:             $error = 'captcha';
1.1094    raeburn  19333:         }
                   19334:     } elsif ($captcha eq 'recaptcha') {
1.1234    raeburn  19335:         $output = &create_recaptcha($pubkey,$version);
1.1094    raeburn  19336:         unless ($output) {
1.1172    raeburn  19337:             $error = 'recaptcha';
1.1094    raeburn  19338:         }
                   19339:     }
1.1234    raeburn  19340:     return ($output,$error,$captcha,$version);
1.1094    raeburn  19341: }
                   19342: 
                   19343: sub captcha_response {
1.1327    raeburn  19344:     my ($context,$lonhost,$defdom) = @_;
1.1094    raeburn  19345:     my ($captcha_chk,$captcha_error);
1.1327    raeburn  19346:     my ($captcha,$pubkey,$privkey,$version) = &get_captcha_config($context,$lonhost,$defdom);
1.1095    raeburn  19347:     if ($captcha eq 'original') {
1.1094    raeburn  19348:         ($captcha_chk,$captcha_error) = &check_captcha();
                   19349:     } elsif ($captcha eq 'recaptcha') {
1.1234    raeburn  19350:         $captcha_chk = &check_recaptcha($privkey,$version);
1.1094    raeburn  19351:     } else {
                   19352:         $captcha_chk = 1;
                   19353:     }
                   19354:     return ($captcha_chk,$captcha_error);
                   19355: }
                   19356: 
                   19357: sub get_captcha_config {
1.1327    raeburn  19358:     my ($context,$lonhost,$dom_in_effect) = @_;
1.1234    raeburn  19359:     my ($captcha,$pubkey,$privkey,$version,$hashtocheck);
1.1094    raeburn  19360:     my $hostname = &Apache::lonnet::hostname($lonhost);
                   19361:     my $serverhomeID = &Apache::lonnet::get_server_homeID($hostname);
                   19362:     my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
1.1095    raeburn  19363:     if ($context eq 'usercreation') {
                   19364:         my %domconfig = &Apache::lonnet::get_dom('configuration',[$context],$serverhomedom);
                   19365:         if (ref($domconfig{$context}) eq 'HASH') {
                   19366:             $hashtocheck = $domconfig{$context}{'cancreate'};
                   19367:             if (ref($hashtocheck) eq 'HASH') {
                   19368:                 if ($hashtocheck->{'captcha'} eq 'recaptcha') {
                   19369:                     if (ref($hashtocheck->{'recaptchakeys'}) eq 'HASH') {
                   19370:                         $pubkey = $hashtocheck->{'recaptchakeys'}{'public'};
                   19371:                         $privkey = $hashtocheck->{'recaptchakeys'}{'private'};
                   19372:                     }
                   19373:                     if ($privkey && $pubkey) {
                   19374:                         $captcha = 'recaptcha';
1.1234    raeburn  19375:                         $version = $hashtocheck->{'recaptchaversion'};
                   19376:                         if ($version ne '2') {
                   19377:                             $version = 1;
                   19378:                         }
1.1095    raeburn  19379:                     } else {
                   19380:                         $captcha = 'original';
                   19381:                     }
                   19382:                 } elsif ($hashtocheck->{'captcha'} ne 'notused') {
                   19383:                     $captcha = 'original';
                   19384:                 }
1.1094    raeburn  19385:             }
1.1095    raeburn  19386:         } else {
                   19387:             $captcha = 'captcha';
                   19388:         }
                   19389:     } elsif ($context eq 'login') {
                   19390:         my %domconfhash = &Apache::loncommon::get_domainconf($serverhomedom);
                   19391:         if ($domconfhash{$serverhomedom.'.login.captcha'} eq 'recaptcha') {
                   19392:             $pubkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_public'};
                   19393:             $privkey = $domconfhash{$serverhomedom.'.login.recaptchakeys_private'};
1.1094    raeburn  19394:             if ($privkey && $pubkey) {
                   19395:                 $captcha = 'recaptcha';
1.1234    raeburn  19396:                 $version = $domconfhash{$serverhomedom.'.login.recaptchaversion'};
                   19397:                 if ($version ne '2') {
                   19398:                     $version = 1; 
                   19399:                 }
1.1095    raeburn  19400:             } else {
                   19401:                 $captcha = 'original';
1.1094    raeburn  19402:             }
1.1095    raeburn  19403:         } elsif ($domconfhash{$serverhomedom.'.login.captcha'} eq 'original') {
                   19404:             $captcha = 'original';
1.1094    raeburn  19405:         }
1.1327    raeburn  19406:     } elsif ($context eq 'passwords') {
                   19407:         if ($dom_in_effect) {
                   19408:             my %passwdconf = &Apache::lonnet::get_passwdconf($dom_in_effect);
                   19409:             if ($passwdconf{'captcha'} eq 'recaptcha') {
                   19410:                 if (ref($passwdconf{'recaptchakeys'}) eq 'HASH') {
                   19411:                     $pubkey = $passwdconf{'recaptchakeys'}{'public'};
                   19412:                     $privkey = $passwdconf{'recaptchakeys'}{'private'};
                   19413:                 }
                   19414:                 if ($privkey && $pubkey) {
                   19415:                     $captcha = 'recaptcha';
                   19416:                     $version = $passwdconf{'recaptchaversion'};
                   19417:                     if ($version ne '2') {
                   19418:                         $version = 1;
                   19419:                     }
                   19420:                 } else {
                   19421:                     $captcha = 'original';
                   19422:                 }
                   19423:             } elsif ($passwdconf{'captcha'} ne 'notused') {
                   19424:                 $captcha = 'original';
                   19425:             }
                   19426:         }
                   19427:     } 
1.1234    raeburn  19428:     return ($captcha,$pubkey,$privkey,$version);
1.1094    raeburn  19429: }
                   19430: 
                   19431: sub create_captcha {
                   19432:     my %captcha_params = &captcha_settings();
                   19433:     my ($output,$maxtries,$tries) = ('',10,0);
                   19434:     while ($tries < $maxtries) {
                   19435:         $tries ++;
                   19436:         my $captcha = Authen::Captcha->new (
                   19437:                                            output_folder => $captcha_params{'output_dir'},
                   19438:                                            data_folder   => $captcha_params{'db_dir'},
                   19439:                                           );
                   19440:         my $md5sum = $captcha->generate_code($captcha_params{'numchars'});
                   19441: 
                   19442:         if (-e $Apache::lonnet::perlvar{'lonCaptchaDir'}.'/'.$md5sum.'.png') {
                   19443:             $output = '<input type="hidden" name="crypt" value="'.$md5sum.'" />'."\n".
1.1367    raeburn  19444:                       '<span class="LC_nobreak">'.
1.1094    raeburn  19445:                       &mt('Type in the letters/numbers shown below').'&nbsp;'.
1.1390    raeburn  19446:                       '<input type="text" size="5" name="code" value="" autocomplete="new-password" />'.
1.1367    raeburn  19447:                       '</span><br />'.
1.1176    raeburn  19448:                       '<img src="'.$captcha_params{'www_output_dir'}.'/'.$md5sum.'.png" alt="captcha" />';
1.1094    raeburn  19449:             last;
                   19450:         }
                   19451:     }
1.1323    raeburn  19452:     if ($output eq '') {
                   19453:         &Apache::lonnet::logthis("Failed to create Captcha code after $tries attempts.");
                   19454:     }
1.1094    raeburn  19455:     return $output;
                   19456: }
                   19457: 
                   19458: sub captcha_settings {
                   19459:     my %captcha_params = (
                   19460:                            output_dir     => $Apache::lonnet::perlvar{'lonCaptchaDir'},
                   19461:                            www_output_dir => "/captchaspool",
                   19462:                            db_dir         => $Apache::lonnet::perlvar{'lonCaptchaDb'},
                   19463:                            numchars       => '5',
                   19464:                          );
                   19465:     return %captcha_params;
                   19466: }
                   19467: 
                   19468: sub check_captcha {
                   19469:     my ($captcha_chk,$captcha_error);
                   19470:     my $code = $env{'form.code'};
                   19471:     my $md5sum = $env{'form.crypt'};
                   19472:     my %captcha_params = &captcha_settings();
                   19473:     my $captcha = Authen::Captcha->new(
                   19474:                       output_folder => $captcha_params{'output_dir'},
                   19475:                       data_folder   => $captcha_params{'db_dir'},
                   19476:                   );
1.1109    raeburn  19477:     $captcha_chk = $captcha->check_code($code,$md5sum);
1.1094    raeburn  19478:     my %captcha_hash = (
                   19479:                         0       => 'Code not checked (file error)',
                   19480:                        -1      => 'Failed: code expired',
                   19481:                        -2      => 'Failed: invalid code (not in database)',
                   19482:                        -3      => 'Failed: invalid code (code does not match crypt)',
                   19483:     );
                   19484:     if ($captcha_chk != 1) {
                   19485:         $captcha_error = $captcha_hash{$captcha_chk}
                   19486:     }
                   19487:     return ($captcha_chk,$captcha_error);
                   19488: }
                   19489: 
                   19490: sub create_recaptcha {
1.1234    raeburn  19491:     my ($pubkey,$version) = @_;
                   19492:     if ($version >= 2) {
1.1367    raeburn  19493:         return '<div class="g-recaptcha" data-sitekey="'.$pubkey.'"></div>'.
                   19494:                '<div style="padding:0;clear:both;margin:0;border:0"></div>';
1.1234    raeburn  19495:     } else {
                   19496:         my $use_ssl;
                   19497:         if ($ENV{'SERVER_PORT'} == 443) {
                   19498:             $use_ssl = 1;
                   19499:         }
                   19500:         my $captcha = Captcha::reCAPTCHA->new;
                   19501:         return $captcha->get_options_setter({theme => 'white'})."\n".
                   19502:                $captcha->get_html($pubkey,undef,$use_ssl).
                   19503:                &mt('If the text is hard to read, [_1] will replace them.',
                   19504:                    '<img src="/res/adm/pages/refresh.gif" alt="reCAPTCHA refresh" />').
                   19505:                '<br /><br />';
                   19506:     }
1.1094    raeburn  19507: }
                   19508: 
                   19509: sub check_recaptcha {
1.1234    raeburn  19510:     my ($privkey,$version) = @_;
1.1094    raeburn  19511:     my $captcha_chk;
1.1350    raeburn  19512:     my $ip = &Apache::lonnet::get_requestor_ip();
1.1234    raeburn  19513:     if ($version >= 2) {
                   19514:         my %info = (
                   19515:                      secret   => $privkey, 
                   19516:                      response => $env{'form.g-recaptcha-response'},
1.1350    raeburn  19517:                      remoteip => $ip,
1.1234    raeburn  19518:                    );
1.1280    raeburn  19519:         my $request=new HTTP::Request('POST','https://www.google.com/recaptcha/api/siteverify');
                   19520:         $request->content(join('&',map {
                   19521:                          my $name = escape($_);
                   19522:                          "$name=" . ( ref($info{$_}) eq 'ARRAY'
                   19523:                          ? join("&$name=", map {escape($_) } @{$info{$_}})
                   19524:                          : &escape($info{$_}) );
                   19525:         } keys(%info)));
                   19526:         my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',10,1);
1.1234    raeburn  19527:         if ($response->is_success)  {
                   19528:             my $data = JSON::DWIW->from_json($response->decoded_content);
                   19529:             if (ref($data) eq 'HASH') {
                   19530:                 if ($data->{'success'}) {
                   19531:                     $captcha_chk = 1;
                   19532:                 }
                   19533:             }
                   19534:         }
                   19535:     } else {
                   19536:         my $captcha = Captcha::reCAPTCHA->new;
                   19537:         my $captcha_result =
                   19538:             $captcha->check_answer(
                   19539:                                     $privkey,
1.1350    raeburn  19540:                                     $ip,
1.1234    raeburn  19541:                                     $env{'form.recaptcha_challenge_field'},
                   19542:                                     $env{'form.recaptcha_response_field'},
                   19543:                                   );
                   19544:         if ($captcha_result->{is_valid}) {
                   19545:             $captcha_chk = 1;
                   19546:         }
1.1094    raeburn  19547:     }
                   19548:     return $captcha_chk;
                   19549: }
                   19550: 
1.1174    raeburn  19551: sub emailusername_info {
1.1244    raeburn  19552:     my @fields = ('firstname','lastname','institution','web','location','officialemail','id');
1.1174    raeburn  19553:     my %titles = &Apache::lonlocal::texthash (
                   19554:                      lastname      => 'Last Name',
                   19555:                      firstname     => 'First Name',
                   19556:                      institution   => 'School/college/university',
                   19557:                      location      => "School's city, state/province, country",
                   19558:                      web           => "School's web address",
                   19559:                      officialemail => 'E-mail address at institution (if different)',
1.1244    raeburn  19560:                      id            => 'Student/Employee ID',
1.1174    raeburn  19561:                  );
                   19562:     return (\@fields,\%titles);
                   19563: }
                   19564: 
1.1161    raeburn  19565: sub cleanup_html {
                   19566:     my ($incoming) = @_;
                   19567:     my $outgoing;
                   19568:     if ($incoming ne '') {
                   19569:         $outgoing = $incoming;
                   19570:         $outgoing =~ s/;/&#059;/g;
                   19571:         $outgoing =~ s/\#/&#035;/g;
                   19572:         $outgoing =~ s/\&/&#038;/g;
                   19573:         $outgoing =~ s/</&#060;/g;
                   19574:         $outgoing =~ s/>/&#062;/g;
                   19575:         $outgoing =~ s/\(/&#040/g;
                   19576:         $outgoing =~ s/\)/&#041;/g;
                   19577:         $outgoing =~ s/"/&#034;/g;
                   19578:         $outgoing =~ s/'/&#039;/g;
                   19579:         $outgoing =~ s/\$/&#036;/g;
                   19580:         $outgoing =~ s{/}{&#047;}g;
                   19581:         $outgoing =~ s/=/&#061;/g;
                   19582:         $outgoing =~ s/\\/&#092;/g
                   19583:     }
                   19584:     return $outgoing;
                   19585: }
                   19586: 
1.1190    musolffc 19587: # Checks for critical messages and returns a redirect url if one exists.
                   19588: # $interval indicates how often to check for messages.
1.1282    raeburn  19589: # $context is the calling context -- roles, grades, contents, menu or flip. 
1.1190    musolffc 19590: sub critical_redirect {
1.1282    raeburn  19591:     my ($interval,$context) = @_;
1.1356    raeburn  19592:     unless (($env{'user.domain'} ne '') && ($env{'user.name'} ne '')) {
                   19593:         return ();
                   19594:     }
1.1190    musolffc 19595:     if ((time-$env{'user.criticalcheck.time'})>$interval) {
1.1282    raeburn  19596:         if (($env{'request.course.id'}) && (($context eq 'flip') || ($context eq 'contents'))) {
                   19597:             my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                   19598:             my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
1.1372    raeburn  19599:             my $blocked = &blocking_status('alert',undef,$cnum,$cdom,undef,1);
1.1282    raeburn  19600:             if ($blocked) {
                   19601:                 my $checkrole = "cm./$cdom/$cnum";
                   19602:                 if ($env{'request.course.sec'} ne '') {
                   19603:                     $checkrole .= "/$env{'request.course.sec'}";
                   19604:                 }
                   19605:                 unless ((&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) &&
                   19606:                         ($env{'request.role'} !~ m{^st\./$cdom/$cnum})) {
                   19607:                     return;
                   19608:                 }
                   19609:             }
                   19610:         }
1.1190    musolffc 19611:         my @what=&Apache::lonnet::dump('critical', $env{'user.domain'}, 
                   19612:                                         $env{'user.name'});
                   19613:         &Apache::lonnet::appenv({'user.criticalcheck.time'=>time});
1.1191    raeburn  19614:         my $redirecturl;
1.1190    musolffc 19615:         if ($what[0]) {
1.1356    raeburn  19616: 	    if (($what[0] ne 'con_lost') && ($what[0] ne 'no_such_host') && ($what[0]!~/^error\:/)) {
1.1190    musolffc 19617: 	        $redirecturl='/adm/email?critical=display';
1.1191    raeburn  19618: 	        my $url=&Apache::lonnet::absolute_url().$redirecturl;
                   19619:                 return (1, $url);
1.1190    musolffc 19620:             }
1.1191    raeburn  19621:         }
                   19622:     } 
                   19623:     return ();
1.1190    musolffc 19624: }
                   19625: 
1.1174    raeburn  19626: # Use:
                   19627: #   my $answer=reply("encrypt:passwd:$udom:$uname:$upass",$tryserver);
                   19628: #
                   19629: ##################################################
                   19630: #          password associated functions         #
                   19631: ##################################################
                   19632: sub des_keys {
                   19633:     # Make a new key for DES encryption.
                   19634:     # Each key has two parts which are returned separately.
                   19635:     # Please note:  Each key must be passed through the &hex function
                   19636:     # before it is output to the web browser.  The hex versions cannot
                   19637:     # be used to decrypt.
                   19638:     my @hexstr=('0','1','2','3','4','5','6','7',
                   19639:                 '8','9','a','b','c','d','e','f');
                   19640:     my $lkey='';
                   19641:     for (0..7) {
                   19642:         $lkey.=$hexstr[rand(15)];
                   19643:     }
                   19644:     my $ukey='';
                   19645:     for (0..7) {
                   19646:         $ukey.=$hexstr[rand(15)];
                   19647:     }
                   19648:     return ($lkey,$ukey);
                   19649: }
                   19650: 
                   19651: sub des_decrypt {
                   19652:     my ($key,$cyphertext) = @_;
                   19653:     my $keybin=pack("H16",$key);
                   19654:     my $cypher;
                   19655:     if ($Crypt::DES::VERSION>=2.03) {
                   19656:         $cypher=new Crypt::DES $keybin;
                   19657:     } else {
                   19658:         $cypher=new DES $keybin;
                   19659:     }
1.1233    raeburn  19660:     my $plaintext='';
                   19661:     my $cypherlength = length($cyphertext);
                   19662:     my $numchunks = int($cypherlength/32);
                   19663:     for (my $j=0; $j<$numchunks; $j++) {
                   19664:         my $start = $j*32;
                   19665:         my $cypherblock = substr($cyphertext,$start,32);
                   19666:         my $chunk =
                   19667:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,0,16))));
                   19668:         $chunk .=
                   19669:             $cypher->decrypt(unpack("a8",pack("H16",substr($cypherblock,16,16))));
                   19670:         $chunk=substr($chunk,1,ord(substr($chunk,0,1)) );
                   19671:         $plaintext .= $chunk;
                   19672:     }
1.1174    raeburn  19673:     return $plaintext;
                   19674: }
                   19675: 
1.1344    raeburn  19676: sub get_requested_shorturls {
1.1309    raeburn  19677:     my ($cdom,$cnum,$navmap) = @_;
                   19678:     return unless (ref($navmap));
1.1344    raeburn  19679:     my ($numnew,$errors);
1.1309    raeburn  19680:     my @toshorten = &Apache::loncommon::get_env_multiple('form.addtiny');
                   19681:     if (@toshorten) {
                   19682:         my (%maps,%resources,%titles);
                   19683:         &Apache::loncourserespicker::enumerate_course_contents($navmap,\%maps,\%resources,\%titles,
                   19684:                                                                'shorturls',$cdom,$cnum);
                   19685:         if (keys(%resources)) {
1.1344    raeburn  19686:             my %tocreate;
1.1309    raeburn  19687:             foreach my $item (sort {$a <=> $b} (@toshorten)) {
                   19688:                 my $symb = $resources{$item};
                   19689:                 if ($symb) {
                   19690:                     $tocreate{$cnum.'&'.$symb} = 1;
                   19691:                 }
                   19692:             }
1.1344    raeburn  19693:             if (keys(%tocreate)) {
                   19694:                 ($numnew,$errors) = &make_short_symbs($cdom,$cnum,
                   19695:                                                       \%tocreate);
                   19696:             }
1.1309    raeburn  19697:         }
1.1344    raeburn  19698:     }
                   19699:     return ($numnew,$errors);
                   19700: }
                   19701: 
                   19702: sub make_short_symbs {
                   19703:     my ($cdom,$cnum,$tocreateref,$lockuser) = @_;
                   19704:     my ($numnew,@errors);
                   19705:     if (ref($tocreateref) eq 'HASH') {
                   19706:         my %tocreate = %{$tocreateref};
1.1309    raeburn  19707:         if (keys(%tocreate)) {
                   19708:             my %coursetiny = &Apache::lonnet::dump('tiny',$cdom,$cnum);
                   19709:             my $su = Short::URL->new(no_vowels => 1);
                   19710:             my $init = '';
                   19711:             my (%newunique,%addcourse,%courseonly,%failed);
                   19712:             # get lock on tiny db
                   19713:             my $now = time;
1.1344    raeburn  19714:             if ($lockuser eq '') {
                   19715:                 $lockuser = $env{'user.name'}.':'.$env{'user.domain'};
                   19716:             }
1.1309    raeburn  19717:             my $lockhash = {
1.1344    raeburn  19718:                                 "lock\0$now" => $lockuser,
1.1309    raeburn  19719:                             };
                   19720:             my $tries = 0;
                   19721:             my $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
                   19722:             my ($code,$error);
                   19723:             while (($gotlock ne 'ok') && ($tries<3)) {
                   19724:                 $tries ++;
                   19725:                 sleep 1;
1.1319    raeburn  19726:                 $gotlock = &Apache::lonnet::newput_dom('tiny',$lockhash,$cdom);
1.1309    raeburn  19727:             }
                   19728:             if ($gotlock eq 'ok') {
                   19729:                 $init = &shorten_symbs($cdom,$init,$su,\%coursetiny,\%tocreate,\%newunique,
                   19730:                                        \%addcourse,\%courseonly,\%failed);
                   19731:                 if (keys(%failed)) {
                   19732:                     my $numfailed = scalar(keys(%failed));
                   19733:                     push(@errors,&mt('error: could not obtain unique six character URL for [quant,_1,resource]',$numfailed));
                   19734:                 }
                   19735:                 if (keys(%newunique)) {
                   19736:                     my $putres = &Apache::lonnet::newput_dom('tiny',\%newunique,$cdom);
                   19737:                     if ($putres eq 'ok') {
                   19738:                         $numnew = scalar(keys(%newunique));
                   19739:                         my $newputres = &Apache::lonnet::newput('tiny',\%addcourse,$cdom,$cnum);
                   19740:                         unless ($newputres eq 'ok') {
                   19741:                             push(@errors,&mt('error: could not store course look-up of short URLs'));
                   19742:                         }
                   19743:                     } else {
                   19744:                         push(@errors,&mt('error: could not store unique six character URLs'));
                   19745:                     }
                   19746:                 }
                   19747:                 my $dellockres = &Apache::lonnet::del_dom('tiny',["lock\0$now"],$cdom);
                   19748:                 unless ($dellockres eq 'ok') {
                   19749:                     push(@errors,&mt('error: could not release lockfile'));
                   19750:                 }
                   19751:             } else {
                   19752:                 push(@errors,&mt('error: could not obtain lockfile'));
                   19753:             }
                   19754:             if (keys(%courseonly)) {
                   19755:                 my $result = &Apache::lonnet::newput('tiny',\%courseonly,$cdom,$cnum);
                   19756:                 if ($result ne 'ok') {
                   19757:                     push(@errors,&mt('error: could not update course look-up of short URLs'));
                   19758:                 }
                   19759:             }
                   19760:         }
                   19761:     }
                   19762:     return ($numnew,\@errors);
                   19763: }
                   19764: 
                   19765: sub shorten_symbs {
                   19766:     my ($cdom,$init,$su,$coursetiny,$tocreate,$newunique,$addcourse,$courseonly,$failed) = @_;
                   19767:     return unless ((ref($su)) && (ref($coursetiny) eq 'HASH') && (ref($tocreate) eq 'HASH') &&
                   19768:                    (ref($newunique) eq 'HASH') && (ref($addcourse) eq 'HASH') &&
                   19769:                    (ref($courseonly) eq 'HASH') && (ref($failed) eq 'HASH'));
                   19770:     my (%possibles,%collisions);
                   19771:     foreach my $key (keys(%{$tocreate})) {
                   19772:         my $num = String::CRC32::crc32($key);
                   19773:         my $tiny = $su->encode($num,$init);
                   19774:         if ($tiny) {
                   19775:             $possibles{$tiny} = $key;
                   19776:         }
                   19777:     }
                   19778:     if (!$init) {
                   19779:         $init = 1;
                   19780:     } else {
                   19781:         $init ++;
                   19782:     }
                   19783:     if (keys(%possibles)) {
                   19784:         my @posstiny = keys(%possibles);
                   19785:         my $configuname = &Apache::lonnet::get_domainconfiguser($cdom);
                   19786:         my %currtiny = &Apache::lonnet::get('tiny',\@posstiny,$cdom,$configuname);
                   19787:         if (keys(%currtiny)) {
                   19788:             foreach my $key (keys(%currtiny)) {
                   19789:                 next if ($currtiny{$key} eq '');
                   19790:                 if ($currtiny{$key} eq $possibles{$key}) {
                   19791:                     my ($tcnum,$tsymb) = split(/\&/,$currtiny{$key});
                   19792:                     unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   19793:                         $courseonly->{$tsymb} = $key;
                   19794:                     }
                   19795:                 } else {
                   19796:                     $collisions{$possibles{$key}} = 1;
                   19797:                 }
                   19798:                 delete($possibles{$key});
                   19799:             }
                   19800:         }
                   19801:         foreach my $key (keys(%possibles)) {
                   19802:             $newunique->{$key} = $possibles{$key};
                   19803:             my ($tcnum,$tsymb) = split(/\&/,$possibles{$key});
                   19804:             unless (($coursetiny->{$tsymb} eq $key) || ($addcourse->{$tsymb} eq $key) || ($courseonly->{$tsymb} eq $key)) {
                   19805:                 $addcourse->{$tsymb} = $key;
                   19806:             }
                   19807:         }
                   19808:     }
                   19809:     if (keys(%collisions)) {
                   19810:         if ($init <5) {
                   19811:             if (!$init) {
                   19812:                 $init = 1;
                   19813:             } else {
                   19814:                 $init ++;
                   19815:             }
                   19816:             $init = &shorten_symbs($cdom,$init,$su,$coursetiny,\%collisions,
                   19817:                                    $newunique,$addcourse,$courseonly,$failed);
                   19818:         } else {
                   19819:             foreach my $key (keys(%collisions)) {
                   19820:                 $failed->{$key} = 1;
                   19821:             }
                   19822:         }
                   19823:     }
                   19824:     return $init;
                   19825: }
                   19826: 
1.1328    raeburn  19827: sub is_nonframeable {
1.1329    raeburn  19828:     my ($url,$absolute,$hostname,$ip,$nocache) = @_;
                   19829:     my ($remprotocol,$remhost) = ($url =~ m{^(https?)\://(([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,})}i);
1.1330    raeburn  19830:     return if (($remprotocol eq '') || ($remhost eq ''));
1.1329    raeburn  19831: 
                   19832:     $remprotocol = lc($remprotocol);
                   19833:     $remhost = lc($remhost);
                   19834:     my $remport = 80;
                   19835:     if ($remprotocol eq 'https') {
                   19836:         $remport = 443;
                   19837:     }
1.1330    raeburn  19838:     my ($result,$cached) = &Apache::lonnet::is_cached_new('noiframe',$remhost.':'.$remport);
1.1329    raeburn  19839:     if ($cached) {
                   19840:         unless ($nocache) {
                   19841:             if ($result) {
                   19842:                 return 1;
                   19843:             } else {
                   19844:                 return 0;
                   19845:             }
                   19846:         }
                   19847:     }
1.1328    raeburn  19848:     my $uselink;
                   19849:     my $request = new HTTP::Request('HEAD',$url);
                   19850:     my $response = &LONCAPA::LWPReq::makerequest('',$request,'','',5);
                   19851:     if ($response->is_success()) {
                   19852:         my $secpolicy = lc($response->header('content-security-policy'));
                   19853:         my $xframeop = lc($response->header('x-frame-options'));
                   19854:         $secpolicy =~ s/^\s+|\s+$//g;
                   19855:         $xframeop =~ s/^\s+|\s+$//g;
                   19856:         if (($secpolicy ne '') || ($xframeop ne '')) {
1.1329    raeburn  19857:             my $remotehost = $remprotocol.'://'.$remhost;
1.1328    raeburn  19858:             my ($origin,$protocol,$port);
                   19859:             if ($ENV{'SERVER_PORT'} =~/^\d+$/) {
                   19860:                 $port = $ENV{'SERVER_PORT'};
                   19861:             } else {
                   19862:                 $port = 80;
                   19863:             }
                   19864:             if ($absolute eq '') {
                   19865:                 $protocol = 'http:';
                   19866:                 if ($port == 443) {
                   19867:                     $protocol = 'https:';
                   19868:                 }
                   19869:                 $origin = $protocol.'//'.lc($hostname);
                   19870:             } else {
                   19871:                 $origin = lc($absolute);
                   19872:                 ($protocol,$hostname) = ($absolute =~ m{^(https?:)//([^/]+)$});
                   19873:             }
                   19874:             if (($secpolicy) && ($secpolicy =~ /\Qframe-ancestors\E([^;]*)(;|$)/)) {
                   19875:                 my $framepolicy = $1;
                   19876:                 $framepolicy =~ s/^\s+|\s+$//g;
                   19877:                 my @policies = split(/\s+/,$framepolicy);
                   19878:                 if (@policies) {
                   19879:                     if (grep(/^\Q'none'\E$/,@policies)) {
                   19880:                         $uselink = 1;
                   19881:                     } else {
                   19882:                         $uselink = 1;
                   19883:                         if ((grep(/^\Q*\E$/,@policies)) || (grep(/^\Q$protocol\E$/,@policies)) ||
                   19884:                                 (($origin ne '') && (grep(/^\Q$origin\E$/,@policies))) ||
                   19885:                                 (($ip ne '') && (grep(/^\Q$ip\E$/,@policies)))) {
                   19886:                             undef($uselink);
                   19887:                         }
                   19888:                         if ($uselink) {
                   19889:                             if (grep(/^\Q'self'\E$/,@policies)) {
                   19890:                                 if (($origin ne '') && ($remotehost eq $origin)) {
                   19891:                                     undef($uselink);
                   19892:                                 }
                   19893:                             }
                   19894:                         }
                   19895:                         if ($uselink) {
                   19896:                             my @possok;
                   19897:                             if ($ip ne '') {
                   19898:                                 push(@possok,$ip);
                   19899:                             }
                   19900:                             my $hoststr = '';
                   19901:                             foreach my $part (reverse(split(/\./,$hostname))) {
                   19902:                                 if ($hoststr eq '') {
                   19903:                                     $hoststr = $part;
                   19904:                                 } else {
                   19905:                                     $hoststr = "$part.$hoststr";
                   19906:                                 }
                   19907:                                 if ($hoststr eq $hostname) {
                   19908:                                     push(@possok,$hostname);
                   19909:                                 } else {
                   19910:                                     push(@possok,"*.$hoststr");
                   19911:                                 }
                   19912:                             }
                   19913:                             if (@possok) {
                   19914:                                 foreach my $poss (@possok) {
                   19915:                                     last if (!$uselink);
                   19916:                                     foreach my $policy (@policies) {
                   19917:                                         if ($policy =~ m{^(\Q$protocol\E//|)\Q$poss\E(\Q:$port\E|)$}) {
                   19918:                                             undef($uselink);
                   19919:                                             last;
                   19920:                                         }
                   19921:                                     }
                   19922:                                 }
                   19923:                             }
                   19924:                         }
                   19925:                     }
                   19926:                 }
                   19927:             } elsif ($xframeop ne '') {
                   19928:                 $uselink = 1;
                   19929:                 my @policies = split(/\s*,\s*/,$xframeop);
                   19930:                 if (@policies) {
                   19931:                     unless (grep(/^deny$/,@policies)) {
                   19932:                         if ($origin ne '') {
                   19933:                             if (grep(/^sameorigin$/,@policies)) {
                   19934:                                 if ($remotehost eq $origin) {
                   19935:                                     undef($uselink);
                   19936:                                 }
                   19937:                             }
                   19938:                             if ($uselink) {
                   19939:                                 foreach my $policy (@policies) {
                   19940:                                     if ($policy =~ /^allow-from\s*(.+)$/) {
                   19941:                                         my $allowfrom = $1;
                   19942:                                         if (($allowfrom ne '') && ($allowfrom eq $origin)) {
                   19943:                                             undef($uselink);
                   19944:                                             last;
                   19945:                                         }
                   19946:                                     }
                   19947:                                 }
                   19948:                             }
                   19949:                         }
                   19950:                     }
                   19951:                 }
                   19952:             }
                   19953:         }
                   19954:     }
1.1329    raeburn  19955:     if ($nocache) {
                   19956:         if ($cached) {
                   19957:             my $devalidate;
                   19958:             if ($uselink && !$result) {
                   19959:                 $devalidate = 1;
                   19960:             } elsif (!$uselink && $result) {
                   19961:                 $devalidate = 1;
                   19962:             }
                   19963:             if ($devalidate) {
                   19964:                 &Apache::lonnet::devalidate_cache_new('noiframe',$remhost.':'.$remport);
                   19965:             }
                   19966:         }
                   19967:     } else {
                   19968:         if ($uselink) {
                   19969:             $result = 1;
                   19970:         } else {
                   19971:             $result = 0;
                   19972:         }
                   19973:         &Apache::lonnet::do_cache_new('noiframe',$remhost.':'.$remport,$result,3600);
                   19974:     }
1.1328    raeburn  19975:     return $uselink;
                   19976: }
                   19977: 
1.1359    raeburn  19978: sub page_menu {
                   19979:     my ($menucolls,$menunum) = @_;
                   19980:     my %menu;
                   19981:     foreach my $item (split(/;/,$menucolls)) {
                   19982:         my ($num,$value) = split(/\%/,$item);
                   19983:         if ($num eq $menunum) {
                   19984:             my @entries = split(/\&/,$value);
                   19985:             foreach my $entry (@entries) {
                   19986:                 my ($name,$fields) = split(/=/,$entry);
1.1368    raeburn  19987:                 if (($name eq 'top') || ($name eq 'inline') || ($name eq 'foot') || ($name eq 'main')) {
1.1359    raeburn  19988:                     $menu{$name} = $fields;
                   19989:                 } else {
                   19990:                     my @shown;
                   19991:                     if ($fields =~ /,/) {
                   19992:                         @shown = split(/,/,$fields);
                   19993:                     } else {
                   19994:                         @shown = ($fields);
                   19995:                     }
                   19996:                     if (@shown) {
                   19997:                         foreach my $field (@shown) {
                   19998:                             next if ($field eq '');
                   19999:                             $menu{$field} = 1;
                   20000:                         }
                   20001:                     }
                   20002:                 }
                   20003:             }
                   20004:         }
                   20005:     }
                   20006:     return %menu;
                   20007: }
                   20008: 
1.112     bowersj2 20009: 1;
                   20010: __END__;
1.41      ng       20011: 

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